Instalado kaj uzo¶
Kiam biblioteko estas pakita (Organizado), por uzi ĝin sufiĉas unu
pip install. Ĉar la plej granda parto de la laboro en ĉi tiu kurso okazas en
kajeroj (Google Colab), la ĉefa vojo estas instali rekte de GitHub — sen loka
agordo, sen mana klonado.
Instali de GitHub¶
Warning
Kiam vi instalas bibliotekon loke, indas uzi virtualajn mediojn, precipe kun bibliotekoj en evoluo. Tio evitas, ke nia biblioteko instaliĝu tutsisteme, aŭ ke dependecoj de malsamaj bibliotekoj miksiĝu. Legu Instali loke por pli da informoj.
pip povas instali pakon rekte de Git-deponejo. Ĝi estas la plej rapida maniero
enmeti esperantilo-n en kajeron dum la biblioteko ankoraŭ moviĝas:
Ĉi tio klonas la deponejon malantaŭ la kulisoj, konstruas la pakon el ĝia
pyproject.toml, kaj instalas ĝin — ekzakte kvazaŭ ĝi venus de la Python Package
Index.
Vi povas fiksi specifan branĉon, etikedon aŭ commit-on aldonante @<ref>:
pip install git+https://github.com/jparisu/nlp-esperantilo.git@main
pip install git+https://github.com/jparisu/nlp-esperantilo.git@jparisu/v0.1
Kial instali de GitHub?
Dum biblioteko estas en aktiva disvolvado kaj ankoraŭ ne publikigita al PyPI, instali de GitHub signifas, ke ĉiuj ĉiam ricevas la plej lastan kodon de elektita branĉo, per unu sola komando kaj sen manaj paŝoj. Ĝi taŭgas nature por laborfluo bazita sur kajeroj.
Uzi ĝin en kajero¶
En Colab-kajero, instalu en ĉelo (la komenca ! rulas ŝelan komandon), poste
importu kaj uzu la bibliotekon:
Restartigu la rultempon post la instalado
Se vi jam importis esperantilo-n en kajero kaj poste instalas novan version,
restartigu la rultempon (Runtime → Restart), por ke la nova kodo estu prenata.
Python kaŝmemorigas la importitajn modulojn dum la tuta sesio.
Instali loke¶
Por disvolvi la bibliotekon mem — anstataŭ nur uzi ĝin — instalu ĝin loke en virtuala medio. Virtuala medio estas izolita Python-instalaĵo por unu projekto, por ke ĝiaj dependecoj ne konfliktu kun io alia sur via maŝino:
python -m venv .venv # kreu la medion
source .venv/bin/activate # aktivigu ĝin (Windows: .venv\Scripts\activate)
pip install -e ".[test]" # redaktebla instalo, kun la testa kromaĵo
Du opcioj igas ĉi tion disvolva instalo:
-e(redaktebla). La pako estas instalita kiel ligilo al via fontkodo, do viaj redaktoj efikas tuj — sen reinstalado post ĉiu ŝanĝo..[test]instalas la pakon plus ĝian kromaĵontest(pytest), por ke vi povu ruli la testaron tuj (vidu Testado). Uzu.[docs]por labori pri la dokumentaro anstataŭe.
Ĉi tio estas ekzakte tio, kion faras la tests.yml-laborfluo
en CI, do verda loka rulo signifas verdan rulon en GitHub.