Izveido un izplati savu Pašizveidoto Python pakotni

Viss sākas ar jautājumu, kā tu vari izveidot un efektīvi izplatīt savus Python paketus. Šajā ceļvedī es tev rādīšu, kā soli pa solim izstrādāt paketi, ko varēsi piedāvāt citiem. Šajā procesā ir būtiski izveidot pareizās failus un nodrošināt pareizo struktūru. Tas ļaus citiem viegli instalēt un izmantot tavu paketi. Sāksim tieši tagad un izpētīsim paketu izplatīšanas pamatus.

Svarīgākie secinājumi

1. Izveido setup.py failu, kas satur visus tava paketa metadatus.
2. Pievieno manifest failu, kas uzskaita visus ne-Python failus.
3. Izmanto pareizo komandu terminālī, lai izveidotu savu sadalījumu.
4. Izpakotā pakete var viegli tikt nodota instalācijai.

Soli pa solim ceļvedis

Iemesls, kāpēc tev jāseko dažiem būtiskiem soļiem, lai izveidotu savu Python paketi. Zemāk ir detalizēts ceļvedis ar ekrānuzņēmumiem, kas parādīs ceļu uz tavu paša paketu izplatīšanu.

Direktoriju struktūras izveide

Vispirms tev jāsagatavo pareizā direktoriju struktūra tavai paketei. Izveido galveno direktoriju, kurā iekļauj visus failus un apakšdirektorijas, tostarp avota kodu, dokumentāciju un licenci.

Šajā piemērā es sagatavoju vienkāršu struktūru ar README.md failu un licenci. Tu vari izmantot GPL licenci, lai noteiktu sava paketa tiesības.

API struktūras definēšana

Lai tava pakete būtu noderīga, tev nepieciešama vismaz viena API dokumentācija un pamata klase, no kuras var mantojumu gūt citas klases. Šī struktūra palīdzēs iespējot tavas paketes paplašinājumus un pielāgojumus.

Vienkārša API un krājumu klase varētu nodrošināt lielisku sākumu.

setup.py faila izveide

Viens no centrālajiem tavu paketes komponentiem ir setup.py fails. Šeit tu definē visus nepieciešamos projekta datus, kas nepieciešami instalācijas procesā.

Šajā failā tu importē nepieciešamās moduļus un norādi uz taviem paketes pamata datiem, tostarp vārdu, autoru, e-pastu, versijas numuru un tīmekļa vietni.

Nepieciešamo pakakžu norādīšana

Tev jānodrošina, ka visi tava paketa atkarības norādītas. To izdarīsi setup.py, pievienojot sarakstu ar pakakžiem, kas tiks piegādāti kopā ar tavu paketi.

Pievieno šeit visus nepieciešamos apakšpaketes, piemēram, pamata klasi un īpašas plaša klases.

Manifest faila izveide

Lai nodrošinātu, ka visi ar paketi saistītie Non-Python faili ir iekļauti tavā paketē, izveido manifest failu. Šis fails uzskaita visus failus, kurus ņemt vērā pakotnē.

Šajā failā tu norādīsi, kuri failu tipi jāiekļauj paketē, kā arī direktorijas, piemēram, dokumentācija.

Termināla komandas sadalījuma izveidei

Tagad ir laiks izveidot paketi. Atver savu termināli un pārej uz direktoriju, kurā atrodas tavs setup.py. Šeit tu vari izpildīt komandu paketes izveidei.

Izveidoto failu pārbaude

Pēc sadalījuma izveides tev jāatrod direktorija ar nosaukumu dist, kurā atrodas iesaiņotā pakete.

Tagad tu vari šo failu nodot citiem vai instalēt.

Paketes instalācija

Lai pārliecinātos, ka pakete strādā pareizi, vari to pats atkārtoti instalēt. Lai to izdarītu, izpakoti direktoriju un atkārtoti izpildi setup.py failu.

Lietotājiem, kuriem nav administratora tiesību, tu vari izpildīt instalācijas komandu pašreizējam lietotājam:

python setup.py install --user

Izplatīšana lietotājiem

Ja vēlies izplatīt savu paketi, pārliecinies, ka visi faili, piemēram, README.md, licence un setup.py ir pievienoti. Tas nodrošinās, ka pakete tiks pareizi instalēta, tiklīdz lietotājs to lejupielādēs.

Šeit tava pakete ir gatava failu sistēmā un var tikt nodota citiem.

Secinājums – pareizi iepakot savus Python paketes

Tagad tu esi iemācījies, kā izveidot visaptverošu struktūru saviem Python paketes un veiksmīgi ģenerēt sadalījumu, ko vari viegli izplatīt. No direktoriju struktūras izveides līdz gala lietotāja instalācijai tu esi izgājis visus soļus, lai efektīvi izplatītu savu paketi.