https://github.com/innolitics/python_project_template
Python project template using copier. Includes linters, formatters, pre-commit hooks and github actions.
https://github.com/innolitics/python_project_template
Last synced: 6 days ago
JSON representation
Python project template using copier. Includes linters, formatters, pre-commit hooks and github actions.
- Host: GitHub
- URL: https://github.com/innolitics/python_project_template
- Owner: innolitics
- Created: 2023-09-15T22:21:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T16:13:15.000Z (over 2 years ago)
- Last Synced: 2025-08-13T20:00:17.757Z (10 months ago)
- Language: Jinja
- Size: 16.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Python Project Template
This repository holds a template for a Python project. Use it to kick start
your own.
It includes:
- Formatters
- black
- isort
- Linters
- ruff
- Type checkers
- mypy
- pre-commit adds hooks for:
- check-yaml
- check-case-conflict
- debug-statements
- detect-private-key
- check-added-large-files
- end-of-file-fixer
- trailing-whitespace
- ruff
- black
- isort
- prettier (yaml)
- pip-tools (sync `requirements.in` with `requirements.txt`)
- pyright
- github actions
- dependabot (security updates)
- ruff
- black
- pytest
- mypy
## Usage
1. Install copier and copy the template repo:
```bash
pip install copier
copier copy . /path/to/your/new-project
```
2. Initialize a git repository in the new project folder and add all files
introduced by `copier`:
```bash
cd /path/to/your/new-project
git init -b main
git add -A
```
3. Read `new-project/CONTRIBUTING.md` to create the development
environment for the new project.
4. Create your first commit (this should run pre-commit hooks):
```bash
git commit -m "Initial commit"
```