Этот материал взят из нашей email-рассылки, посвященной Python. Подпишитесь, чтобы быть в числе первых, кто получит дайджест.
Майк Дрисколл, известный популяризатор Python, написал подробный гайд по публикации пакетов в репозитории PyPI. Последовательность шагов вкратце выглядит так:
Создание структуры пакета
- Создайте папку src, внутри которой разместите вашу основную директорию. В эту директорию поместите __init__.py – он может быть пустым, поскольку этот файл просто дает Python понять, что папка является пакетом, который можно импортировать.
- Затем поместите в папку все файлы проекта.
- Добавьте файл лицензии, pyproject.toml, README.md и папку tests.
Выбор системы сборки
В файле pyproject.toml укажите систему сборки (например, Hatchling, setuptools, Flit, PDM).
Настройка метаданных
В pyproject.toml добавьте информацию о пакете – название, версию, авторов, описание, поддерживаемые версии Python, классификаторы и URL-адреса.
🐍 Библиотека питониста
Больше полезных материалов вы найдете на нашем телеграм-канале «Библиотека питониста»
🐍🎓 Библиотека собеса по Python
Подтянуть свои знания по Python вы можете на нашем телеграм-канале «Библиотека собеса по Python»
🐍🧩 Библиотека задач по Python
Интересные задачи по Python для практики можно найти на нашем телеграм-канале «Библиотека задач по Python»
Подготовка README и лицензии
- Создайте подробный README.md с инструкциями по установке, примерами использования и другой важной информацией.
- Выберите подходящую лицензию для вашего пакета.
Генерация пакета
- Установите build:
python3 -m pip install --upgrade build - Запустите сборку:
python3 -m build - После завершения в папке dist появятся файлы .whl и .tar.gz
Загрузка на PyPI
- Зарегистрируйтесь на TestPyPI (https://test.pypi.org)
- Создайте API-токен в настройках аккаунта
- Установите twine:
python3 -m pip install --upgrade twine - Загрузите пакет на TestPyPI:
python3 -m twine upload --repository testpypi dist/* - Проверьте установку пакета с TestPyPI
Публикация на основном PyPI
- Зарегистрируйтесь на PyPI (https://pypi.org)
- Создайте API-токен
- Загрузите пакет:
python -m twine upload dist/* - Проверьте установку с основного PyPI
Важные моменты для успешной публикации
- Выберите уникальное имя для пакета.
- Тщательно подготовьте документацию и README.
- Обязательно протестируйте пакет на TestPyPI перед публикацией на основном PyPI.
- Убедитесь, что ваш пакет совместим с заявленными версиями Python.
***
Комментарии