spiralstrip 2.0.0__tar.gz

spiralstrip-2.0.0/BUILDING.md

@@ -0,0 +1,49 @@
+# Build and publish the Spiral Strip Python package
+
+The distribution name and import name are `spiralstrip`. The package version is `2.0.0`, corresponding to the GitHub release tag `v2.0`. Run the build commands from the directory containing `pyproject.toml`.
+
+## Build
+
+Create a separate build environment on Linux:
+
+```sh
+python -m venv ../spiralstrip-pip-build
+source ../spiralstrip-pip-build/bin/activate
+python -m pip install --upgrade pip build twine
+python -m build
+python -m twine check dist/*
+```
+
+On Windows, activate the environment with `..\spiralstrip-pip-build\Scripts\Activate.ps1` instead of the `source` command.
+
+The build creates `dist/spiralstrip-2.0.0-py3-none-any.whl` and `dist/spiralstrip-2.0.0.tar.gz`. The wheel installs the library and its package metadata, including the license. The source distribution also includes the example scripts and build instructions. NumPy and Matplotlib are declared as dependencies; tests and the Conda recipe are excluded.
+
+## Check installation
+
+Create a clean environment and install the wheel using its absolute path:
+
+```sh
+python -m venv ../spiralstrip-pip-check
+source ../spiralstrip-pip-check/bin/activate
+python -m pip install --upgrade pip
+python -m pip install /absolute/path/to/dist/spiralstrip-2.0.0-py3-none-any.whl
+python -m pip check
+cd /tmp
+python -c "import spiralstrip; print(spiralstrip.__file__)"
+```
+
+Use a directory outside the source folder for the import check so a local `spiralstrip.py` cannot hide installation problems. Repeat the installation check in another clean environment using `spiralstrip-2.0.0.tar.gz` instead of the wheel. The printed module path should be inside that environment's `site-packages` directory.
+
+Displaying figures requires a graphical environment. Saving figures on a server can use Matplotlib's Agg backend and `show=False`.
+
+## Publish
+
+After verifying both distributions, activate the build environment, return to the directory containing `pyproject.toml`, and upload the two files:
+
+```sh
+python -m twine upload dist/spiralstrip-2.0.0-py3-none-any.whl dist/spiralstrip-2.0.0.tar.gz
+```
+
+Publication requires a PyPI account, an available project name, and an API token. This command publishes the release publicly; building does not publish anything. PyPI does not allow an uploaded filename to be reused, so complete validation before uploading.
+
+For later releases, change the version in `pyproject.toml` and build into a clean `dist` directory. The source distribution published on PyPI can also serve as the source archive for a conda-forge recipe.