Vytvořte a rozdělte svůj vlastní Python balíček

Vše začíná otázkou, jak můžeš vytvářet a efektivně distribuovat své vlastní Python-balíčky. V této příručce ti ukážu, jak postupovat krok za krokem, abys vytvořil balíček, který můžeš poskytnout ostatním. Je nezbytné vytvořit správné soubory a zajistit správnou strukturu. To ostatním umožní snadno nainstalovat a používat tvůj balíček. Pojďme se hned pustit do zkoumání základů distribuce balíčků.

Hlavní poznatky

1. Vytvoř soubor setup.py, který obsahuje všechny metadata tvého balíčku.
2. Přidej manifestový soubor, který uvádí všechny ne-Python soubory.
3. Použij správný příkaz v terminálu pro vytvoření své distribuce.
4. Dezabaleno je možné snadno předat k instalaci.

Návod krok za krokem

Existuje několik rozhodujících kroků, které musíš dodržet, abys vytvořil svůj vlastní Python balíček. Následující je podrobný návod s obrázky, který ti ukáže cestu k vlastní distribuci balíčku.

Vytvoření adresářové struktury

Nejprve bys měl připravit správnou adresářovou strukturu pro svůj balíček. Vytvoř hlavní adresář, který obsahuje všechny soubory a podadresáře, včetně zdrojového kódu, dokumentace a licenčních informací.

V tomto příkladu připravuji jednoduchou strukturu s README.md souborem a licenčním souborem. Můžeš použít licenci GPL, abys určil práva na svůj balíček.

Definování struktury API

Aby byl tvůj balíček užitečný, potřebuješ alespoň dokumentaci API a základní třídu, ze které mohou dědit ostatní třídy. Tato struktura pomáhá umožnit rozšíření a přizpůsobení tvého balíčku.

Jednoduchá třída API a třída inventáře by mohla být skvělým začátkem.

Vytvoření souboru setup.py

Centrální součástí tvého balíčku je soubor setup.py. Zde definuješ všechny potřebné informace o projektu, které jsou potřeba během procesu instalace.

V tomto souboru importuješ potřebné moduly a uvádíš základní detaily o svém balíčku, včetně názvu, autora, e-mailu, čísla verze a webové stránky.

Uvedení potřebných balíčků

Měl bys zajistit, že všechny závislosti tvého balíčku budou uvedeny. To se provádí v souboru setup.py přidáním seznamu balíčků, které by měly být dodávány s tvým balíčkem.

Přidej zde všechny potřebné podbalíčky, například základní třídu a specifické rozsáhlé třídy.

Vytvoření manifestového souboru

Abychom zajistili, že všechny relevantní non-Python soubory jsou zahrnuty do tvého balíčku, vytvoř manifestový soubor. Tento soubor uvádí všechny soubory, které by měly být zohledněny při balení.

V tomto souboru uvedeš, jaké typy souborů by měly být zahrnuty do balíčku, a také adresáře, jako je například dokumentace.

Příkazy terminálu pro vytvoření distribuce

Teď je čas vytvořit balíček. Otevři svůj terminál a přejdi do adresáře tvého souboru setup.py. Zde můžeš spustit příkaz pro vytvoření balíčku.

Kontrola vytvořených souborů

Po vytvoření distribuce bys měl najít adresář s názvem dist, který obsahuje zabalený balíček.

Nyní můžeš tento soubor předat nebo nainstalovat.

Instalace balíčku

Abychom zajistili, že balíček funguje správně, můžeš ho znovu nainstalovat. K tomu rozbalíš adresář a znovu spustíš soubor setup.py.

Pro uživatele, kteří nemají administrátorská práva, můžeš provést příkaz k instalaci pro aktuálního uživatele:

python setup.py install --user

Distribuce pro uživatele

Pokud chceš svůj balíček distribuovat, ujisti se, že všechny soubory jako README.md, licence a soubor setup.py jsou přiloženy. To zajistí, že balíček může být správně nainstalován, jakmile si ho uživatel stáhne.

Zde je tvůj balíček připraven na souborovém systému a může být předán ostatním.

Shrnutí – Správně zabal své Python balíčky

Naučil jsi se, jak vytvořit komplexní strukturu pro své Python balíčky a úspěšně generovat distribuci, kterou můžeš snadno šířit. Od vytvoření adresářové struktury až po instalaci uživateli jsi prošel všemi kroky, abys efektivně distribuoval svůj vlastní balíček.