Sukurk ir paskirstyk savo patį Python paketą

Visas prasideda nuo klausimo, kaip sukurti savo Python-paketus ir efektyviai paskirstyti juos. Šiame vadove aš parodysiu tau, kaip žingsnis po žingsnio eiti, kad sukurtum paketą, kurį galėtum pateikti kitiems. Tam būtina sukurti teisingus failus ir užtikrinti tinkamą struktūrą. Tai leidžia kitiems lengvai įdiegti ir naudoti tavo paketą. Pradėkime ir ištirkime paketų paskirstymo pagrindus.

Svarbiausi įžvalgai

1. Sukurk setup.py failą, kuris apima visus tavo paketo metaduomenis.
2. Pridėk manifestą, kuris išvardina visus ne-Python failus.
3. Pasinaudok teisingu komandu terminale, kad sukurtum savo distribuciją.
4. Supakuotas paketas gali būti lengvai perduotas diegimui.

Žingsnis po žingsnio vadovas

Yra keletas svarbių žingsnių, kuriuos turi sekti, kad sukurtum savo Python paketą. Toliau pateikiamas išsamus vadovas su ekrano nuotraukomis, kuris parodys tavo kelią į savo paketų paskirstymą.

Direktorijos struktūros kūrimas

Pirmiausia turėtum paruošti teisingą direktorijos struktūrą savo paketui. Sukurk pagrindinę direktoriją, kurioje bus visi failai ir po direktorijos, įskaitant šaltinio kodą, dokumentaciją ir licencijos informaciją.

Šiame pavyzdyje aš paruošiu paprastą struktūrą su README.md failu ir licencijos failu. Tu gali naudoti GPL licenciją, kad nustatytum savo paketo teises.

API struktūros apibrėžimas

Norėdamas, kad tavo paketas būtų naudingas, turi turėti bent jau API dokumentaciją ir bazinę klasę, iš kurios gali paveldėti kitos klasės. Ši struktūra padeda leisti plėtrą ir pritaikymus tavo paketui.

Paprasta API ir atsargų klasė galėtų būti puikus įvadas.

setup.py failo kūrimas

Centralinė tavo paketo komponentė yra setup.py failas. Čia tu apibrėži visą būtinas projekto informaciją, kuri yra reikalinga diegimo procese.

Šiame faile tu importuoji reikalingus modulinius ir nurodai savo paketo pagrindinius duomenis, įskaitant pavadinimą, autorių, el. pašto adresą, versiją ir svetainę.

Būtini paketai

Turi užtikrinti, kad visi tavo paketo priklausomybės būtų nurodytos. Tai atliekama setup.py, pridedant paketų sąrašą, kuris turėtų būti pristatytas su tavo paketu.

Pridėk čia visus būtinus pagalbinius paketus, pvz., bazinę klasę ir specifines sudėtingas klases.

Manifest failo kūrimas

Norint užtikrinti, kad visi svarbūs ne-Python failai būtų įtraukti į tavo paketą, sukurk manifestą. Šis failas išvardina visus failus, kurie bus apsvarstyti paketuojant.

Šiame faile nurodai, kokius failų tipus reikia įtraukti į paketą, taip pat katalogus, pavyzdžiui, dokumentaciją.

Terminalo komandos distribucijai kurti

Dabar atėjo laikas sukurti paketą. Atidaryk terminalą ir pereik prie savo setup.py direktorijos. Čia gali atlikti paketų kūrimo komandą.

Patikrinti sukurtus failus

Sukūrus distribuciją turėtum rasti dist direktoriją, kuri turi supakuotą paketą.

Dabar gali perduoti šį failą arba įdiegti.

Paketo diegimas

Norint užtikrinti, kad paketas veiktų teisingai, gali jį vėl įdiegti. Tam išskleisk direktoriją ir dar kartą paleisk setup.py failą.

Panaudotojams, kurie neturi administratoriaus teisių, gali atlikti diegimo komandą dabartiniam vartotojui:

python setup.py install --user

Distribucija vartotojams

Jei nori paskirstyti savo paketą, įsitikink, kad visi failai, tokie kaip README.md, licencija ir setup.py, yra pridėti. Tai užtikrina, kad paketas gali būti teisingai įdiegtas, kai vartotojas jį atsisiunčia.

Čia yra tavo paketas failų sistemoje pasiruošęs ir gali būti perduotas kitiems.

Santrauka - Tinkamai supakuok savo Python paketus

Dabar išmokai, kaip sukurti išsamią struktūrą savo Python paketams ir sėkmingai sugeneruoti distribuciją, kurią gali lengvai paskirstyti. Nuo direktorijos struktūros kūrimo iki galutinio vartotojo diegimo, tu įvykdei visus žingsnius, kad efektyviai paskirstytum savo paketą.