kickstart-python-project is a Copier template to generate the file and directory structure for a Python project, according to Libranet coding conventions.
- Modern Python tooling: uv for package management, just for task running
- CLI support with cyclopts (optional)
- Pre-configured linting: ruff, mypy, pylint
- Testing with pytest and coverage reporting
- GitHub Actions / GitLab CI workflows
- Pre-commit hooks
- Multiple license options: MIT, Apache-2.0, GPL-3.0
- Optional framework support: Django, Flask, FastAPI
- ReadTheDocs integration (optional)
- Template updates: update existing projects when the template evolves
Install Copier with the template's Jinja extension:
uv tool install copier --with jinja2-timeThe destination directory is the project root. Generation installs all dependency groups and initializes a Git repository.
Use --skip-tasks to render files without installing dependencies or
initializing Git. Only use --trust with a template
you have reviewed; this template uses a Jinja extension and post-generation
commands.
copier copy --trust gh:libranet/kickstart-python-project my-new-projectOr from a local clone:
copier copy --trust /path/to/kickstart-python-project my-new-projectWhen the template evolves, update your project:
cd my-existing-project
copier update --trust| Option | Description | Default |
|---|---|---|
project_name |
Project name (dashed) | required |
package_name |
Python package name | derived from project_name |
description |
Project description | required |
author |
Author name | required |
email |
Author email | required |
git_platform |
GitHub or GitLab | github |
license |
MIT, Apache-2.0, GPL-3.0 | MIT |
minimum_python |
Minimum Python version | 3.14 |
with_cyclopts |
Include CLI support | true |
with_django |
Include Django | false |
with_fastapi |
Include FastAPI | false |
support_rtd |
ReadTheDocs config | false |
with_renovate_python |
Renovate also updates Python deps (GitHub only) | false |