Kurrikulum Leson 242 van 250 · Slotprojek: Versend dit (Verpak jou projek)
Slotprojek: Versend dit (Verpak jou projek)

README + Een-opdrag Uitvoer

Jy het 'n skoon uitleg en regte toetse. Die laaste myl is die deel wat beoordelaars eerste raak: die README en die een opdrag wat die ding hardloop. 'n Projek wat tien minute raaiwerk verg om te begin, voel gebreek selfs as dit werk. 'n Projek wat jy kan clone en met 'n enkele reël kan hardloop, voel professioneel selfs as dit klein is. Dieselfde kode -> heeltemal ander indruk.

Die README is 'n kontrak. 'n Leser blaai dit van bo tot onder deur, en hulle verwag 'n voorspelbare vorm: die projek se naam as die titel, dan hoe om dit te installeer, dan hoe om dit te gebruik, dan hoe om dit te toets. Konkreet het 'n goeie README 'n boonste titelreël (# Something), dan hierdie afdelings in hierdie volgorde:

# 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

Orde is belangrik omdat 'n leser dit as stappe volg. Gebruik voor Setup is verwarrend -> jy kan nie gebruik wat jy nie geïnstalleer het nie. So skryf jy 'n checker, validate_readme(text), wat True teruggee net as 'n #  titel verskyn, gevolg deur ## Setup, dan ## Usage, dan ## Tests, elk na die vorige een. 'n Ontbrekende afdeling, of afdelinge buite volgorde, gee False terug. Die truc: loop die reëls een keer deur, hou 'n "cursor" van waar jy is, en vereis dat elke afdeling by 'n posisie after die cursor moet verskyn.

Die een-opdrag-wen. Let op dat die ## Usage lyn bo 'n enkele opdrag is. Dit is die doel van 'n Makefile of justfile-target soos make run -> een maklike opdrag wat die projek begin, sodat niemand die volledige invoeging hoef te onthou nie. Skryf make_run(name) wat daardie opdragstring vir 'n projek teruggee, bv. python -m triage (of make run). Dit moet die projeknaam insluit, genormaliseer op dieselfde manier as die pakketvergrooting, sodat 'n ander projek 'n ander opdrag gee.

Twee eerlike, nie-gegradeerde notas vir die regte repo. Eerstens, geheime: die cp .env.example .env stap bestaan omdat jou regte API-sleutel in .env gaan, wat jy by .gitignore en never commit voeg. Jy commit net .env.example -> die shape van die config met plekhouderwaardes. Om 'n sleutel na 'n publieke repo te lek is die klassieke portefeulje-projek fout. Tweedens, deploying this: om dit aanlyn te sit, sal jy 'n klein Dockerfile (kopieer die repo, pip install, stel die run command as die entrypoint) skryf en na 'n PaaS soos Render, Railway, of Fly stoot. Daardie deel kan nie in jou bl brasileiros loop of gegrade word nie -> dit is jou om te doen wanneer jy publiseer. Druk Run om 'n volledige README te valideer en die run command te druk.

Jou beurt

Skryf die twee deterministiese dele van 'n goeie README. validate_readme(text) gee True as 'n top-vlak #  titel verskyn, dan ## Setup, dan ## Usage, dan ## Tests, elk na die vorige ( 'n ontbrekende afdeling of afdelings wat nie in die regte volgorde is -> False). make_run(name) gee die een-opdrag-wen string (bv. python -m <pkg> of make run) wat die projeknaam insluit, genormaliseer soos die pakketverwysing, sodat 'n ander naam 'n ander opdrag gee.

Sien jy 'n probleem in hierdie les? Rapporteer dit · Vra oor hierdie les

Hierdie oefening open binnekort

Voltooi die lesie voor dit en hierdie een sal ontvanklik wees. Die hele kursus is gratis, geen rekening nodig nie, en jy kan hierdie les nou lees.