Lege das Repo an
Du hast in den früheren Capstones etwas Echtes gebaut: einen Support Copilot, einen Doc Extractor, ein Eval Gate. Jetzt existiert es wahrscheinlich als ein Haufen Zellen oder ein langes Script. Ein Hiring Manager, der das öffnet, muss guess, wo die Dinge sind, und ein Recruiter, der es klont und keinen offensichtlichen Weg sieht, es auszuführen, schließt einfach den Tab. Die wichtigste Sache, die du für ein Portfolio Projekt tun kannst, ist ihm ein boring, conventional layout zu geben, damit jeder sich in 30 Sekunden zurechtfinden kann.
Ehrliche Anmerkung vorab: dieses Modul handelt vom repo, nicht von einem Live-Cloud-Deploy. Wir können keinen Server starten oder zu einem Host pushen aus deinem Browser heraus, und wir werden so nicht tun. Was du can hier lernen und beweisen kannst, ist die Struktur, die Tests und der Ein-Befehls-Lauf, die einen Deploy später trivial machen. Die Deploy-Notizen am Ende sind genau das -> Notizen, markiert als nicht bewertet.
Das Layout, auf das fast jedes Python-Projekt zusteuert:
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
Zwei Dinge zu beachten. Erstens liegt das Paket unter src/ in einem Ordner benannt nach dem Projekt -> das ist das "src layout" und es verhindert, dass deine Tests versehentlich den lokalen Ordner statt des installierten Pakets importieren. Zweitens folgt der Name des Paketverzeichnisses dem Projektnamen: ein Projekt namens triage erhält src/triage/, ein Projekt namens copilot erhält src/copilot/. Es gibt keine versiegelte Antwort -> der Baum ist eine Funktion des Namens.
Deine Aufgabe ist es, diese Funktion zu schreiben. build_manifest(name) nimmt einen Projektnamen und gibt die Liste der Dateien zurück, die das Repo enthalten sollte, als eine sorted Liste von Pfad-Strings. Sie muss README.md, pyproject.toml, ein Paketverzeichnis unter src/<name>/ enthalten, das __init__.py und eine Moduldatei hält, und eine tests/test_*.py Datei. Normalisiere den Namen in ein gültiges Paketverzeichnis (Kleinschreibung, und wandle Leerzeichen und Bindestriche in Unterstriche um, da doc-extractor kein importierbarer Modulname ist, aber doc_extractor ist).
Dies ist das Manifest, das ein Scaffolding-Script auf der Festplatte erstellen würde. Wir schreiben keine Dateien im Grader -> wir prüfen, ob du den richtigen Baum für jeden Projektnamen beschreiben kannst. Drücke Run, um das Layout für ein Projekt namens triage zu drucken.
Schreibe build_manifest(name), das den Repo-Dateibaum für ein Projekt als eine sorted Liste von Pfad-Strings zurückgibt. Es muss README.md, pyproject.toml, das Paketverzeichnis unter src/<pkg>/ mit einem __init__.py, ein __main__.py (diese Datei ist das, was python -m <pkg>, den Ausführungsbefehl in Lektion 3, funktionieren lässt) und mindestens eine andere Modul .py Datei sowie eine Testdatei namens tests/test_<pkg>.py enthalten. Normalisiere name in das Paketverzeichnis (Kleinschreibung, Leerzeichen und Bindestriche werden zu Unterstrichen), damit ein anderer Projektname einen anderen Baum erzeugt.
Ein Problem in dieser Lektion entdeckt? Melde es · Frage zu dieser Lektion
Diese Übung öffnet bald
Beende die vorherige Lektion, damit diese freigeschaltet wird. Der ganze Kurs ist kostenlos, kein Konto erforderlich, und du kannst diese Lektion jetzt direkt lesen.
Dieser Browser blockiert Cookies für learn.floati.life, daher können hier beendigte Lektionen nicht in der richtigen Reihenfolge geöffnet werden. Erlaube Cookies für diese Seite und lade sie neu.