README.md

PythonTemplate

Python project template.

Installation

Create a venv (optional but recommended):

python -m venv venv
# Linux
source venv/bin/activate
# Windows
venv/Scripts/Activate.ps1 on Windows

Install package:

# User installation
pip install .
# Developer editable installation
pip install -e .[dev]

Run tests

pytest .

Run formatter

ruff format .

Run linter

ruff check .
mypy .