If you want to improve the code base, add a feature or update the documentation please open a pull request. Feel free to open an issue beforehand to discuss your plans.
This project uses Tox to run its test suite. Install it using Pip like this:
python3 -m pip install toxAlternatively, if you use uv, install Tox as a development tool like this:
uv tool install tox --with tox-uvUsage:
tox list # list available environments
tox -e py # run tests with local default Python
tox -e lint,format # run a few environments
tox # run entire suiteBuild the documentation locally and view it in your Web browser:
$ tox -e clean,docs
...
$ cd docs/_build/html/
$ python -m http.server
Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...Click on the displayed link to inspect the generated documentation.