developer_notes.md

Developer notes

Packaging for PyPI was done following the official instructions as well as this guide on minimal package requirements.

The conda-forge recipe was created following the offical instructions.

The documentation was created using Sphinx and ReadTheDocs, following these instructions.

To re-build and submit a new version to PyPI and conda-forge:

0. Create a test environment to work in:

$ conda create -n test pip twine
$ conda activate test

1. Increment the version number in setup.py
2. Install the package and each the everything works correctly:

$ pip install -e .

3. Create the source distribution and wheels:

$ python setup.py sdist bdist_wheel

4. Remove the old versions from dist/
5. Upload to TestPyPI to check that everything looks fine

$ twine upload --repository testpypi dist/*`

5. Upload to PyPI

$ twine upload dist/*`

6. Fork the conda feedstock repo, make necessary changes to recipe/meta.yaml and then submit a PR.