All the contributions are welcome! Please open an issue or send us a pull request.
Executing the tests:
$ uv venv
$ uv pip install -r requirements.txt
$ uv pip install -e .
$ uv ruff check .
$ uv format .
$ uv run pytest
or with tox installed:
$ tox
Use of pre-commit is recommended:
$ uv run precommit install
Documentation is published with mkdocs:
$ uv pip install -r requirements-docs.txt
$ uv pip install -e .
$ uv run mkdocs serveOpen http://127.0.0.1:8000/ to view the documentation locally.