Gvidilo¶
Ĉi tiu gvidilo helpos vin konstrui kaj eldoni Python-bibliotekon kiel tiun de ĉi tiu deponejo. Ĝi gvidos vin tra la bazoj de la versikontrolo, la kunlabora fluo, la pakado kaj testado, kaj la lingva scio, kiu iras internen.
Gvidilo, ne referenco
Ĉi tiuj paĝoj instruas la kiel. La sekcio
Biblioteko estas la alia duono de ĉi tiu paĝaro: la
referenca manlibro de esperantilo mem — ĝia API kaj ĝia funkciaro.
La kvar sekcioj¶
- 1. Git — versikontrolo: kiel ĝi funkcias, la bezonataj komandoj kaj kiel malfari ŝanĝojn.
- 2. GitHub — la kunlabora fluo: kunfandaj petoj, Actions, protekto de la deponejo, Pages.
- 3. Python-Biblioteko — pakado, strukturo, dezajno de la API, instalado kaj testado.
- 4. Esperanto — historio, gramatiko, vortprovizo kaj vortlistoj: la reguloj, kiujn la biblioteko enkodigas.
La sekcioj estas plejparte sendependaj. Legu ilin laŭorde, se vi komencas de nulo; saltu rekte al Python-Biblioteko aŭ Esperanto, se vi jam konas Git kaj GitHub-on.
Ĉi tiu deponejo estas la ekzemplo¶
Kiam ajn la gvidilo montras dosieron, laborfluon aŭ enmetaĵon (commit), ĝi estas reala, el ĉi tiu deponejo — ne elpensita fragmento. La sekcio Biblioteko dokumentas la rezulton.
| La gvidilo klarigas | Vi povas vidi ĝin funkcii en |
|---|---|
pyproject.toml kaj la src/-strukturo |
pyproject.toml |
| Dezajni publikan API-on | Biblioteko → API-referenco |
| Verki testojn | tests/test_tokenizer.py |
| GitHub Actions | .github/workflows/ |
| GitHub Pages | ĉi tiu paĝaro |