Development¶

We use pdm to manage the dependencies and MkDocs to build the documentation.

Pre Commit¶

It is recommended to use pre-commit to ensure that the code is formatted and linted before committing.

Install pre-commit
```
pip install pre-commit
```
Install the git hooks
```
pre-commit install
```
Run the pre-commit checks (should automatically run when you try to commit, you can also run it manually)
```
pre-commit run
```

To generate coverage report, run the following command:

coverage run -m pytest
coverage html