Рубрики
Без рубрики

Как разместить пакет Python на PyPI с помощью GitHub

Вот пошаговое руководство по публикации пакета Python на PyPI с помощью GitHub

Автор оригинала: Arpit Bhayani.

PyPI-это официальный индекс пакетов Python. Как только вы опубликуете его на PyPI, его можно загрузить с помощью простой команды pip install . Жизнь становится проще с этой одной строкой.

1: Создание учетных записей

Чтобы отправить свой пакет на PyPI, вам необходимо иметь несколько учетных записей на веб-сайте PyPI. Эти учетные записи позволят вам поддерживать ваши пакеты и предоставят вам интерфейс для редактирования вашего пакета.

Создайте свою учетную запись на следующих сайтах:

2: Файл .pypirc

Теперь создайте файл в своей домашней папке с именем .pypirc , который будет вашим файлом конфигурации , содержащим информацию об аутентификации ваших учетных записей PyPI.

Создайте файл .pypirc и поместите содержимое, показанное ниже

vim ~/.pypirc

.pypirc содержимое файла

[distutils]
index-servers =
  pypi
  pypitest

[pypi]
repository: https://pypi.python.org/pypi
username: YOUR_USERNAME_HERE
password: YOUR_PASSWORD_HERE

[pypitest]
repository: https://testpypi.python.org/pypi
username: YOUR_USERNAME_HERE
password: YOUR_PASSWORD_HERE

Вы должны заменить YOUR_USERNAME_HERE и YOUR_PASSWORD_HERE своим именем пользователя и паролем с сайтов PyPI, которые вы только что создали.

3: Структура каталогов пакетов Python

  • source_dir – это корневой каталог, содержащий ваш пакет python
  • my_python_package это ваш основной пакет python, который вы хотите опубликовать
source_dir/                 # the source directory
|-- my_python_package       # your package
|   |-- __init__.py
|   `-- FILES ....          # your package files
|-- README.md
|-- setup.cfg
|-- setup.py

Настройте структуру каталогов, как показано выше, с соответствующими изменениями и разместите ее на github.com .

4: Отпустите на GitHub и получите ссылку для загрузки

Этот шаг включает в себя выпуск вашего пакета на GitHub. Это создаст ссылку для загрузки вашего полного источника. Для того, чтобы выпустить свой проект GitHub, вам необходимо выполнить следующие шаги:

  1. Перейдите на домашнюю страницу вашего проекта на GitHub
  2. Сверху вы увидите ссылку Release/|. Нажмите на него. Нажмите на
  3. Проект нового выпуска Заполните все детали
  4. Тег version
    • должен быть номером версии вашего выпуска пакета Название релиза
    • может быть любым, каким вы захотите. Нажмите кнопку
  5. Опубликовать выпуск в нижней части страницы Теперь в разделе
  6. Релизы вы можете просмотреть все свои релизы. Скопируйте ссылку для загрузки (tar.gz) и сохраните его где-нибудь.

5: Редактирование файлов

Откройте setup.py файл и добавить в него следующий скелет

from distutils.core import setup

setup(
    name = 'my_python_package',
    packages = ['my_python_package'],
    version = 'version number',  # Ideally should be same as your GitHub release tag varsion
    description = 'description',
    author = '',
    author_email = '',
    url = 'github package source url',
    download_url = 'download link you saved',
    keywords = ['tag1', 'tag2'],
    classifiers = [],
)

Откройте файл setup.cfg и добавьте в него следующий скелет

[metadata]
description-file = README.md

Теперь перенесите все на GitHub.

6: Опубликуйте пакет

Выполните следующие команды

python setup.py register -r pypitest

Эта команда попытается зарегистрировать ваш пакет на тестовом сервере PyPI. Это гарантирует, что все, что у вас настроено, правильно.

python setup.py sdist upload -r pypitest

Эта команда загрузит ваш пакет в репозиторий тестов, и теперь вы должны увидеть свой пакет в тесте PyPI

Теперь вы готовы опубликовать свой пакет на сервере PyPI Live! Выполните следующие команды

python setup.py register -r pypi
python setup.py sdist upload -r pypi

Поздравляю! Вы только что опубликовали свой пакет python на PyPI

Ссылка: Официальная документация

Читайте ещё по теме: