Running the Tests¶
Tests are executed through tox.
Tests are written with pytest. Please add unit tests under the tests/ directory to cover any new functionality you have added.
Code is formatted using black.
You can check your formatting using black’s check mode:
tox -e formatting
You can also use pre-commit to format every commit with black:
pip install pre-commit pre-commit install
You can build the documentation through tox.
tox -e docs
The built documentation will be output to doc/build
Before releasing please remember to:
- Run the tests and check that they pass
- Build the new documentation and check it
- Update version in
- Add new release notes to
- Commit, tag the version number, and push the changes
git clean -idx python setup.py sdist bdist_wheel twine upload dist/*