Contribution Guidelines

All types of contributions are welcome: suggestions, ideas, commits with new features, bug fixes, refactoring, docs, tests, translations, etc…

If you have any questions:

Development Setup

To set up the development environment, you can run:

# Install uv
$ pip install uv
# Run the noxfile.py script
$ uv run noxfile.py -s dev

By default, this will create a virtual environment with Python 3.8 and install all the required dependencies. If you need to setup the development environment with a specific Python version, you can run:

$ uv run noxfile.py -s dev -P 3.10

Running Tests

To run the tests and linters, you can use the following command:

$ uv run noxfile.py

For futher details, refer to the noxfile.py script.

Building Documentation

The documentation on ReadtheDocs is manually built from the master branch. To build the documentation locally, you can run:

$ uv tool install sphinx --with-editable . --with-requirements requirements-doctest.txt
$ cd docs
$ make html

For futher details, refer to the docs/Makefile.