Template Instructions

To onboard a new project using this template, follow this exact 3-step process:

1. Click "Use this template".
2. Clone locally.
3. Run bash setup.sh.

---

python-template

A new Python project.

Post-Setup

Documentation is published with mike, which commits the built site to a gh-pages branch:

1. Push to main once and let the deploy-docs job create the gh-pages branch.
2. Settings → Pages → source Deploy from a branch → gh-pages → / (root). Not "GitHub Actions" — that source is for artifact-based deploys, which this is not.
3. Settings → Actions → General → Workflow permissions → Read and write permissions, so the deploy job can push the branch.

Application Usage

The package exposes a CLI tool python-template with sample commands.

Development

This project uses a src layout and strict type checking. just is the task surface; run just with no arguments to list every recipe. CI invokes the same recipes, so a green just check locally means a green CI.

Task	Command
Install	just bootstrap
Test	just test
Lint, format & type check	just lint
Auto-fix	just fmt
Docs (serve)	just docs
Test doc examples	just docs-test
Regenerate generated pages	just docs-index
Run all checks	just check

Pre-commit Hooks

Enforce quality standards locally before committing:

just pre-commit

Architecture decisions

Significant decisions are recorded in docs/adr/. Read them before proposing changes to structure, tooling, dependencies, or public API. Agents should start at AGENTS.md. Create a new record with just adr short-kebab-title.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Author: Noé Fontana ([email protected]) GitHub: NoeFontana