Як створити та опублікувати пакет Python

Створення та публікація пакета Python дає змогу поділитися своїм кодом із ширшою спільнотою Python. У цьому посібнику ми розповімо про кроки, щоб створити пакет Python і опублікувати його в індексі пакетів Python (PyPI), де інші зможуть легко його встановити та використовувати.

Налаштування вашого проекту

Перш ніж почати, переконайтеся, що у вашій системі встановлено Python. Вам також потрібно буде інсталювати пакети setuptools і wheel, якщо ви цього ще не зробили:

pip install setuptools wheel

Створення структури пакета

Створіть новий каталог для вашого пакетного проекту. Усередині цього каталогу створіть таку структуру:

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

Ось короткий огляд цих файлів:

• your_package/__init__.py: позначає каталог як пакет Python.
• your_package/module1.py і your_package/module2.py: модулі вашого пакета.
• tests/: каталог для тестових випадків вашого пакета.
• setup.py: сценарій збірки для вашого пакета.
• README.md: файл, який пояснює, що робить ваш пакет.
• LICENSE: файл ліцензії вашого пакета.

Написання сценарію налаштування

Файл setup.py необхідний для визначення метаданих і залежностей вашого пакета. Ось базовий приклад:

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='[email protected]',
    license='MIT',
)

Створення файлу README

Файл README.md має містити огляд вашого пакета, зокрема те, як його встановити та використовувати. Ось приклад:

# Your Package

A brief description of your package.

монтаж

pip install your_package

Використання

import your_package

# Example usage

Створення пакету

Перейдіть до каталогу проекту та виконайте таку команду, щоб створити свій пакет:

python setup.py sdist bdist_wheel

Ця команда створює архіви розповсюдження в каталозі dist/.

Публікація в PyPI

Щоб опублікувати свій пакет, вам потрібен обліковий запис на PyPI. Якщо у вас його немає, створіть його за адресою PyPI.

Далі встановіть пакет twine:

pip install twine

Використовуйте twine, щоб завантажити свій пакет на PyPI:

twine upload dist/*

Вам буде запропоновано ввести ім’я користувача та пароль PyPI. Після успішного завантаження ваш пакет буде доступний на PyPI.

Висновок

Щиро вітаю! Тепер ви створили та опублікували свій пакет Python. Інші можуть встановити його за допомогою pip, а ви можете продовжувати його оновлювати та покращувати. Не забувайте підтримувати свій пакет, оновлюючи номер версії та завантажуючи нові випуски під час внесення змін.