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

Organise le dépôt

Tu as construit quelque chose de réel dans les projets finaux précédents : un copilote de support, un extracteur de documents, une porte d'évaluation. Pour l'instant, ça vit sans doute sous forme de tas de cellules ou d'un long script. Un recruteur qui ouvre ça doit deviner où sont les choses, et quelqu'un qui le clone sans voir de façon évidente de le lancer ferme simplement l'onglet. La chose la plus rentable que tu puisses faire pour un projet de portfolio, c'est de lui donner une organisation banale et conventionnelle, pour que n'importe qui s'y retrouve en 30 secondes.

Précision honnête dès le départ : ce module porte sur le dépôt, pas sur un vrai déploiement dans le cloud. On ne peut pas démarrer un serveur ni pousser vers un hébergeur depuis ton navigateur, et on ne va pas faire semblant. Ce que tu peux apprendre et prouver ici, c'est la structure, les tests et le lancement en une commande qui rendent un déploiement trivial plus tard. Les notes de déploiement à la fin ne sont que ça -> des notes, signalées comme non notées.

L'organisation vers laquelle convergent presque tous les projets Python :

my_project/
  README.md            # what it is + how to run it
  pyproject.toml       # name, version, dependencies
  .env.example         # the shape of the secrets (NEVER the real ones)
  src/
    my_project/        # the importable package
      __init__.py
      __main__.py      # runs on `python -m my_project`
      core.py          # your actual code
  tests/
    test_my_project.py # pytest finds these by the test_ prefix

Deux choses à remarquer. D'abord, le paquet vit sous src/ dans un dossier qui porte le nom du projet -> c'est la « disposition src », et elle empêche tes tests d'importer par accident le dossier local au lieu du paquet installé. Ensuite, le nom du dossier du paquet suit le nom du projet : un projet appelé triage obtient src/triage/, un projet appelé copilot obtient src/copilot/. Il n'y a pas une seule réponse figée -> l'arborescence est une fonction du nom.

Ton travail est d'écrire cette fonction. build_manifest(name) prend un nom de projet et renvoie la liste des fichiers que le dépôt devrait contenir, sous forme de liste triée de chemins. Elle doit inclure README.md, pyproject.toml, un dossier de paquet sous src/<name>/ contenant __init__.py et un fichier de module, et un fichier tests/test_*.py. Normalise le nom en un dossier de paquet valide (en minuscules, et transforme les espaces et les tirets en tirets bas, car doc-extractor n'est pas un nom de module importable alors que doc_extractor l'est).

C'est le manifeste qu'un script d'échafaudage créerait sur le disque. On n'écrit pas de fichiers dans le correcteur -> on vérifie que tu sais décrire la bonne arborescence pour n'importe quel nom de projet. Appuie sur Run pour afficher l'organisation d'un projet appelé triage.

À ton tour

Écris build_manifest(name) qui renvoie l'arborescence des fichiers du dépôt d'un projet sous forme de liste triée de chemins. Elle doit inclure README.md, pyproject.toml, le dossier du paquet sous src/<pkg>/ avec un __init__.py, un __main__.py (c'est ce fichier qui fait marcher python -m <pkg>, la commande de lancement de la leçon 3) et au moins un autre fichier de module .py, ainsi qu'un fichier de test nommé tests/test_<pkg>.py. Normalise name en nom de dossier de paquet (minuscules, espaces et tirets transformés en tirets bas) pour qu'un autre nom de projet donne une autre arborescence.

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.