Як опублікувати пакети Python у PyPI за допомогою Poetry на Ubuntu 22.04

Автор

Вступні відомості

PyPI, або Python Package Index, є офіційним сховищем для Python-пакетів. Воно налічує понад 300 тисяч різноманітних пакетів, які використовуються для широкого спектра задач: від обробки даних до створення веб-додатків. Якщо ви створили Python-пакет, який може бути корисним іншим розробникам, ви можете опублікувати його на PyPI. Це зробить ваш пакет доступним для всієї Python-спільноти.

Poetry — це інструмент для керування Python-пакетами, що полегшує процеси розробки, управління залежностями та публікації. Він надає єдиний інтерфейс для роботи з залежностями, створення пакунків та їхнього завантаження на PyPI.

У цьому керівництві ми розглянемо процес публікації Python-пакета на PyPI з використанням Poetry на Ubuntu 22.04. Ми крок за кроком пройдемо через усі етапи: від розробки до публікації пакета.

Встановлення Poetry

Перед тим, як почати, переконайтеся, що Poetry вже встановлено на вашій системі. Якщо ні, ви можете встановити його, виконавши наступну команду у терміналі:

curl -sSL https://install.python-poetry.org | python3 -

Щоб перевірити встановлену версію Poetry, введіть:

poetry --version

Створення Python-пакета

1. Створення нового каталогу:

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

mkdir my_package
cd my_package

2. Ініціалізація Poetry:

В існуючому каталозі ініціалізуйте новий проект Poetry, використовуючи:

poetry init

3. Створення файлу __init__.py:

Створіть файл __init__.py в каталозі my_package і додайте до нього наступний код:

# my_package/__init__.py

Цей файл необхідний для ідентифікації каталогу my_package як Python-пакета.

4. Створення модуля:

У каталозі вашого пакета створіть новий Python-модуль. Наприклад:

touch my_module.py

5. Написання коду:

Додайте потрібний код до файлу my_module.py. Наприклад:

# my_module.py
def hello_world():
    print("Привіт, світ!")

6. Оновлення pyproject.toml:

Відкрийте файл pyproject.toml та внесіть зміни, вказавши необхідні залежності та метадані вашого пакета:

[tool.poetry]
name = "my_package"
version = "1.0.0"
description = "Мій чудовий Python-пакет"
authors = ["Ваше Ім'я <[email protected]>"]

[tool.poetry.dependencies]
python = "^3.8"

Побудова пакета

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

1. Створення дистрибутиву:

Виконайте команду для створення дистрибутиву вашого пакета:

poetry build

2. Перегляд дистрибутиву:

Згенерований дистрибутив можна знайти в каталозі dist/. Він буде мати назву, що відповідає імені та версії вашого пакета.

Публікація пакета на PyPI

Для публікації пакета на PyPI вам потрібен обліковий запис на сайті PyPI.

1. Реєстрація на PyPI:

Перейдіть на сайт PyPI та зареєструйте новий обліковий запис.

2. Отримання API-ключа:

Після реєстрації отримайте свій API-ключ, перейшовши в розділ “API”.

3. Налаштування Poetry:

Відредагуйте pyproject.toml, додавши інформацію про ваш API-ключ PyPI:

[tool.poetry.credentials]
pypi = "ваш-api-ключ-pypi"

4. Публікація пакета:

Опублікуйте ваш пакет на PyPI за допомогою наступної команди:

poetry publish

5. Перевірка публікації:

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

Висновок

У цьому керівництві ми розглянули процес публікації Python-пакета на PyPI з використанням Poetry на Ubuntu 22.04. Завдяки публікації на PyPI, ви можете поділитися своїми розробками з Python-спільнотою, зробивши їх доступними для інших.

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

Крім того, публікація пакету на PyPI сприяє підвищенню вашого авторитету в Python-спільноті та є чудовим способом продемонструвати свої навички.

Поширені питання

1. Що таке PyPI?

Відповідь: PyPI (Python Package Index) — це офіційний репозиторій, де розміщуються Python-пакети.

2. Що таке Poetry?

Відповідь: Poetry — це інструмент для керування пакетами Python, який спрощує процеси розробки, управління та публікації пакетів.

3. Чи можна опублікувати пакет на PyPI без Poetry?

Відповідь: Так, можна. Це можна зробити вручну, використовуючи команду python setup.py sdist upload.

4. Як оновити вже опублікований пакет?

Відповідь: Оновіть пакет локально, збільште номер версії та опублікуйте його знову, використовуючи poetry publish.

5. Як видалити пакет з PyPI?

Відповідь: Щоб видалити пакет з PyPI, зв’яжіться зі службою підтримки PyPI.

6. Що таке файл pyproject.toml?

Відповідь: pyproject.toml — це конфігураційний файл, який Poetry використовує для зберігання метаданих пакета, його залежностей та інших параметрів.

7. Як перевірити, чи є мій пакет доступним на PyPI?

Відповідь: Відвідайте веб-сайт PyPI та пошукайте ваш пакет за його назвою.

8. Які переваги публікації пакета на PyPI?

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