πŸ€“ Maintainers

This document is intended for maintainers of the scivision project and includes the following how-tos:

  1. 🐍 Python package releases

  2. πŸ““ Build scivision documentation

If you are new to the scivision project and wish to become a maintainer for either the PyPI release or the readthedocs documentation, send an email to scivision@turing.ac.uk

🐍 Python package releases

A new release of the scivision package will be uploaded to PyPI each time a tagged commit is pushed to the main branch of the scivision GitHub repo. In order to trigger this automated process, do the following:

  1. On a new branch of the scivision repo, containing your changes to be included in the release, increment the version in setup.py and any other metadata that differs for the new release.

  2. Create a pull request and merge to the main branch.

  3. At the main repo page on GitHub, click the following Releases -> Draft a new release. Click Choose a tag and create a new tag named as the version number. Fill in the descriptive fields and publish the release. After a few moments, the new version should show up at https://pypi.org/project/scivision/

Alternatively, developers of scivision with maintainer access to alan-turing-institute/scivision & https://pypi.org/project/scivision can manually release a new version of the package with the following steps:

  1. On a new branch of the scivision repo, containing your changes to be included in the release, increment the version in setup.py and any other metadata that differs for the new release.

  2. Make sure you have a working python 3 installation. Check your version with:

    python --version

  3. Install these packages if you don’t have them:

    pip install build twine

  4. Build the release:

    python -m build

  5. Upload the release, substituting <version> with the new version number:

    python -m twine upload dist/<version>*

    • Note: You’ll need to provide your PyPI username and password

  6. Commit changes to setup.py and pull request to the main branch of alan-turing-institute/scivision

πŸ““ Build scivision documentation

Maintainers of this readthedocs site can build and view the docs by doing the following:

  1. Make sure you have a working python 3 installation. Check your version with:

    python --version

  2. Clone alan-turing-institute/scivision and install requirements:

    pip install -r docs/requirements.txt

  3. Build the docs:

    • In the top dir of the repo:

    sphinx-build -b html docs/ build/

    • The HTML will be created in build/

  4. Update the API documentation:

    • Edit (or add) to the docstring of the function in question

    • Ensure that the module containing that function has been added to docs/api.rst

    • Open build/index.html in a browser to view edits

  5. Push the updates to the readthedocs site: