Project Management¶

Package and Dependency Management¶

We use pdm to manage the package and the dependencies.

Pre-commit Hooks¶

We use pre-commit to enforce code quality and consistency. The pre-commit hooks are defined in the .pre-commit-config.yaml file.

The following pre-commit hooks are enabled in this project.

Code Linting and Formatting¶

We use Ruff for code linting and formatting. The format is based on Black.

The docstrings in the source code are written in the Google Style Python Docstrings format. pydocstyle rules for checking the docstrings are included in ruff.

ruff check src
ruff format src

Code Type Checking¶

We use mypy for static type checking.

mypy src