Python Template
A modern Python package template that helps you quickly bootstrap new Python projects with best practices and common tools already set up.
Built with Copier, this template provides a standardized foundation for your Python projects.
Why Use This Template ?
Starting a new Python project involves many repetitive setup tasks. This template helps you:
- Save time by avoiding manual project setup
- Ensure consistency across your projects
- Follow Python best practices from the start
- Focus on writing code instead of configuration
Features
- Poetry - Modern dependency management and packaging
- Task - A task runner to simplify common operations
- MkDocs - Documentation generation with Markdown
- Linters:
- Ruff - An extremely fast Python linter and code formatter
- yamllint - YAML files linter
- commitizen - Commit message checker and changelog generator
- Tests:
- pytest - Powerful and flexible testing framework
- And many more...
Prerequisites
- Python 3.9 or higher
- A Git repository
- Task (not mandatory but recommended)
Example Project
You can see what a project looks like once generated with this template in the following example.
This repository serves as a reference for the output of the template generation and is also used to test updates and improvements.