Development Notes

• Dependency management is handled with Poetry.
• The code is tested with pytest as a pre-commit hook.
• Before commit, I generally run isort and interrogate to ensure consistent imports and docstrings, but these are not currently implemented as pre-commit hooks.
• Docstrings are given an fully as possible in Google style, with as much type hinting as possible. Docstrings are used by mkdocs to auto-generate the documentation through the magic of mkdocstrings.
• A number of test scripts have been implemented, and they are used by the continuous integration process. However, the scripts are incomplete and intended primarily for quick testing from the command line. A fuller test suite is intended once the API is more complete.

More information for developers will be added soon. In the meantime, see the GitHub Wiki for information on getting started.