D.2 Déployer et documenter une solution Python

1Situer

Le programme de gestion des notes est prêt et testé. Le formateur veut l'utiliser sur l'ordinateur de la salle des professeurs, qui n'a jamais vu Python. Il faut livrer une solution qui s'installe et se lance simplement, avec une notice claire.

2Comprendre

Du code au programme installé

Point de départ : notes.py, un programme qui fonctionne et qui a été testé.

1 / 6

Déployer, c’est rendre un programme utilisable ailleurs que sur l’ordinateur du développeur. Trois questions à régler : comment l’organiser, comment l’installer, comment l’expliquer.

Organiser le programme

Une fonction main() qui lance le programme, et le test if __name__ == "__main__": pour qu’il puisse aussi être importé.
Des docstrings (texte entre triples guillemets) en tête du fichier et de chaque fonction : elles alimentent help().
Un numéro de version.

Exemple simple

Ranger un petit projet de gestion de notes

Un projet bien rangé sépare le calcul, l’affichage et le point de départ.

gestion_notes/
├── main.py          ← point d'entrée : lance le programme
├── calculs.py       ← fonctions moyenne(), mention()
├── affichage.py     ← fonctions d'affichage
├── requirements.txt ← bibliothèques à installer
└── README.md        ← mode d'emploi

Ce qui se passe

main.py importe les fonctions : from calculs import moyenne.
Chaque fichier a un seul rôle : on sait où chercher.
README.md explique comment installer et lancer le projet.

Gérer les dépendances

Étape	Commande
Créer un environnement isolé	`python -m venv .venv`
L’activer (Windows)	`.venv\Scripts\activate`
Installer une bibliothèque	`pip install pandas`
Figer la liste des dépendances	`pip freeze > requirements.txt`
Tout réinstaller ailleurs	`pip install -r requirements.txt`

Exemple simple

Installer les mêmes bibliothèques sur un autre ordinateur

requirements.txt liste les bibliothèques et leur version. Une seule commande installe tout.

python -m venv .venv                 # crée un environnement isolé
.venv\Scripts\activate               # l'active (Windows)
pip install -r requirements.txt      # installe tout ce qui est listé

Ce qui se passe

venv crée un dossier où les bibliothèques du projet sont installées, sans toucher au reste de l’ordinateur.
requirements.txt contient par exemple : openpyxl==3.1.2.
Le formateur ou un collègue obtient exactement les mêmes versions.

Créer un exécutable

Pour un poste sans Python, PyInstaller crée un fichier .exe :

pip install pyinstaller
pyinstaller --onefile notes.py

L’exécutable se trouve dans le dossier dist.

Exemple simple

Donner le programme à quelqu’un qui n’a pas Python

PyInstaller rassemble le programme et Python dans un seul fichier .exe.

pip install pyinstaller
pyinstaller --onefile main.py
# le fichier prêt se trouve dans dist/main.exe

Ce qui se passe

—onefile produit un seul fichier facile à envoyer.
La personne double-clique sur main.exe, sans rien installer.
Testez l’exécutable sur un autre ordinateur avant de le livrer.

Documenter

Un fichier README.md explique à quoi sert le programme, comment l’installer, comment l’utiliser, avec un exemple. C’est souvent la première chose que lit un client ou un recruteur.

Exemple simple

Une fonction documentée avec une docstring

La docstring est le texte entre triples guillemets sous la ligne def. help() l’affiche.

def mention(moyenne):
    """Renvoie la mention correspondant à une moyenne sur 20.

    Exemple : mention(14.5) renvoie "Bien".
    """
    if moyenne >= 16:
        return "Très bien"
    if moyenne >= 14:
        return "Bien"
    return "Passable" if moyenne >= 10 else "Ajourné"

help(mention)

Ce qui se passe

La docstring dit ce que fait la fonction, ce qu’elle reçoit et ce qu’elle renvoie.
Un exemple d’appel aide le lecteur à comprendre tout de suite.
help(mention) affiche ce texte, comme pour les fonctions de Python.

Exemple simple

Livrer un plat, pas la cuisine

Le client reçoit le plat prêt avec le mode d'emploi, pas vos casseroles. Déployer, c'est pareil : on livre un programme propre, documenté, qui démarre d'une seule commande.

Exemple simple

Le point d'entrée main

On regroupe le démarrage du programme dans une fonction main. Ainsi le fichier peut être lancé directement ou importé par un autre sans tout exécuter.

def main():
    print("Programme lancé")

if __name__ == "__main__":
    main()

3Manipuler

Ce programme est organisé comme un vrai projet : une fonction main, une docstring et le test __name__. Exécutez-le, puis lisez la documentation qu'il affiche avec help().

Pas à pas dans le lab ↗Python se charge au premier clic (environ 12 Mo, une seule fois).

Entrées pour input(), séparées par des virgules

Console

4Pratiquer

Exercice 1 · Le fichier requirements.txt

Votre programme utilise les bibliothèques externes pandas et openpyxl. Écrivez le fichier requirements.txt et la commande qui installe tout sur un nouveau poste.

Voir le corrigé

# requirements.txt
pandas
openpyxl

# sur le nouveau poste, dans le dossier du projet :
python -m venv .venv
.venv\Scripts\activate        (Windows)
pip install -r requirements.txt

Exercice 2 · La notice d'utilisation

Rédigez les rubriques du fichier README.md qui accompagne votre programme.

Voir le corrigé

# Gestion des notes
## À quoi sert le programme
## Installation (prérequis, commandes)
## Utilisation (exemple de commande et de résultat)
## Format du fichier d'entrée (colonnes du CSV)
## Auteur et version

Déployer et documenter une solution Python

1Situer

2Comprendre

Organiser le programme

Gérer les dépendances

Créer un exécutable

Documenter

Livrer un plat, pas la cuisine

Le point d'entrée main

3Manipuler

4Pratiquer

Exercice 1 · Le fichier requirements.txt

Exercice 2 · La notice d'utilisation

5Vérifier