Jak utworzyć pakiet Pythona i go opublikować

Tworzenie i publikowanie pakietu Python pozwala na udostępnianie kodu szerszej społeczności Python. W tym przewodniku przeprowadzimy Cię przez kroki tworzenia pakietu Python i publikowania go w Python Package Index (PyPI), gdzie inni mogą go łatwo zainstalować i używać.

Konfigurowanie projektu

Zanim zaczniesz, upewnij się, że masz zainstalowanego Pythona w swoim systemie. Będziesz także musiał zainstalować pakiety setuptools i wheel, jeśli jeszcze tego nie zrobiłeś:

pip install setuptools wheel

Tworzenie struktury pakietu

Utwórz nowy katalog dla swojego projektu pakietu. Wewnątrz tego katalogu utwórz następującą strukturę:

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

Oto krótki przegląd tych plików:

• your_package/__init__.py: Oznacza katalog jako pakiet Pythona.
• your_package/module1.py i your_package/module2.py: Moduły Twojego pakietu.
• tests/: Katalog zawierający przypadki testowe Twojego pakietu.
• setup.py: Skrypt kompilacji dla twojego pakietu.
• README.md: Plik objaśniający działanie pakietu.
• LICENSE: Plik licencyjny Twojego pakietu.

Pisanie skryptu instalacyjnego

Plik setup.py jest niezbędny do zdefiniowania metadanych i zależności pakietu. Oto podstawowy przykład:

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

Tworzenie pliku README

Plik README.md powinien zawierać przegląd pakietu, w tym informacje o sposobie jego instalacji i użytkowania. Oto przykład:

# Your Package

A brief description of your package.

Instalacja

pip install your_package

Stosowanie

import your_package

# Example usage

Budowanie pakietu

Przejdź do katalogu swojego projektu i uruchom następujące polecenie, aby zbudować pakiet:

python setup.py sdist bdist_wheel

To polecenie tworzy archiwa dystrybucyjne w katalogu dist/.

Publikowanie w PyPI

Aby opublikować swój pakiet, potrzebujesz konta na PyPI. Jeśli go nie masz, utwórz je na PyPI.

Następnie zainstaluj pakiet twine:

pip install twine

Użyj twine, aby przesłać swój pakiet do PyPI:

twine upload dist/*

Zostaniesz poproszony o podanie nazwy użytkownika i hasła PyPI. Po pomyślnym przesłaniu pakiet będzie dostępny w PyPI.

Wniosek

Gratulacje! Utworzyłeś i opublikowałeś swój pakiet Pythona. Inni mogą go zainstalować za pomocą pip, a Ty możesz go nadal aktualizować i ulepszać. Pamiętaj, aby utrzymywać swój pakiet, aktualizując numer wersji i przesyłając nowe wydania, gdy wprowadzasz zmiany.