FAQ

Answers to common questions about using and developing this library. Add project-specific entries as they come up in issues.

See also: Usage · Examples · Contributing.

---

How do I install it?

pip install <project_name>

Replace with the real distribution name and any extras (e.g. pip install "<project_name>[web]").

How do I add or update a dependency?

Use Poetry so the lock file stays authoritative:

poetry add <package>          # runtime dependency
poetry add --group dev <package>   # dev-only tool

Every package the code imports must be a direct dependency — never rely on it arriving transitively through another package.

Which Python versions are supported?

See the python = "..." constraint in pyproject.toml; CI runs the test matrix against each.

How is the version determined?

The version is the git tag (via poetry-dynamic-versioning); pyproject.toml holds a 0.0.0 placeholder. Cut a release from the release workflow — see Contributing.