Welcome to the Python Template documentation. This is a modern Python project template with comprehensive tooling and best practices built-in.
git clone https://github.com/username/python-template.gitcurl -LsSf https://astral.sh/uv/install.sh | shuv pip install -r pyproject.tomlmake testPre-configured with uv, ruff, pytest, and pydantic for a modern Python development experience.
Follows Python best practices with comprehensive coding standards and project structure.
This documentation is hosted on GitHub Pages. Enable it in your repository settings!
Includes CLAUDE.md and llms/ directory with documentation optimized for AI assistants.
./
├── docs/ # Documentation (GitHub Pages)
├── src/ # Application code
├── tests/ # Test files
├── logs/ # Implementation logs
├── llms/ # LLM-friendly documentation
├── Makefile # Task automation
├── pyproject.toml # Project configuration
├── Python.md # Coding standards
└── CLAUDE.md # AI instructions
make dev # Run linting and type checking
make test # Run tests
make test-coverage # Run tests with coverage
make type-coverage # Check type annotation coverage
The llms/ directory contains comprehensive documentation for common Python tools and libraries:
The project uses pyproject.toml for all tool configuration. Key sections include:
Contributions are welcome! Please read the coding standards in Python.md before submitting pull requests.