Programme Leçon 242 sur 250 · Projet final : livre-le (empaquette ton projet)
Projet final : livre-le (empaquette ton projet)

README + lancement en une commande

Tu as une organisation propre et de vrais tests. Le dernier kilomètre, c'est la partie sur laquelle les relecteurs tombent en premier : le README et la commande unique qui lance le tout. Un projet qui demande dix minutes de devinettes pour démarrer paraît cassé même s'il marche. Un projet que tu peux cloner et lancer en une seule ligne paraît professionnel même s'il est petit. Même code -> impression complètement différente.

Le README est un contrat. Un lecteur le parcourt de haut en bas, et il s'attend à une forme prévisible : le nom du projet en titre, puis comment l'installer, puis comment l'utiliser, puis comment le tester. Concrètement, un bon README a une ligne de titre de premier niveau (# Something), puis ces sections dans cet ordre :

# Triage Copilot

## Setup
pip install -e .            # editable install
cp .env.example .env        # then paste your real key into .env

## Usage
python -m triage            # the one-command run

## Tests
pytest

L'ordre compte parce qu'un lecteur le suit comme des étapes. Usage avant Setup, c'est déroutant -> on ne peut pas utiliser ce qu'on n'a pas installé. Tu écris donc un vérificateur, validate_readme(text), qui renvoie True seulement si un titre #  apparaît, suivi de ## Setup, puis de ## Usage, puis de ## Tests, chacun après le précédent. Une section manquante, ou des sections dans le désordre, renvoie False. L'astuce : parcours les lignes une seule fois, garde un « curseur » qui indique où tu en es, et exige que chaque section apparaisse à une position après le curseur.

Le lancement en une commande. Remarque que la ligne ## Usage ci-dessus est une seule commande. C'est le but d'une cible de Makefile ou de justfile comme make run -> une commande facile à retenir qui lance le projet, pour que personne n'ait à se souvenir de l'invocation complète. Écris make_run(name) qui renvoie cette commande pour un projet, par exemple python -m triage (ou make run). Elle doit contenir le nom du projet, normalisé de la même façon que le dossier du paquet, pour qu'un autre projet donne une autre commande.

Deux notes honnêtes, non notées, pour le vrai dépôt. D'abord, les secrets : l'étape cp .env.example .env existe parce que ta vraie clé d'API va dans .env, que tu ajoutes à .gitignore et que tu ne commites jamais. Tu ne commites que .env.example -> la forme de la configuration, avec des valeurs factices. Divulguer une clé dans un dépôt public est l'erreur classique des projets de portfolio. Ensuite, le déploiement : pour le mettre en ligne, tu écrirais un petit Dockerfile (copier le dépôt, pip install, définir la commande de lancement comme point d'entrée) et tu pousserais vers une PaaS comme Render, Railway ou Fly. Cette partie ne peut ni tourner ni être notée dans ton navigateur -> c'est à toi de la faire quand tu publies. Appuie sur Run pour valider un README complet et afficher la commande de lancement.

À ton tour

Écris les deux morceaux déterministes d'un bon README. validate_readme(text) renvoie True si et seulement si un titre de premier niveau #  apparaît, puis ## Setup, puis ## Usage, puis ## Tests, chacun après le précédent (une section manquante ou des sections dans le désordre -> False). make_run(name) renvoie la commande de lancement unique (par exemple python -m <pkg> ou make run) qui contient le nom du projet, normalisé comme le dossier du paquet, pour qu'un autre nom donne une autre commande.

Tu as repéré un problème dans cette leçon ? Signale-le · Pose une question sur cette leçon

Cet exercice s'ouvre bientôt

Termine la leçon précédente pour débloquer celle-ci. Tout le cours est gratuit, aucun compte n'est requis, et tu peux lire cette leçon dès maintenant.