🐍📦 Ваш код достоин PyPI: как правильно опубликовать Python-пакет

Краткая инструкция по публикации Python-пакетов на PyPI. Узнайте, как структурировать проект, настроить метаданные и загрузить свой пакет в репозиторий.

Этот материал взят из нашей email-рассылки, посвященной Python. Подпишитесь, чтобы быть в числе первых, кто получит дайджест.

📧 Подписаться

(function () { let link = document .getElementById ("15b7bade-59ea-4599-9366-a8b8e60d6ba2-https://proglib.io/w/edaee37b-2"); if (! link) return; let href = link .getAttribute ("href"); if (! href) return; let prefix = link .dataset .prefix; let action = link .dataset .action; link .addEventListener ("click", function (e) { let data = new FormData (); data .append ("url", href); apiFetch (action, { method: "POST", body: data }) .then (function (res) {}) .catch (function (err) { console .error (err); }); }) })();

Майк Дрисколл, известный популяризатор Python, написал подробный гайд по публикации пакетов в репозитории PyPI. Последовательность шагов вкратце выглядит так:

Создание структуры пакета

1. Создайте папку src, внутри которой разместите вашу основную директорию. В эту директорию поместите __init__.py – он может быть пустым, поскольку этот файл просто дает Python понять, что папка является пакетом, который можно импортировать.
2. Затем поместите в папку все файлы проекта.
3. Добавьте файл лицензии, pyproject.toml, README.md и папку tests.

Выбор системы сборки

В файле pyproject.toml укажите систему сборки (например, Hatchling, setuptools, Flit, PDM).

Настройка метаданных

В pyproject.toml добавьте информацию о пакете – название, версию, авторов, описание, поддерживаемые версии Python, классификаторы и URL-адреса.

Пример заполнения метаданных

🐍 Библиотека питониста

Больше полезных материалов вы найдете на нашем телеграм-канале «Библиотека питониста»

🐍🎓 Библиотека собеса по Python

Подтянуть свои знания по Python вы можете на нашем телеграм-канале «Библиотека собеса по Python»

🐍🧩 Библиотека задач по Python

Интересные задачи по Python для практики можно найти на нашем телеграм-канале «Библиотека задач по Python»

Подготовка README и лицензии

1. Создайте подробный README.md с инструкциями по установке, примерами использования и другой важной информацией.
2. Выберите подходящую лицензию для вашего пакета.

Генерация пакета

1. Установите build: python3 -m pip install --upgrade build
2. Запустите сборку: python3 -m build
3. После завершения в папке dist появятся файлы .whl и .tar.gz

Загрузка на PyPI

1. Зарегистрируйтесь на TestPyPI (https://test.pypi.org)
2. Создайте API-токен в настройках аккаунта
3. Установите twine: python3 -m pip install --upgrade twine
4. Загрузите пакет на TestPyPI: python3 -m twine upload --repository testpypi dist/*
5. Проверьте установку пакета с TestPyPI

Публикация на основном PyPI

1. Зарегистрируйтесь на PyPI (https://pypi.org)
2. Создайте API-токен
3. Загрузите пакет: python -m twine upload dist/*
4. Проверьте установку с основного PyPI

Важные моменты для успешной публикации

1. Выберите уникальное имя для пакета.
2. Тщательно подготовьте документацию и README.
3. Обязательно протестируйте пакет на TestPyPI перед публикацией на основном PyPI.
4. Убедитесь, что ваш пакет совместим с заявленными версиями Python.

***

Статьи по теме

• Как опубликовать свою Python библиотеку на PyPI