From 9070a6b92d7bc1fdcae8d7ac02d369a2ffacfec1 Mon Sep 17 00:00:00 2001 From: Jeremy Spencer Date: Fri, 3 Aug 2018 11:14:58 -0400 Subject: [PATCH 1/3] Added an example to README.md for installing from git --- README.md | 9 +++++++++ news/2685.doc | 1 + 2 files changed, 10 insertions(+) create mode 100644 news/2685.doc diff --git a/README.md b/README.md index 9c2f00b3c2..b552925a55 100644 --- a/README.md +++ b/README.md @@ -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 + Install a dev dependency: $ pipenv install pytest --dev diff --git a/news/2685.doc b/news/2685.doc new file mode 100644 index 0000000000..6f2a0affec --- /dev/null +++ b/news/2685.doc @@ -0,0 +1 @@ +Added simple example to README.md for installing from git. From a3162945be79182d0a4b4a7c140970dc340788fb Mon Sep 17 00:00:00 2001 From: Jeremy Spencer Date: Sun, 12 Aug 2018 16:15:17 -0400 Subject: [PATCH 2/3] mend --- README.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b552925a55..b6ef6e5620 100644 --- a/README.md +++ b/README.md @@ -216,14 +216,30 @@ Install packages: To activate this project's virtualenv, run the following: $ pipenv shell -Install from git: +Installing 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 install packages with pipenv from git and other version control systems using URLs formatted according to the following rule: + +``` + +:////@# +``` + +The only optional section is the `@` section. When using git over SSH, you may use the shorthand vcs and scheme alias `git+git@:/@#`. Note that this is translated to `git+ssh://git@` when parsed. -You can also change the tag/ref (or exclude to get the latest version) by adding @version-or-tag before #egg=project_name +Valid values for `` include `git`, `bzr`, `svn`, and `hg`. Valid values for `` 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: From 1188a3de34159b54cb747b346b5770e36e44e6d5 Mon Sep 17 00:00:00 2001 From: Jeremy Spencer Date: Mon, 13 Aug 2018 08:51:39 -0400 Subject: [PATCH 3/3] Updated for PR #2702. Added in request from user @uranusjr for pip documentation on vcs support and @slhck request for more consistent formatting of code blocks and more explict instructions for editable mode when installing from vcs --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b6ef6e5620..16b72034fd 100644 --- a/README.md +++ b/README.md @@ -220,26 +220,24 @@ Installing from git: You can install packages with pipenv from git and other version control systems using URLs formatted according to the following rule: -``` +:////@# -``` The only optional section is the `@` section. When using git over SSH, you may use the shorthand vcs and scheme alias `git+git@:/@#`. Note that this is translated to `git+ssh://git@` when parsed. Valid values for `` include `git`, `bzr`, `svn`, and `hg`. Valid values for `` 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. +Note that it is **strongly recommended** that you install any version-controlled dependencies in editable mode, using `pipenv install -e`, 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]... [...] -``` + +You can read more about [pip's implementation of vcs support here](https://pip.pypa.io/en/stable/reference/pip_install/#vcs-support). Install a dev dependency: