From ac728acefdbc5ff8d938d6139a6f4fe0fe516320 Mon Sep 17 00:00:00 2001 From: sme Date: Thu, 21 Dec 2023 16:13:02 +0100 Subject: [PATCH] Rebranding (2) (#2) Prepare for initial release --- .gitignore | 2 ++ Makefile | 31 ++++++++++++++++++++++++++++++- README.md | 2 +- docs/source/changelog.md | 4 +++- pyproject.toml | 4 ++++ src/hapsira/__init__.py | 2 +- 6 files changed, 41 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 0f665555d..21307c84b 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,8 @@ .ipynb_checkpoints */.ipynb_checkpoints/* +.virtual_documents +*/.virtual_documents/* # IPython profile_default/ diff --git a/Makefile b/Makefile index 56f66fad4..4af5fb230 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,24 @@ DOCKER_BASE_IMAGE := "hapsira:dev" DOCKER_CONTAINER_NAME := "hapsira-dev" +_clean_coverage: + coverage erase + +_clean_py: + find src/ tests/ contrib/ -name '*.pyc' -exec rm -f {} + + find src/ tests/ contrib/ -name '*.pyo' -exec rm -f {} + + find src/ tests/ contrib/ -name '*~' -exec rm -f {} + + find src/ tests/ contrib/ -name '__pycache__' -exec rm -fr {} + + +_clean_release: + -rm -r build/* + -rm -r dist/* + +clean: + make _clean_release + make _clean_coverage + make _clean_py + docs: tox -e docs @@ -19,4 +37,15 @@ docker: ${DOCKER_BASE_IMAGE} \ bash -.PHONY: docs docker image +release: + make clean + flit build + gpg --detach-sign -a dist/hapsira*.whl + gpg --detach-sign -a dist/hapsira*.tar.gz + +upload: + for filename in $$(ls dist/*.tar.gz dist/*.whl) ; do \ + twine upload $$filename $$filename.asc ; \ + done + +.PHONY: docs docker image release upload diff --git a/README.md b/README.md index 5b04698a4..1f6d8cd53 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ For other installation methods, see the [alternative installation methods](https ## Migrating from `poliastro` to `hapsira` -Currently, both packages are near-identical and should therefore be fully compatible. Potentially breaking changes will be added here and in the documentation. +`hapsira` is based on `poliastro main` as of the date of its archival, October 14 2023, [commit 1b01768c](https://github.com/poliastro/poliastro/commit/21fd7719e89a7d22b4eac63141a60a7f1b01768c). Therefore, `hapsira`'s initial release already includes a number of changes made since `poliastro`'s last release, `0.17.0`. Most notably, the plotter framework saw a redesign and is backwards incompatible, see [poliastro #1545](https://github.com/poliastro/poliastro/pull/1545). For further details, see [changelog](https://github.com/pleiszenburg/hapsira/blob/main/docs/source/changelog.md). ## Documentation diff --git a/docs/source/changelog.md b/docs/source/changelog.md index 96ad62437..2e716bb51 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -1,6 +1,8 @@ # What's new -## hapsira 0.18.0 - 2023-12-XX +## hapsira 0.18.0 - 2023-12-21 + +**CAUTION**: A number changes at least partially **BREAK BACKWARDS COMPATIBILITY** for certain use cases. This release is a rebranded, but virtually identical fork of `poliastro`, `main` branch, as of the date of it being archived, October 14 2023. All noteworthy changes listed here were merged into `poliastro` after its last official release, `0.17.0`. diff --git a/pyproject.toml b/pyproject.toml index 0417fb060..dbf07002f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -69,6 +69,10 @@ Changelog = "https://hapsira.readthedocs.io/en/stable/changelog.html" [project.optional-dependencies] jupyter = ["notebook", "ipywidgets>=7.6"] cesium = ["czml3 ~=0.5.3"] +dev = [ + "flit", + "wheel", +] doc = [ "httpx", "ipython", # >=5.0", diff --git a/src/hapsira/__init__.py b/src/hapsira/__init__.py index 7161b0d1e..4c7039166 100644 --- a/src/hapsira/__init__.py +++ b/src/hapsira/__init__.py @@ -1,3 +1,3 @@ """Utilities and Python wrappers for Orbital Mechanics.""" -__version__ = "0.18.dev0" +__version__ = "0.18.0"