Release

Instructions

1. Ensure the version string in setup.py is up to date. See PEP 440 for version string formatting.

2. Ensure that the version string in setup.cfg matches. This line ensures that online documentation points to the correct package version. Updating these values will overwrite their assignment in doc/conf.py.

3. Ensure that the copyright and authors are updated in doc/conf.py. Note that you can test the build with python setup.py build_sphinx --build-dir doc/_build.

4. Ensure that requirements.txt is updated. readthedocs is configured to use this as the requirements file (this needs to be set in the advanced settings of readthedocs).

5. Ensure that the web hook for readthedocs is configured to activate on release events.

6. Draft a new release. If VERSION is the setup.py version string, then:

   • the "Tag version" should be vVERSION
   • the "Release title" should be VERSION

   Briefly describe the release. Note any new features or backward incompatible changes. It's nice to cite the efforts of community contributors here, too.

7. Click "Publish release".

Post-release

PyPI

1. Update the PyPI cytominer-database package to new release version by following these steps but with one exception.
   • Run python setup.py sdist bdist_wheel build_sphinx --build-dir doc/_build
2. When installing the package from test.pypi.org use pip install cytominer-database==<VERSION> --extra-index-url=https://test.pypi.org/simple/. The instructions on Test PyPi to install are wrong.
3. Ensure the package is on PyPI.

Conda-Forge

We also support conda package management on conda-forge.

1. The cytominer-database conda package is maintained on an auto-generated feedstock.
2. To update the cytominer-database feedstock for a new release version, follow the steps outlined in the conda-forge community guidelines.

Read The Docs

Our documentation is built automatically using sphinx.

1. Ensure the documentation is updated, you may need an administrator to activate the built version.