Development

Running the unit tests

tox is used to run the unit tests:

tox

Releasing a new version

Below are the different steps to follow before releasing a new version:

• Run all tests and be sure they all pass.

• Update the version field in setup.cfg.

• Update the requirements in setup.cfg if needed.

• Update the package’s metadata (description, classifiers, etc.) in setup.cfg if needed.

• Update README.rst if needed.

• Update the documentation if needed and make sure it compiles well (cd ./docs && make html).

• Update the copyright year in docs/conf.py if needed.

• Add the corresponding release note to CHANGELOG.md.

After having pushed the new release:

• Create the corresponding release note on GitHub.