Skip to content
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.

Sign up for GitHub

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

Added an example to README.md for installing from git #2702

Merged
merged 4 commits into from
Aug 17, 2018
Merged

Added an example to README.md for installing from git #2702

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9070a6b
Added an example to README.md for installing from git
patchwork-systems Aug 3, 2018
a316294
mend
patchwork-systems Aug 12, 2018
1188a3d
Updated for PR #2702. Added in request from user @uranusjr for pip do…
patchwork-systems Aug 13, 2018
0a680f5
Merge branch 'master' into master
techalchemy Aug 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,15 @@ Install packages:
To activate this project's virtualenv, run the following:
$ pipenv shell

Install from git:

$ pipenv install -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests
Installing -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests…
...
Adding -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests to Pipfile's [packages]...

You can also change the tag/ref (or exclude to get the latest version) by adding @version-or-tag before #egg=project_name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you mind doing a touch of cleanup here and adding a section that describes the syntax including the sections of the url? Suggestion below:

Can you add some syntax highlighting here at the bottom? Then you can end the line with a period.

Installing from git:

You can install packages with pipenv from git and other version control systems using URLs formatted according to the following rule:

```
    <vcs_type>+<scheme>://<location>/<user_or_organizatoin>/<repository>@<branch_or_tag>#<package_name>
```

The only optional section is the `@<branch_or_tag>` section.  When using git over SSH, you may use the shorthand vcs and scheme alias `git+git@<location>:<user_or_organization>/<repository>@<branch_or_tag>#<package_name>`. Note that this is translated to `git+ssh://git@<location>` when parsed.

Valid values for `<vcs_type>` include `git`, `bzr`, `svn`, and `hg`.  Valid values for `<scheme>` include `http,`, `https`, `ssh`, and `file`.  In specific cases you also have access to other schemes: `svn` may be combined with `svn` as a scheme, and `bzr` can be combined with `sftp` and `lp`.

Note that it is **strongly recommended** that you install any version-controlled dependencies in editable mode in order to ensure that dependency resolution can be performed with an up to date copy of the repository each time it is performed, and that it includes all known dependencies.

Below is an example usage which installs the git repository located at `https://github.com/requests/requests.git` from tag `v2.19.1` as package name `requests`:

```console
    $ pipenv install -e git+https://github.com/requests/requests.git@v2.19#egg=requests
    Creating a Pipfile for this project...
    Installing -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests...
    [...snipped...]
    Adding -e git+https://github.com/requests/requests.git@v2.19.1#egg=requests to Pipfile's [packages]...
    [...]
```


Install a dev dependency:

$ pipenv install pytest --dev
Expand Down
1 change: 1 addition & 0 deletions news/2685.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added simple example to README.md for installing from git.