Kõik algab küsimusest, kuidas sa saad oma Python -pakette luua ja tõhusalt jagada. Selles juhendis näitan ma sulle, kuidas sa samm-sammult edasi liikuda, et arendada paketti, mida sa saad teistele kättesaadavaks teha. Selleks on hädavajalik luua õiged failid ja tagada õige struktuur. See võimaldab teistel sinu paketti lihtsalt installida ja kasutada. Lähme otse asja juurde ja uurime pakettide jagamise aluseid.
Olulised tähelepanekud
- Looge setup.py fail, mis sisaldab kõiki teie paketi metaandmeid.
- Lisage manifestifail, mis loetleb kõik mitte-Python failid.
- Kasutage terminalis õiget käsku, et luua oma jaotamine.
- Väljapakkitud paketti saab lihtsalt installimise jaoks edastada.
Samm-sammuline juhend
On mõned olulised sammud, mida peate järgima, et luua oma Python-pakett. Allpool leiate üksikasjaliku juhendi ekraanipiltidega, mis näitavad teile teed oma pakettide jagamise juurde.
Katalooge struktuuri loomine
Esimese asjana peaksite oma paketi jaoks õige kataloogistruktuuri ette valmistama. Looge peamine kataloog, mis sisaldab kõiki faile ja alamkatalooge, sealhulgas lähtekoodi, dokumentatsiooni ja litsentsiteavet.
Selles näites valmistan ma ette lihtsa struktuuri, kus on README.md fail ja litsentsifail. Sa saad kasutada GPL-litsentsi, et määrata oma paketi õigused.
API struktuuri määramine
Et teie pakett oleks kasulik, vajate vähemalt ühte API dokumentatsiooni ja põhiklassi, millest teised klassid saavad pärida. See struktuur aitab võimaldada teie paketi laiendamist ja kohandamist.
Lihtne API ja varude klass võiks pakkuda suurepärast sissejuhatust.
setup.py faili loomine
Teie paketi keskne komponent on setup.py fail. Siin määratlete kõik vajalikud projektiandmed, mis on vajalikud installimisprotsessis.
Selles failis impordite vajalikud moodulid ja määratlete oma paketi põhiteated, sealhulgas nimi, autor, e-posti aadress, versiooninumber ja koduleht.
Nāhtud pakettide määramine
Pead kindlustama, et kõik teie paketi sõltuvused on määratud. See toimub setup.py failis, lisades nimekirja pakettidest, mis peaksid teie paketi koosseisus olema.
Lisage siia kõik vajalikud alam-paketid, näiteks põhiklasse ja spetsiifilisi ulatuslikke klasse.
Manifestifaili loomine
Kuna toimub, et kõik asjakohased mitte-Python failid on teie paketti lisatud, looge manifestifail. See fail loetleb kõik failid, mis tehakse pakendamise ajal arvesse.
Selles failis määrate, millised failitüübid tuleks paketti lisada, samuti kaustad, näiteks dokumentatsioon.
Terminali käsud jaotuse loomiseks
On aeg luua pakett. Avage oma terminal ja navigeerige oma setup.py kataloogi. Siin saate käivitada käsu paketi loomiseks.
Kontrollige loodud faile
Pärast jaotuse loomist peaksite leidma dist-nimeliste kataloogide, mis sisaldab pakendatud paketti.
Saate nüüd selle faili edastada või installida.
Paketi installimine
Et tagada, et pakett töötab õigesti, saate selle ise uuesti installida. Selleks hõivake kataloog ja käivitage setup.py fail uuesti.
Kasutajatele, kellel ei ole administraatoriõigusi, saate tasemekäsku õigesse kasutajasse täita:
Jaotused kasutajatele
Kui soovite oma paketti jagada, veenduge, et kõik failid, näiteks README.md, litsents ja setup.py on lisatud. See tagab, et pakett saab õigesti installida, niipea kui kasutaja selle alla laadib.
Siin on teie pakett failisüsteemis valmis ja saab teistele edastada.
Kokkuvõte - pakendage oma Python-pakette õigesti
Olete nüüd õppinud, kuidas luua põhjalik struktuur oma Python-pakettide jaoks ja edukalt genereerida jaotuse, mida saate lihtsalt jagada. Alates kataloogistruktuuri loomisest kuni lõppkasutaja installimiseni olete läbinud kõik sammud, et tõhusalt oma paketti jagada.
Sageli esitatavad küsimused
Kuidas ma loon manifestifaili?Sa saad manifestifaili käsitsi luua ja määrata soovitud failid, mis peaksid olema sinu pakendis.
Mida pean lisama setup.py faili?setup.py fail peab sisaldama paketi nime, autorit, e-posti aadressi, versiooninumbrit ning kõiki vajalikke sõltuvusi.
Kuidas ma installin paketi pärast selle loomist?Sa saad paketi kohapeal installida, liikudes terminalis oma paketi kataloogi ja käivitades käsu python setup.py install.
Milline litsents peaks olema minu paketil?GNU GPL litsents on sageli valitud vabade tarkvarade ja nende lähtekoodi kaitsmiseks. Sa võiksid siiski kaaluda ka muid litsentse.
Kas ma saan oma paketti ka PyPI-s avaldada?Jah, saad oma paketti avaldada Python Package Index (PyPI), et muuta see laiemale publikule kättesaadavaks.
