An opinionated, production-ready Apache 2.0 template repository for bootstrapping modern software projects.
Documentation | Roadmap | Issues | Discussions
Welcome to the template-python template repository! This template provides a robust foundation for building high-quality, scalable software projects. It includes standard directories, issue templates, CI/CD workflows, and comprehensive placeholder documentation.
To use this template, run the included scripts/bootstrap.sh script to automatically replace all placeholder variables with your project details. For full setup instructions including GitHub settings, publishing, and docs, see the Repository Setup Guide.
- Consistency: Enforces a standardized layout and structure across your organization's repositories.
- Speed: Bootstraps your project with pre-configured Actions, badges, and templates so you don't start from scratch.
- Best Practices: Baked-in guides for contributing, security, and developer setup.
When evaluating template-python against other templates, consider the following differences:
| Feature | template-python Template | Standard GitHub Init | Cookiecutter / Copier |
|---|---|---|---|
| Setup Speed | Very Fast | Fast | Slower (requires CLI tool) |
| Visual Assets | Pre-configured Light/Dark assets | None | Varies |
| CI/CD Built-in | Yes (GitHub Actions) | No | Optional |
| Complexity | Low (scripts/bootstrap.sh) |
None | Medium (Jinja templates) |
Welcome to the template-python Launch!
This project has just been instantiated from the template repository. Keep an eye on this section for future release highlights, new features, and community announcements!
pip install template-pythonFor full installation options (from source, Docker, platform-specific notes) and step-by-step onboarding, see the Getting Started guide.
This project is built using modern Python tooling, enforcing strict code quality standards with Ruff and Mypy, and providing a robust Pydantic-driven settings architecture for configuration resolution.
The repository is structured to separate documentation, application logic, and testing cleanly:
src/template_python/: The primary application source code.tests/: Comprehensive test suite ensuring reliability, organized intounit/,integration/, ande2e/.docs/: Source code for the MkDocs Material documentation site, including step-by-step guides, references, and getting started tutorials.examples/: Runnable reference projects demonstrating real-world configurations..github/workflows/: Advanced CI/CD pipelines governing the project lifecycle, built around reusable workflow templates.
Please check the examples/ directory for advanced examples and configurations.
We welcome contributions! Please see our Contributing Guide for more details. For development setup, check out DEVELOPING.md. Please ensure you follow our Code of Conduct in all interactions.
- For help and general questions, see SUPPORT.md.
- To report a security vulnerability, please refer to our Security Policy.
This repository includes first-class support for agentic and LLM-assisted development workflows:
- AGENTS.md: Repository-specific instructions for AI coding agents (Codex, Copilot Workspace, Gemini, Claude, Cursor, and similar tools). Contains the authoritative guide for project structure, executable commands, code style, and critical constraints.
- llms.txt: A machine-readable index of the project's documentation, following the llms.txt specification. Served at
/llms.txton the documentation site to help LLMs quickly locate and consume relevant content.
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
If you use this template or the resulting software in your research, please cite it using the following BibTeX entry:
@software{template-python,
author = {markurtz},
title = {template-python},
version = {{{version}}},
month = {{{month}}},
year = {2026},
url = {https://github.com/markurtz/template-python}
}