Rebranding (2) (#2)

Prepare for initial release

Author: s-m-e

.gitignore

@@ -8,6 +8,8 @@
 
 .ipynb_checkpoints
 */.ipynb_checkpoints/*
+.virtual_documents
+*/.virtual_documents/*
 
 # IPython
 profile_default/

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

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

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`.
 

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",

src/hapsira/__init__.py

@@ -1,3 +1,3 @@
 """Utilities and Python wrappers for Orbital Mechanics."""
 
-__version__ = "0.18.dev0"
+__version__ = "0.18.0"