This repository's tests and development automation tasks are organized using tox, a command-line CI frontend for Python projects. tox is typically used during local development and is also invoked from this repository's GitHub Actions workflows.
tox can be installed by running pip install tox.
tox is organized around various "environments," each of which is described below. To run all test environments, run tox without any arguments:
$ toxEnvironments for this repository are configured in tox.ini as described below.
The lint environment ensures that the code meets basic coding standards, including
- Black formatting style
- mypy type annotation checker, as configured by
mypy.ini - pylint, as configured by
.pylintrc
The Black and mypy passes are applied also to Jupyter notebooks (via nbqa).
To run:
$ tox -elintIf the Black check fails, the Black environment can be invoked to easily reformat all files as necessary.
The command tox -eblack will reformat all files in the repository according to Black style.
The py## environments are the main test environments. tox defines one for each version of Python. For instance, the following command will run the tests on Python 3.9 and Python 3.10:
$ tox -epy311First, these environments execute all tests using pytest, which supports its own simple style of tests, in addition to unittest-style tests and doctests located throughout the project's docstrings.
Second, these environments invoke treon to ensure that all Jupyter notebooks in the docs/ directory execute successfully.
The coverage environment uses Coverage.py to ensure that the fraction of code tested by pytest is above some threshold (80% at the time of writing).
To run:
$ tox -ecoverage