Leg de Repo aan
Je hebt iets echts gebouwd in de eerdere capstones: een support copilot, een doc extractor, een eval gate. Nu bestaat het waarschijnlijk als een stapel cellen of één lange script. Een hiring manager die dat opent moet guess waar dingen staan, en een recruiter die het clone en geen duidelijke manier ziet om het te draaien sluit gewoon het tabblad. De enige zaak met de hoogste hefboom die je kunt doen voor een portfolio project is het een boring, conventional layout geven zodat iedereen in 30 seconden zijn weg kan vinden.
Eerlijke opmerking vooraf: deze module gaat over de repo, niet over een live cloud deploy. We kunnen geen server opzetten of naar een host pushen vanuit je browser, en we gaan dat ook niet doen. Wat je can leren en bewijzen hier is de structuur, de tests, en de run met één commando die een deploy later triviaal maken. De deploy notities aan het einde zijn precies dat -> notities, gemarkeerd als niet beoordeeld.
De lay-out waar bijna elk Python-project naar convergeert:
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
Twee dingen om op te merken. Ten eerste, het pakket staat onder src/ in een map genaamd naar het project -> dat is de "src layout", en het voorkomt dat je tests per ongeluk de lokale map importeren in plaats van het geïnstalleerde pakket. Ten tweede, de naam van de pakketmap volgt de projectnaam: een project genaamd triage krijgt src/triage/, een project genaamd copilot krijgt src/copilot/. Er is geen enkel verzegeld antwoord -> de boom is een functie van de naam.
Je taak is om die functie te schrijven. build_manifest(name) neemt een projectnaam en geeft de lijst met bestanden terug die de repo moet bevatten, als een sorted lijst van path strings. Het moet README.md, pyproject.toml, een package directory onder src/<name>/ bevatten die __init__.py en een module bestand bevat, en een tests/test_*.py bestand. Normaliseer de naam naar een geldige package directory (kleine letters, en verander spaties en koppeltekens in underscores, omdat doc-extractor geen importeerbare module naam is maar doc_extractor wel).
Dit is het manifest dat een scaffolding script op schijf zou aanmaken. We schrijven geen bestanden in de grader -> we controleren of je de juiste boom kunt beschrijven voor elke projectnaam. Druk op Run om de layout te printen voor een project genaamd triage.
Schrijf build_manifest(name) dat de repo file tree voor een project teruggeeft als een sorted lijst van path strings. Het moet README.md, pyproject.toml, de package directory onder src/<pkg>/ met een __init__.py, een __main__.py (dat bestand zorgt ervoor dat python -m <pkg>, de run command in les 3, werkt) en ten minste één andere module .py bestand, en een testbestand genaamd tests/test_<pkg>.py bevatten. Normaliseer name naar de package dir (kleine letters, spaties en koppeltekens worden underscores) zodat een andere projectnaam een andere tree produceert.
Een probleem ontdekt in deze les? Meld het · Vraag naar deze les
Deze oefening opent binnenkort
Maak de les ervoor af voordat deze wordt ontgrendeld. De hele cursus is gratis, geen account nodig, en je kunt deze les nu lezen.
Deze browser blokkeert cookies voor learn.floati.life, dus lessen die je hier hebt afgerond kunnen niet in de juiste volgorde worden geopend. Sta cookies toe voor deze site en laad de pagina opnieuw.