New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

guide: add example to install from git branch or tag #2685

Closed
glensc opened this Issue Aug 1, 2018 · 9 comments

Comments

Projects
None yet
4 participants
@glensc

glensc commented Aug 1, 2018

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

This comment has been minimized.

Member

techalchemy commented Aug 2, 2018

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/repo.git@1.0.0#egg=project_name

@glensc

This comment has been minimized.

glensc commented Aug 2, 2018

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

This comment has been minimized.

glensc commented Aug 2, 2018

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

@techalchemy

This comment has been minimized.

Member

techalchemy commented Aug 2, 2018

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

@akefeli

This comment has been minimized.

akefeli commented Aug 3, 2018

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 git@github.com:some/repo.git#egg=foo&subdirectory=python
This works:
pipenv install -e git@github.com:some/repo.git#egg=foo\&subdirectory=python

@glensc

This comment has been minimized.

glensc commented Aug 3, 2018

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

pipenv install -e "git@github.com:some/repo.git#egg=foo&subdirectory=python"
pipenv install -e 'git@github.com:some/repo.git#egg=foo&subdirectory=python'
pipenv install -e git@github.com:some/repo.git#egg=foo\&subdirectory=python

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

@akefeli

This comment has been minimized.

akefeli commented Aug 3, 2018

@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

This comment has been minimized.

Member

techalchemy commented Aug 17, 2018

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

This comment has been minimized.

glensc commented Aug 17, 2018

#2702 is excellent, exactly what was missing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment