Инструменты установки Python: как я могу указать частный репозиторий в install_requires?

Question 1

Я создаю setup.pyфайл для проекта, который зависит от частных репозиториев GitHub. Соответствующие части файла выглядят так:

from setuptools import setup
setup(name='my_project',
    ...,
    install_requires=[
        'public_package',
        'other_public_package',
        'private_repo_1',
        'private_repo_2',
    ],
    dependency_links=[
        'https://github.com/my_account/private_repo_1/master/tarball/',
        'https://github.com/my_account/private_repo_2/master/tarball/',
    ],
    ...,
)

Я использую setuptoolsвместо того , distutilsпотому что последнее не поддерживают install_requiresи dependency_linksаргументы за этот ответ.

Вышеупомянутый установочный файл не может получить доступ к частным репозиториям с ошибкой 404 - чего и следовало ожидать, поскольку GitHub возвращает 404 на неавторизованные запросы для частного репозитория. Однако я не могу понять, как сделать setuptoolsаутентификацию.

Вот несколько вещей, которые я пробовал:

Используйте git+ssh://вместо https://in, dependency_linksкак если бы я устанавливал репо с pip. Это не удается, потому что setuptools не распознает этот протокол («неизвестный тип URL: git + ssh»), хотя в документации по распространению указано, что это необходимо. То же git+httpsи git+http.
https://<username>:<password>@github.com/...- до сих пор получить 404. (Этот метод не работает с curlили wgetиз командной строки либо - хотя curl -u <username> <repo_url> -O <output_file_name>делает работу.)
Обновление setuptools (0.9.7) и virtualenv (1.10) до последних версий. Также попытался установить дистрибутив, хотя в этом обзоре говорится, что он был снова объединен с setuptools. В любом случае, никаких кубиков.

В настоящее время я только что setup.pyраспечатал предупреждение о том, что частные репозитории необходимо загружать отдельно. Это явно далеко не идеально. Я чувствую, что мне не хватает чего-то очевидного, но не могу представить, что это могло быть. :)

Дубликат иш вопрос, без ответа здесь .

Question 2

Я пытался заставить это работать для установки с помощью pip, но вышеуказанное не сработало для меня. Из [1] я понял, что PEP508следует использовать стандарт, из [2] я получил пример, который действительно работает (по крайней мере, для моего случая).

Пожалуйста, обратите внимание; это с pip 20.0.2наPython 3.7.4

setup(
    name='<package>',
...
    install_requires=[
        '<normal_dependency>',
         # Private repository
        '<dependency_name> @ git+ssh://git@github.com/<user>/<repo_name>@<branch>',
         # Public repository
        '<dependency_name> @ git+https://github.com/<user>/<repo_name>@<branch>',
    ],
)

После указания моего пакета установка работает нормально (также с -eнастройками и без необходимости указывать --process-dependency-links).

Ссылки [1] https://github.com/pypa/pip/issues/4187 [2] https://github.com/pypa/pip/issues/5566

Question 3

Вот что у меня сработало:

  install_requires=[
      'private_package_name==1.1',
  ],
  dependency_links=[
      'git+ssh://git@github.com/username/private_repo.git#egg=private_package_name-1.1',
  ]

Обратите внимание, что в названии яйца должен быть номер версии, иначе он скажет, что не может найти пакет.

Question 4

Я не смог найти никакой хорошей документации по этому поводу, но нашел решение в основном методом проб и ошибок. Кроме того, установка из pip и setuptools имеет некоторые тонкие различия; но этот способ должен работать для обоих.

GitHub (в настоящее время, по состоянию на август 2016 года) не предлагает простой способ получить zip / tarball с частными репозиториями. Итак, вам нужно указать setuptools, чтобы сообщить setuptools, что вы указываете на репозиторий git:

from setuptools import setup
import os
# get deploy key from https://help.github.com/articles/git-automation-with-oauth-tokens/
github_token = os.environ['GITHUB_TOKEN']

setup(
    # ...
    install_requires='package',
    dependency_links = [
    'git+https://{github_token}@github.com/user/{package}.git/@{version}#egg={package}-0'
        .format(github_token=github_token, package=package, version=master)
        ]

Пара замечаний здесь:

Для частных репозиториев вам необходимо пройти аутентификацию с помощью GitHub; Самый простой способ, который я нашел, - создать токен oauth, поместить его в свою среду, а затем включить его с URL-адресом
Вы должны включить некоторый номер версии (здесь 0) в конце линии, даже если нет пакета на PyPI. Это должно быть настоящее число, а не слово.
Вам нужно git+указать в начале, чтобы указать setuptools, что он клонирует репо, а не указывает на zip / tarball.
version может быть веткой, тегом или хешем фиксации
Вам необходимо поставить --process-dependency-linksпри установке из pip

Question 5

Я нашел (хакерский) обходной путь:

#!/usr/bin/env python

from setuptools import setup
import os

os.system('pip install git+https://github-private.corp.com/user/repo.git@master')

setup( name='original-name'
     , ...
     , install_requires=['repo'] )

Я понимаю, что есть этические проблемы с использованием системного вызова в сценарии установки, но я не могу придумать другого способа сделать это.

Question 6

Через ответ Тома Хеммеса я обнаружил, что это единственное, что сработало для меня:

    install_requires=[
        '<package> @ https://github.com/<username>/<package>/archive/<branch_name>.zip']

Question 7

Использование URL-адреса архива из github работает для меня для общедоступных репозиториев. Например

dependency_links = [
  'https://github.com/username/reponame/archive/master.zip#egg=eggname-version',
]

Question 8

Изменить: похоже, это работает только с общедоступными репозиториями github, см. Комментарии.

dependency_links=[
    'https://github.com/my_account/private_repo_1/tarball/master#egg=private_repo_1',
    'https://github.com/my_account/private_repo_2/tarball/master#egg=private_repo_2',
],

Вышеупомянутый синтаксис, кажется, работает для меня с setuptools 1.0. На данный момент, по крайней мере, синтаксис добавления "# egg = project_name-version" к зависимостям VCS задокументирован в ссылке, которую вы дали для распространения документации .

Question 9

Это работа для нашего сценария:

пакет находится на github в частном репо
мы хотим установить его в пакеты сайтов (не в ./src с -e)
возможность использовать pip install -r requirements.txt
возможность использовать pip install -e reposdir (или из github), где зависимости указаны только в requirements.txt

https://github.com/pypa/pip/issues/3610#issuecomment-356687173