Vytvorte a distribujte svoj vlastný Python balík

Všetko sa začína otázkou, ako môžeš efektívne vytvoriť a distribuovať svoje vlastné Python-balíčky. V tejto príručke ti ukážem, ako postupovať krok za krokom, aby si vyvinul balíček, ktorý môžeš poskytnúť ostatným. Pri tom je nevyhnutné vytvoriť správne súbory a zabezpečiť správnu štruktúru. To umožní ostatným tvoj balíček jednoducho nainštalovať a používať. Poďme sa priamo ponoriť do základov distribúcie balíkov.

Hlavné poznatky

1. Vytvor setup.py súbor, ktorý obsahuje všetky metadáta tvojho balíčka.
2. Pridaj manifestový súbor, ktorý obsahuje všetky ne-Python súbory.
3. Použi správny príkaz v termináli na vytvorenie svojej distribúcie.
4. Rozbalený balíček môže byť jednoducho poskytnutý na inštaláciu.

Krok za krokom príručka

Existuje niekoľko kľúčových krokov, ktoré musíš dodržať, aby si vytvoril svoj vlastný Python balíček. Nižšie nájdeš podrobný návod s screenshoty, ktoré ti ukážu cestu k tvojej vlastnej distribúcii balíka.

Vytvorenie adresárovej štruktúry

Najprv by si mal pripraviť správnu adresárovú štruktúru pre svoj balíček. Vytvor hlavný adresár, ktorý bude obsahovať všetky súbory a podadresáre, vrátane zdrojového kódu, dokumentácie a informačných súborov o licenciách.

V tomto príklade pripravím jednoduchú štruktúru s README.md súborom a súborom licencie. Môžeš použiť GPL licenciu na definovanie práv svojho balíčka.

Definovanie štruktúry API

Aby si svoj balíček spravil užitočným, potrebuješ najmenej dokumentáciu API a základnú triedu, z ktorej môžu dediť ostatné triedy. Táto štruktúra pomáha umožniť rozšírenia a prispôsobenia tvojho balíčka.

Jednoduchá trieda API a trieda inventára by mohli poskytnúť vynikajúci základ.

Vytvorenie setup.py súboru

Centrálna súčasť tvojho balíčka je súbor setup.py. Tu definuješ všetky potrebné projektové informácie, ktoré sú potrebné počas inštalačného procesu.

V tejto súbore importuješ potrebné moduly a uvádzaš základné podrobnosti o svojom balíčku, vrátane názvu, autora, e-mailu, verzii a webovej stránky.

Uvádzanie potrebných balíčkov

Musíš sa uistiť, že všetky závislosti tvojho balíčka sú uvedené. To sa deje v súbore setup.py, kde pridáš zoznam balíčkov, ktoré majú byť dodávané spolu s tvojím balíčkom.

Pridaj sem všetky potrebné podbalíčky, napríklad základnú triedu a špecifické rozšírené triedy.

Vytvorenie manifestového súboru

Aby si zabezpečil, že všetky relevantné non-Python súbory sú zahrnuté do tvojho balíčka, vytvor manifestový súbor. Tento súbor uvedie všetky súbory, ktoré majú byť pri paketovaní zohľadnené.

V tomto súbore určuješ, aké typy súborov majú byť zahrnuté do balíčka, ako aj adresáre, ako napríklad dokumentácia.

Terminálové príkazy na vytvorenie distribúcie

Teraz je čas vytvoriť balíček. Otvor svoj terminál a naviguj do adresára svojho súboru setup.py. Tu môžeš spustiť príkaz na vytvorenie balíka.

Kontrola vytvorených súborov

Po vytvorení distribúcie by si mal nájsť adresár s názvom dist, ktorý obsahuje zabalený balíček.

Teraz môžeš tento súbor zdieľať alebo nainštalovať.

Inštalácia balíčka

Ak chceš zabezpečiť, že balíček funguje správne, môžeš ho sám znova nainštalovať. Na to rozbaľ adresár a znovu spusti súbor setup.py.

Pre používateľov, ktorí nemajú administrátorské práva, môžeš vykonať príkaz na inštaláciu pre aktuálneho používateľa:

python setup.py install --user

Distribúcia pre používateľov

Ak chceš svoj balíček distribuovať, uisti sa, že všetky súbory ako README.md, licencia a setup.py sú pribalené. To zabezpečí, že balíček môže byť nainštalovaný správne, akonáhle ho používateľ stiahne.

Tu je tvoj balíček pripravený na súborovom systéme a môže byť zdieľaný s ostatnými.

Zhrnutie – Správne zabaliť svoje Python balíčky

Teraz si sa naučil, ako vytvoriť komplexnú štruktúru pre svoje Python balíčky a úspešne generovať distribúciu, ktorú môžeš jednoducho distribuovať. Od vytvorenia adresárovej štruktúry až po inštaláciu používateľom si prešiel všetkými krokmi, aby si efektívne distribuoval svoj vlastný balíček.