Programma Lezione 240 di 250 · Progetto finale: rilascialo (impacchetta il tuo progetto)
Progetto finale: rilascialo (impacchetta il tuo progetto)

Organizzare il repository

Nei progetti finali precedenti hai costruito qualcosa di vero: un copilota per l'assistenza, un estrattore di documenti, un cancello di valutazione. In questo momento probabilmente vive come un mucchio di celle o un unico lungo script. Un responsabile delle assunzioni che lo apre deve indovinare dove stanno le cose, e un selezionatore che lo clona e non vede un modo ovvio per farlo girare chiude semplicemente la scheda. La cosa con più leva in assoluto che puoi fare per un progetto di portfolio è dargli una struttura noiosa e convenzionale così chiunque ci si orienta in 30 secondi.

Nota onesta in partenza: questo modulo parla del repository, non di un rilascio dal vivo nel cloud. Non possiamo avviare un server o fare push su un host dal tuo browser, e non faremo finta di poterlo fare. Ciò che puoi imparare e dimostrare qui è la struttura, i test, e l'esecuzione con un solo comando che rendono banale un rilascio più avanti. Le note sul rilascio alla fine sono esattamente questo -> note, segnate come non valutate.

La struttura su cui converge quasi ogni progetto 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

Due cose da notare. Primo, il package vive sotto src/ in una cartella che ha il nome del progetto -> è la "src layout", e impedisce ai tuoi test di importare per sbaglio la cartella locale invece del package installato. Secondo, il nome della cartella del package segue il nome del progetto: un progetto chiamato triage riceve src/triage/, un progetto chiamato copilot riceve src/copilot/. Non c'è un'unica risposta fissa -> l'albero è una funzione del nome.

Il tuo compito è scrivere quella funzione. build_manifest(name) riceve il nome di un progetto e restituisce la lista dei file che il repository dovrebbe contenere, come lista ordinata di stringhe di percorsi. Deve includere README.md, pyproject.toml, una cartella del package sotto src/<name>/ con dentro __init__.py e un file modulo, e un file tests/test_*.py. Normalizza il nome in una cartella di package valida (minuscolo, e trasforma spazi e trattini in trattini bassi, dato che doc-extractor non è un nome di modulo importabile ma doc_extractor sì).

È il manifesto che uno script di impalcatura creerebbe su disco. Nel correttore non scriviamo file -> controlliamo che tu sappia descrivere l'albero giusto per qualsiasi nome di progetto. Premi Run per stampare la struttura per un progetto chiamato triage.

Tocca a te

Scrivi build_manifest(name) che restituisce l'albero dei file del repository per un progetto come lista ordinata di stringhe di percorsi. Deve includere README.md, pyproject.toml, la cartella del package sotto src/<pkg>/ con un __init__.py, un __main__.py (è il file che fa funzionare python -m <pkg>, il comando di esecuzione della lezione 3) e almeno un altro file modulo .py, e un file di test chiamato tests/test_<pkg>.py. Normalizza name nella cartella del package (minuscolo, spazi e trattini diventano trattini bassi) così un nome di progetto diverso produce un albero diverso.

Hai notato un problema in questa lezione? Segnalalo · Chiedi qualcosa su questa lezione

Questo esercizio si apre presto

Finisci la lezione precedente e questa si sblocca. L'intero corso è gratuito, senza account, e puoi leggere questa lezione subito.