Development¶
Set up¶
Clone the repository, then install the complete development environment:
make setup
Validate¶
Run the full suite before submitting changes:
make check
Useful focused commands include:
| Command | Purpose |
|---|---|
make format |
Apply Ruff fixes and formatting. |
make lint |
Check Ruff lint and formatting rules. |
make typecheck |
Run Basedpyright. |
make test |
Run Pytest. |
make docs |
Build documentation strictly. |
make docs-linkcheck |
Build documentation and crawl its links. |
make serve-docs |
Preview documentation with live reload. |
Project layout¶
| Path | Responsibility |
|---|---|
src/python_project_foundry/ |
Published CLI, template updates, and GitHub publishing code |
copier.yaml and copier/ |
Questionnaire and Copier lifecycle configuration |
template/ |
Generated repository content |
tests/ |
CLI, publishing, and rendered-template tests |
docs/ |
This documentation site |
For questionnaire or generated-file changes, follow Template development.
See the repository's contribution guide for contribution expectations.