Installation et Configuration¶

Pré-requis¶

Obligatoire¶

Python 3.11+
Cruft - Pour créer des projets depuis le template
VS Code + Docker
Extension Dev Containers

Installation des outils¶

Installer Cruft (requis)¶

Cruft est obligatoire pour utiliser le template PyFoundry. Choisissez une méthode d'installation :

Option 1 : Installation globale avec pip¶

pip install cruft

Option 2 : Environnement conda/mamba dédié (recommandé)¶

# Créer un environnement pour les outils de templating
mamba create -y -n pyfoundry -c conda-forge python=3.11

# Activer l'environnement
mamba activate pyfoundry

# Installer cruft et tout ce dont on a besoin pour developper/documenter PyFoundry
mamba install cruft --yes
pip install -e ".[all]"

# Vérification de l'installation
cruft --help

Installation obligatoire

Cruft doit être installé et accessible avant de pouvoir utiliser le template. Vérifiez avec cruft --help.

Vérification rapide¶

# Vérifier que cruft est installé
cruft --help

# Vérifier que Python est accessible
python --version
# Devrait afficher : Python 3.11.X ou plus récent

Créer un nouveau projet¶

Méthode interactive¶

cruft create https://github.com/username/PyFoundry.git

Vous serez invité à renseigner : - project_name : Nom affiché du projet (ex: "Analyse des Ventes") - project_slug : Nom technique (généré automatiquement) - description : Description courte du projet - python_version : Version Python (défaut: 3.11) - use_node : Installer Node.js/npm pour des outils web (défaut: n)

Méthode avec paramètres¶

cruft create https://github.com/username/PyFoundry.git \
  --extra-context '{
    "project_name": "Analyse des Ventes",
    "description": "Analyse des données de vente trimestrielles",
    "python_version": "3.11",
    "use_node": "n"
  }'

Méthode avec valeurs par défaut¶

cruft create https://github.com/username/PyFoundry.git --no-input

Démarrage du projet¶

Avec VS Code + Devcontainer (Recommandé)¶

Ouvrir le projet dans VS Code
Cliquer sur "Reopen in Container" quand proposé
Attendre l'installation automatique des dépendances
Commencer à développer !

Vérification de l'installation¶

# Vérifier que Jupyter fonctionne
jupyter lab

# Vérifier l'installation des dépendances
python -c "import pandas, numpy; print('✅ Dépendances OK')"

Mise à jour du template¶

Si le template PyFoundry est mis à jour, vous pouvez synchroniser votre projet :

cruft update