PyFoundry Template¶

Un template Cookiecutter pour démarrer rapidement des projets de Data Science en Python.

🚀 Démarrage rapide¶

Pour créer un projet "from scratch" s'appuyant sur le template PyFoundry

(pour plus de détails ou pour des cas avancés, aller voir la doc utilisateur)

Créer le repo local

# se placer à la racine d'emplacement des projets (e.g. ~/git)
cruft create https://github.com/castorfou/PyFoundry.git

le pré-requis est d'avoir cruft installé dans l'environnement python actif

Ouvrir le projet

code <mon-nouveau-projet> # (1)
# → VS Code invite à "Reopen in Container"

les pré-requis sont d'avoir vscode, l'extension devcontainer, docker et le package tzdata

Lier à github

gh repo create $PROJECT_SLUG --public
git push -u origin main

Mettre à jour (facultatif)

pour intégrer les dernieres fonctions de PyFoundry

cruft update

Environnement reproductible : Devcontainer VS Code avec uv & pyproject.toml, extensions vscode, zsh et ses plugins
Qualité de code : Ruff + MyPy + Pre-commit hooks pré-configurés (secret, size, clean notebooks)
Intégration Github complète : gh-cli, Github Actions CI/CD
Structure prédéfinie : Organisation standardisée pour projets Data Science
Documentation moderne : Avec MkDocs Material, config mermaid, TOC repliable, push possible depuis branches, github pages
Mise à jour facile : Template évolutif avec cruft
Prise en compte du GPU : config
Docker in docker : config
Claude code local llm : lancement
Excalidraw : pour dessiner des schémas
Thème vscode Catpuccin