Development¶

The module is setup for development using hatch.

Run tests¶

Tests can be run with pytest:

hatch run test

Test coverage¶

Run tests then report on coverage

hatch run cov

Run tests then run a server showing where coverage is missing

hatch run cov-html

Run typing checks¶

hatch run lint:typing

Linting¶

Ruff should be run before committing any changes.

To check for any changes needed:

hatch run lint:style

To run any autoformatting possible:

hatch run lint:fmt

Run all checks at once¶

hatch run lint:all

Publish to pypi¶

hatch build
hatch publish
git tag v<VERSION_NUMBER>
git push origin v<VERSION_NUMBER>