Documentation is hosted on ReadTheDocs.
This project has a dev container. If you already have VS Code and Docker installed, you can click the badge above or here to get started. Clicking these links will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
The Release workflow reuses the checks from CI instead of re-running them: it requires that the CI workflow has already completed successfully for the current commit (including the workflow-summary job) and reuses the artifacts CI built rather than rebuilding. Trigger it manually with workflow_dispatch; a real release must be run from main, while the dry_run option lets you exercise the workflow from any branch without tagging or releasing. A real run pushes the v<version> git tag and creates a GitHub Release, attaching the executable that CI built for every OS and Python version.
This repository uses a copier template. To pull in the latest updates from the template, use the command:
copier update --answers-file .config/.copier-answers.yml --trust --conflict rej --defaults