Est-il possible d'utiliser pip pour installer un paquet à partir d'un dépôt GitHub privé ?

Question

J'essaie d'installer un paquet Python à partir d'un dépôt GitHub privé. Pour un dépôt public, je peux utiliser la commande suivante qui fonctionne bien :

pip install git+git://github.com/django/django.git

Cependant, si j'essaie ceci pour un dépôt privé :

pip install git+git://github.com/echweb/echweb-utils.git

J'obtiens le résultat suivant :

Downloading/unpacking git+git://github.com/echweb/echweb-utils.git
Cloning Git repository git://github.com/echweb/echweb-utils.git to /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-VRsIoo-build
Complete output from command /usr/local/bin/git clone git://github.com/echweb/echweb-utils.git /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-VRsIoo-build:
fatal: The remote end hung up unexpectedly

Cloning into /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-VRsIoo-build...

----------------------------------------
Command /usr/local/bin/git clone git://github.com/echweb/echweb-utils.git /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-VRsIoo-build failed with error code 128

Je suppose que c'est parce que j'essaie d'accéder à un référentiel privé sans fournir aucune authentification. J'ai donc essayé d'utiliser Git + ssh en espérant que Pip utilise ma clé publique SSH pour s'authentifier :

pip install git+ssh://github.com/echweb/echweb-utils.git

Cela donne le résultat suivant :

Downloading/unpacking git+ssh://github.com/echweb/echweb-utils.git
Cloning Git repository ssh://github.com/echweb/echweb-utils.git to /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-DQB8s4-build
Complete output from command /usr/local/bin/git clone ssh://github.com/echweb/echweb-utils.git /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-DQB8s4-build:
Cloning into /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-DQB8s4-build...

Permission denied (publickey).

fatal: The remote end hung up unexpectedly

----------------------------------------
Command /usr/local/bin/git clone ssh://github.com/echweb/echweb-utils.git /var/folders/cB/cB85g9P7HM4jcPn7nrvWRU+++TI/-Tmp-/pip-DQB8s4-build failed with error code 128

Est-ce que ce que j'essaie de faire est possible ? Si oui, comment puis-je le faire ?

Answer 1

Vous pouvez utiliser le git+ssh URI, mais vous doit définir un nom d'utilisateur. Remarquez le git@ dans l'URI :

pip install git+ssh://git@github.com/echweb/echweb-utils.git

Lisez aussi les clés de déploiement .

PS : Dans mon installation, le schéma URI "git+ssh" ne fonctionne qu'avec les exigences "modifiables" :

pip install -e URI#egg=EggName

Souvenez-vous de : Modifier le : caractère qui git remote -v imprime dans un / avant d'utiliser l'adresse de la télécommande dans le champ pip commandement :

$ git remote -v
origin  git@github.com:echweb/echweb-utils.git (fetch)
#                     ^ change this to a '/' character

Si vous oubliez, vous obtiendrez cette erreur :

ssh: Could not resolve hostname github.com:echweb:
         nodename nor servname provided, or not known

Answer 2

Comme technique supplémentaire, si vous avez le référentiel privé cloné localement, vous pouvez le faire :

pip install git+file://c:/repo/directory

De manière plus moderne, vous pouvez simplement faire cela (et la fonction -e signifie que vous n'avez pas à valider les modifications avant qu'elles ne soient prises en compte) :

pip install -e C:\repo\directory

Answer 3

Vous pouvez le faire directement avec l'URL HTTPS comme ceci :

pip install git+https://github.com/username/repo.git

Cela fonctionne également en ajoutant simplement cette ligne dans le fichier requirements.txt dans un fichier de type Django par exemple.

Answer 4

Il fonctionne également avec Bitbucket :

pip install git+ssh://git@bitbucket.org/username/projectname.git

Pip utilisera vos clés SSH dans ce cas.

Answer 5

La syntaxe du fichier d'exigences est donnée ici :

https://pip.pypa.io/en/latest/reference/pip_install.html#requirements-file-format

Donc, par exemple, utilisez :

-e git+http://github.com/rwillmer/django-behave#egg=django-behave

si vous voulez que la source reste en place après l'installation.

Ou juste

git+http://github.com/rwillmer/django-behave#egg=django-behave

si vous voulez juste qu'il soit installé.