We'd like to use pip with github to install private packages to our production servers. This question concerns what needs to be in the github repo in order for the install to be successful.
Assuming the following command line (which authenticates just fine and tries to install):
pip install git+ssh://git@github.com/BlahCo/search/tree/prod_release_branch/ProductName
What needs to reside in the ProductName? Is it the contents of what would normally be in the tar file after running setup.py with the sdist option, or is the actual tar.gz file, or something else?
I'm asking here because I've tried several variations and can't make it work. Any help appreciated.
You need the whole python package, with a setup.py
file in it.
A package named foo
would be:
foo # the installable package
├── foo
│ ├── __init__.py
│ └── bar.py
└── setup.py
And install from github like:
$ pip install git+ssh://git@github.com/myuser/foo.git
or
$ pip install git+https://github.com/myuser/foo.git@v123
or
$ pip install git+https://github.com/myuser/foo.git@newbranch
More info at https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support
I had similar issue when I had to install from github repo, but did not want to install git , etc.
The simple way to do it is using zip archive of the package. Add /zipball/master
to the repo URL:
$ pip install https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
Downloading/unpacking https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
Downloading master
Running setup.py egg_info for package from https://github.com/hmarr/django-debug-toolbar-mongo/zipball/master
Installing collected packages: django-debug-toolbar-mongo
Running setup.py install for django-debug-toolbar-mongo
Successfully installed django-debug-toolbar-mongo
Cleaning up...
This way you will make pip work with github source repositories.
If you want to use requirements.txt
file, you will need git
and something like the entry below to anonymously fetch the master branch in your requirements.txt
.
For regular install:
git+git://github.com/celery/django-celery.git
For "editable" install:
-e git://github.com/celery/django-celery.git#egg=django-celery
Editable mode downloads the project's source code into ./src
in the current directory. It allows pip freeze
to output the correct github location of the package.
#egg=django-celery
? Is that a placeholder?
git+git://github.com
wouldn't work on Windows (pip had a failure when cloning) but git+https://github.com
worked.
Clone target repository same way like you cloning any other project:
git clone git@github.com:myuser/foo.git
Then install it in develop mode:
cd foo
pip install -e .
You can change anything you wan't and every code using foo
package will use modified code.
There 2 benefits ot this solution:
You can install package in your home projects directory. Package includes .git dir, so it's regular Git repository. You can push to your fork right away.
pip
, so I cloned the pip
repository, created a virtualenv, activated it, and did pip install -e .
. Then the pip
in the virtualenv was in development mode! I'm impressed that this works even with the package manager itself.
pip list
, the package in question has references to the Git branch and absolute path from which it was installed. Does it keep any references to those or can the source be deleted?
Here is the simple solution
With git
pip install git+https://github.com/jkbr/httpie.git
Without git
pip install https://github.com/jkbr/httpie/tarball/master
or
pip install https://github.com/jkbr/httpie/zipball/master
or
pip install https://github.com/jkbr/httpie/archive/master.zip
Note: You need a python package with the setup.py file in it.
you can try this way in Colab
!git clone https://github.com/UKPLab/sentence-transformers.git
!pip install -e /content/sentence-transformers
import sentence_transformers
Below format could be use to install python
libraries via pip
from GitHub
.
pip install <LibName>@git+ssh://git@github.com/<username>/<LibName>#egg<LibName>
Tested Optimized Ubuntu Solution using the terminal command:
Step 1: In a selected directory clone the git repo.
Example:
$ git clone https://github.com/httpie/httpie.git
Step 2: select/change path to the directory, to the cloned folder
$ cd ClonedFolderName
Step 3: Enter following command to install that package
ColnedFolderName(directory Name) $ pip install ./
pip install ./ is command to enter in cloned directory name
Note: Make sure setup.py is inside cloned repo. (which is by default in it)
Success story sharing
-e
option (editable mode) to pip?pip install git+https://github.com/pypa/pip.git
Source: pip Github repo