{{PROJECT_NAME}}

📋 Template : voir TEMPLATE.md pour les instructions d'utilisation.

{{PROJECT_DESCRIPTION}}

Installation

Prérequis : uv — installateur standalone, gère aussi Python :

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Stack

Outil	Rôle
uv	Gestionnaire de dépendances (remplace pip)
ruff	Linter + formatter (remplace flake8/black/isort)
pytest	Tests
pre-commit	Hooks Git automatiques
GitHub Actions	CI/CD (désactivé par défaut)

Setup

uv sync --group dev # crée .venv + installe Python 3.13 si absent
.venv\Scripts\activate # Windows (Linux/Mac : source .venv/bin/activate)
uv run pre-commit install # hooks run automatically on git commit
cp .env.example .env # Puis renseigner les valeurs

Structure

├── scripts/ # CLI / production scripts
├── src/ # Source code
├── notebooks/ # Exploration & analysis
├── data/
│ ├── raw/ # Raw data (not versioned)
│ └── processed/ # Processed data (not versioned)
├── tests/ # Tests
└── docs/ # Documentation

Usage

# Run tests
pytest
# Lint & format
uv run ruff check . --fix
uv run ruff format .