Python Package Index (PyPI) je úložiště softwaru pro programovací jazyk Python, které umožňuje uživatelům najít a nainstalovat softwarové balíčky vyvinuté třetími stranami. Publikování vlastního balíčku na PyPI může být skvělým způsobem, jak sdílet váš projekt s širší Python komunitou. Níže naleznete krok za krokem návod, jak svůj balíček publikovat.
Příprava vašeho balíčku
Před publikací na PyPI je důležité, aby byl váš balíček správně připraven. Zde jsou klíčové kroky:
-
Ujistěte se, že váš balíček má strukturu vhodnou pro PyPI. To zahrnuje mít soubory setup.py, README.md, a LICENSE. Soubor setup.py je zásadní, protože obsahuje informace potřebné k distribuci vašeho balíčku, včetně názvu, verze a závislostí.
-
Použijte sémantické verzování. Sémantické verzování je systém, který se používá k označení verzí softwaru v rámci tří čísel: hlavní, vedlejší a opravná verze. Tento systém usnadňuje správu verzí a závislostí.
-
Vytvořte soubor README.md. Soubor README by měl obsahovat úvod do vašeho balíčku, instrukce pro instalaci a příklady použití. Dobrý README pomáhá uživatelům pochopit, co váš balíček dělá a jak ho používat.
-
Zahrňte licenci. Vyberte open-source licenci, která nejlépe vyhovuje vašemu projektu, a zahrňte ji do souboru LICENSE ve vašem projektu. To jasně definuje, jak mohou ostatní používat váš kód.
Registrace na PyPI
Před publikováním vašeho balíčku se musíte zaregistrovat na PyPI. To lze provést na oficiálních webových stránkách PyPI. Zde si vytvoříte účet, který budete používat k nahrávání vašich balíčků.
Publikování balíčku
Po přípravě a registraci můžete svůj balíček publikovat následujícími kroky:
- Instalace nástrojů potřebných pro publikaci. Budete potřebovat
setuptools a wheel pro sestavení balíčku a twine pro jeho nahrání na PyPI. Tyto nástroje můžete nainstalovat pomocí pip:
pip install setuptools wheel twine
- Sestavte váš balíček. V adresáři vašeho projektu spusťte:
pip install setuptools wheel twine
Tento příkaz vytvoří distribuční archivy ve složce dist.
- Nahrajte balíček na PyPI pomocí Twine.
twine upload dist/*
Twine požádá o vaše přihlašovací údaje k PyPI, které jste vytvořili během registrace.
