How-to Guides

Practical step-by-step guides for the more experienced user.

• Setup the repository with recommended settings
• Setup Developer Environment
• Build the docs using sphinx
• Check docs for style
• Contribute to the template
• How to check code coverage
• How to embed Excalidraw diagrams
• Run linting using pre-commit
• Lock requirements
• Make a release
• Setting up PyPI publishing
• How to add images to the README
• Use renovate to keep dependencies up to date
• Run the tests using pytest
• Run static analysis using pyright or mypy
• Use Pyright’s Strict Mode
• How to update to the latest template structure