Contributing to the code base#


Developing requires:

  • the Rye package manager;

  • the pre-commit git hook manager, typically installed with pipx.

Setting up a development environment#

Clone the repository:

git clone

Enter the created repository and set up the development environment:

cd pinttrs
rye sync

Finally, activate the pre-commit hooks:

pre-commit install

Running tests#

The testing process of Pinttrs uses pytest. A Make target is defined to help you run the tests:

make test

This will run pytest for all relevant files (unit tests and doctests included in the documentation).

Building the documentation#

To build the documentation, use the dedicated Make target:

make docs

Incremental autobuild is also supported:

make docs-serve


Not planned yet

  • Allow automatic string interpretation using the built-in registry (this feature should have a switch based on a user setting).