development.md

Development Instructions

Ideally, pre-commit should be installed along with:

• ruff (installation instructions)
• mypy (installation instructions)
• poetry (installation instructions)
• `pipx' (installation instructions)
• cargo-edit (cargo install cargo-edit)

Install all (main+dev) dependencies:

poetry install --no-root

Mypy:

poetry run mypy .

Install pre-commit hooks:

poetry run pre-commit install

Run pre-commit hooks manually:

poetry run pre-commit run --all-files

Update pre-commit hooks:

poetry run pre-commit autoupdate

Extra checks

ruff check --fix --extend-select="F,I,UP" --line-length=120

Generating a requirements.txt file

poetry self add poetry-plugin-export
poetry export -f requirements.txt --output requirements.txt