a84f5443af
Incorrect ref in VCS example
...
Small changes, but a couple of issues in the `A Note About VCS Dependencies` section of the docs.
Running the example `$ pipenv install -e git+https://github.com/requests/requests.git@v2.19#egg=requests ` raises the error: `Did not find branch or tag 'v2.19', assuming revision or ref.` I think it should be 'v2.19.1' which is just a typo as 'v2.19.1' is used in the subsequent lines of the example.
The example Pipfile in the section excludes the `v` in the version number written to the `ref = ` part. I found it a little confusing that it would strip the 'v' from the tag, but then on testing it I found that it doesn't do that:
```
[packages]
requests = {editable = true, ref = "v2.20.1", git = "https://github.com/requests/requests.git "}
```
Also, while I was here I figured I'd update the example to the most recent requests release.
Thanks.
2018-11-15 10:17:58 +11:00
38fe342f13
Fix typo
2018-10-19 15:42:30 +02:00
87551b9d45
Documentation: how to use pip specifiers with Pipenv
...
Fix #2930 .
2018-10-18 00:20:47 +08:00
4588ffebda
Added shell deactivation instruction to documentation
...
Minor edits to documentation
2018-10-07 09:24:25 +05:30
51c3c8b600
Fix pipenv install --dev description
...
By default, `pipenv install` will install packages
based on the list in `Pipfile`, not `Pipfile.lock`.
`pipenv install --dev` is no exception.
I've tested this using pipenv 2018.7.1
with different package versions in `Pipfile`
and `Pipfile.lock`. After `pipenv install`,
the versions in `Pipfile` were the ones
actually installed.
2018-09-14 11:23:03 +08:00
505d093ab3
Merge branch 'master' into reinout-fixed-missing-egg-in-url
2018-08-30 12:15:30 +08:00
e5462303d2
Fix typo in basics.rst
...
organizatoin => organization
2018-08-29 15:35:50 -04:00
7f1bd507ae
Added missing 'egg=' in the example url
2018-08-29 15:13:23 +02:00
a4ad13e52b
Update readme images, port readme add news
...
Signed-off-by: Dan Ryan <dan@danryan.co >
2018-08-17 16:34:28 -04:00
c91cce1233
Merge branch 'master' into master
2018-08-07 09:34:21 +08:00
c6742a8430
Minor tense changes with basics.rst
2018-08-07 09:33:21 +08:00
4bfa219985
Use proper syntax for rst links
...
Fix link syntax for pep440 links in documentation
2018-08-04 18:16:35 -04:00
81a189dbc5
Update basics.rst
...
Update link with Sphinx’s reference syntax.
2018-08-02 16:31:58 +08:00
0f30bcbcdb
Update basics.rst
...
Add the description of `PIPENV_SHELL`
2018-08-01 22:34:33 +08:00
587125c279
Fix syntax of link
2018-07-30 14:38:53 +10:00
1a7d72fe6e
Add link to PEP-440 for version specifiers
2018-07-30 14:35:28 +10:00
9cb8e546c2
Update basics.rst with $SHELL
...
State the role of `$SHELL` in `pipenv shell` command.
2018-07-29 21:23:40 +08:00
9288f676d2
Fix small docs typo
2018-07-10 10:19:02 +02:00
684748ead1
Revise note format for consistency in basics.rst
2018-07-07 19:46:22 -07:00
3f13e8dfd3
Mention --keep-outdated in docs for importing
...
When importing from requirements.txt, it may be useful to
keep the versions of packages you have for the moment,
while unpinning them for the future. This is already supported
via `--keep-outdated`; this commit adds a mention to the docs.
Fixes #908 .
2018-04-25 11:43:04 -07:00
e8eb732ce9
Note that `-e` impacts sub-dependencies in lock file.
2018-04-23 17:43:23 -04:00
c84e60cdaa
Update vcs documentation
...
- Add link to pip docs
- Unquote `-e .` example
- Add detail to examples
- Closes #1908
Signed-off-by: Dan Ryan <dan@danryan.co >
2018-04-10 19:27:30 -04:00
63f7e988f7
Misc. typos
...
Found via `codespell -q 3`
2018-03-27 13:42:27 -04:00
kennethreitz
9ea094105b
basics
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-03-02 18:50:14 -05:00
kennethreitz
5a0cad819e
basics
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-03-02 10:11:45 -05:00
kennethreitz
ab5da25170
Merge branch 'master' of github.com:kennethreitz/pipenv
...
# Please enter a commit message to explain why this merge is necessary,
# especially if it merges an updated upstream into a topic branch.
#
# Lines starting with '#' will be ignored, and an empty message aborts
# the commit.
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-03-02 10:07:20 -05:00
kennethreitz
4566e4d17c
recommendations
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-03-02 10:05:19 -05:00
kennethreitz
b0d33c5dfd
try this
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-02-28 11:46:54 -05:00
kennethreitz
bebac70707
basics
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-02-28 11:38:55 -05:00
kennethreitz
21eab5abbb
upgrade workflow
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2018-02-28 11:33:07 -05:00
4577b89322
Updated docs - basic usage example pipenv workflow
...
I'm new to python so I didn't know 'exit' was the thing to type to deactivate the pipenv shell, so I thought I would add that to the basic usage doc.
2018-02-28 17:15:43 +11:00
e8a7be3b03
Add link to Pipfile specification
...
This is useful for people using Pipenv and looking for more information related to specifying VCS dependencies.
2018-02-01 12:19:40 +01:00
6cbd38f46d
Fix typos:
...
`resursively` | `recursively`
`additonal` | `additional`
`occured` | `occurred`
`vulnerabilties` | `vulnerabilities`
`gven` | `given`
`pipenev` | `pipenv`
`requirments` | `requirements`
`virtualenvrionment` | `virtualenvironment`
`envrionment` | `environment`
`dependecies` | `dependencies`
`requiments` | `requirements`
`Seperated` | `Separated`
`bugifx` | `bugfix`
`supression` | `suppression`
`intall` | `install`
`Suport` | `Support`
`autocurrections` | `autocorrections`
`coccurency` | `concurrency`
`consistient` | `consistent`
`saftey` | `safety`
`afer` | `after`
`configuraable` | `configurable`
`remporary` | `temporary`
`depdendencies` | `dependencies`
`pactched` | `patched`
2017-11-26 23:26:24 -07:00
kennethreitz
40a2ac6244
who wrote this shit
2017-11-08 11:51:41 -05:00
f5eca4d29c
updated docs with new uninstall option
2017-10-29 13:57:53 -06:00
835196dd0f
Fixes #954 . Example Pipfile.lock workflow.
...
Fixes #954 . Example Pipfile.lock workflow.
2017-10-24 21:18:15 +01:00
8ec409f902
Update basics.rst
...
Fix misspelling
2017-10-13 21:31:51 +11:00
kennethreitz
e08226d951
fix for #785
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2017-10-01 06:52:09 -04:00
401b445de5
Fix reST syntax errors
2017-09-28 00:37:21 +09:00
kennethreitz
88320187bc
docs refactor
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2017-09-27 09:53:22 -04:00
41d9da6447
typo
2017-09-26 14:41:49 +08:00
kennethreitz
be73b870c0
basics
...
Signed-off-by: Kenneth Reitz <me@kennethreitz.org >
2017-09-13 10:24:14 -04:00
kennethreitz
5e49658791
Update basics.rst
2017-09-05 12:32:36 -04:00
cca3c73d93
Add missing call on response.json
2017-09-05 12:29:55 +02:00
kennethreitz
abbae8ea99
Update basics.rst
2017-08-30 20:34:27 -04:00
kennethreitz
2e561a61a6
Update basics.rst
2017-08-30 20:33:54 -04:00
kennethreitz
23c2f22803
Update basics.rst
2017-08-30 20:33:27 -04:00
kennethreitz
0eb9415f0a
Update basics.rst
2017-08-30 20:23:24 -04:00
kennethreitz
68d050c8f5
Create basics.rst
2017-08-30 20:20:34 -04:00
Peter Schutt
kennethreitz