6. Индекс пакетов Python (PyPI)¶The Python Package Index (PyPI)

6.2.1. Команда register¶The register command

Команда distutils register используется для отправки метаданных вашего дистрибутива на сервер индекса. Она вызывается следующим образом:

python setup.py register

Distutils ответит следующим приглашением:

running register
We need to know who you are, so please choose either:
    1. use your existing login,
    2. register as a new user,
    3. have the server generate a new password for you (and email it to you), or
    4. quit
Your selection [default 1]:

Примечание: если ваше имя пользователя и пароль сохранены локально, вы не увидите это меню. Также обратитесь к .pypirc-файл, чтобы узнать, как хранить свои учётные данные в файле .pypirc.

Если вы ещё не зарегистрированы в PyPI, вам необходимо сделать это сейчас. Следует выбрать вариант 2 и ввести свои данные по запросу. Вскоре после отправки данных вы получите электронное письмо, которое будет использовано для подтверждения регистрации.

После регистрации вы можете выбрать вариант 1 из меню. Вас попросят ввести имя пользователя и пароль PyPI, а затем register отправит ваши метаданные в индекс.

См. Дополнительные параметры команды для параметров команды register.

6.2.2. Команда upload¶The upload command

Команда distutils upload отправляет файлы дистрибутивов в PyPI.

Команда вызывается сразу после сборки одного или нескольких файлов дистрибутивов. Например, команда

python setup.py sdist bdist_wininst upload

приведёт к загрузке исходного дистрибутива и установщика Windows в PyPI. Обратите внимание, что они будут загружены, даже если были собраны с помощью более раннего вызова setup.py, но будут загружены только те дистрибутивы, которые указаны в командной строке для вызова, включающего команду upload.

Если команда register была ранее вызвана в той же команде, и пароль был введён в приглашении, upload повторно использует введённый пароль. Это полезно, если вы не хотите хранить пароль в открытом виде в файле .pypirc.

Вы можете использовать параметр --sign, чтобы указать upload подписывать каждый загруженный файл с помощью GPG (GNU Privacy Guard). Программа gpg должна быть доступна для выполнения в системе PATH. Вы также можете указать, какой ключ использовать для подписи, с помощью параметра --identity=name.

См. Дополнительные параметры команды для дополнительных параметров команды upload.

6.2.3. Дополнительные параметры команд¶Additional command options

В этом разделе описаны параметры, общие для команд register и upload.

Параметр --repository или -r позволяет указать сервер PyPI, отличный от сервера по умолчанию. Например:

python setup.py sdist bdist_wininst upload -r https://example.com/pypi

Для удобства вместо URL можно использовать имя, если файл .pypirc настроен соответствующим образом. Например:

python setup.py register -r other

См. .pypirc-файл для получения дополнительной информации об определении альтернативных серверов.

Параметр --show-response отображает полный текст ответа от сервера PyPI, что полезно при отладке проблем с регистрацией и загрузкой.

6.2.4. Файл .pypirc¶The .pypirc file

Команды register и upload обе проверяют наличие файла .pypirc по пути $HOME/.pypirc. Если такой файл существует, команда использует имя пользователя, пароль и URL репозитория, указанные в нём. Формат файла .pypirc выглядит так:

[distutils]
index-servers =
    pypi

[pypi]
repository: <repository-url>
username: <username>
password: <password>

В разделе distutils определяется переменная index-servers, в которой перечисляются имена всех разделов, описывающих репозиторий.

Каждый раздел, описывающий репозиторий, задаёт три переменные:

• repository – задаёт URL сервера PyPI. По умолчанию

  https://upload.pypi.org/legacy/.

• username – зарегистрированное имя пользователя на сервере PyPI.

• password – пароль для аутентификации. Если опущен, пользователю

  будет предложено ввести его при необходимости.

Если требуется определить другой сервер, можно создать новый раздел и указать его в переменной index-servers:

[distutils]
index-servers =
    pypi
    other

[pypi]
repository: <repository-url>
username: <username>
password: <password>

[other]
repository: https://example.com/pypi
username: <username>
password: <password>

Это позволяет вызывать команды register и upload с параметром --repository, как описано в разделе Дополнительные параметры команд.

В частности, можно добавить PyPI Test Repository в ваш .pypirc, чтобы облегчить тестирование перед первой загрузкой на сам PyPI.