guide: add example to install from git branch or tag

[glensc]

Is your feature request related to a problem? Please describe.

https://realpython.com/pipenv-guide/#example-usage

please add here example how to add package from git branch "develop" or tag "1.0.0". it is not obvious for persons who started to use pipenv and not familiar with python ecosystem.

[techalchemy]

We don't control that website, unfortunately, but if it's not become clear to you yet you can do this from the command line with pipenv install -e git+https://github.com/user/[email protected]#egg=project_name

[glensc]

appending @1.0.0 is not self-obvious. that's why example needed.

i tried &ref=develop, but eventually just used vim on Pipfile to specify ref.

[glensc]

such examples could be present in this project README.md as well.

[techalchemy]

Yeah that is why we left this issue opened. We can’t control what other websites write in their user guides.

[akefeli]

Also it took me a while to figure out you needed to escape & in the url for subdirectory.
This doesn't work:
pipenv install -e [email protected]:some/repo.git#egg=foo&subdirectory=python
This works:
pipenv install -e [email protected]:some/repo.git#egg=foo\&subdirectory=python

[glensc]

you need to escape & for shell. so these are equivalent:

pipenv install -e "[email protected]:some/repo.git#egg=foo&subdirectory=python"
pipenv install -e '[email protected]:some/repo.git#egg=foo&subdirectory=python'
pipenv install -e [email protected]:some/repo.git#egg=foo\&subdirectory=python

https://www.tldp.org/LDP/abs/html/special-chars.html

[akefeli]

@glensc you are right, for some reason I thought same command was working with pip but not with pipenv, I must be using quotes with pip

[techalchemy]

I think we are all set on this front now (merged #2702) -- thanks for opening the issue and thanks for the helpful back and forth all!

[glensc]

#2702 is excellent, exactly what was missing!

[kushan-gunasekera]

This is how I solved it,

pipenv install -e git+https://github.com/some_user/some_package.git#egg=some_package

[ghost]

How to checkout a tag and install from https://github.com/ccxt/ccxt. Also it is a js/php/py repo with python subfolder?
like pipenv install tagfoo in subfolder python which has setup.py

[coltonbh]

If you want to install via ssh (say, for a private repo), you'll need to modify the GitHub ssh url as follows:

    [email protected]:coltonbh/my-package.git (fetch)
                  ^ change this to a '/' character

Correct:
[email protected]/coltonbh/my-package.git (fetch)

And the install looks like:

pipenv install -e "git+ssh://[email protected]/coltonbh/my-package.git@branch123#egg=mypgk"

Otherwise you'll get a very long install process followed by the cryptic error:

pipenv.patched.notpip._internal.exceptions.InstallationError: Command "git clone -q ssh://[email protected]:coltonbh/my-package.git /var/folders/w2/rkn1bm3d3ndclys0f81clbfw0000gn/T/requirementslib5mkvyj4m/mypgk" failed with error code 128 in None