Commit Graph

209 Commits

Author SHA1 Message Date
Dan Ryan 7f602daf98 Expand a bit on sync vs ignore-pipfile
- expanded a bit on the distinction between `sync` and `ignore-pipfile`
- fixed a merge conflict resolution I did that erased some changes in master
2018-08-31 00:16:09 -04:00
Dan Ryan d1d6b87b05 Merge branch 'master' into docs/deployment-guide 2018-08-30 23:53:53 -04:00
Sharla Kew 8ba24b85d8 change argument example to show concatination 2018-08-30 19:18:28 +01:00
Dan Ryan 0fc5d0bc05 Merge branch 'master' into master 2018-08-29 02:01:36 -04:00
Stephen Rosen 3798d83a70 Update deployment section of advanced docs
Clarify that `--deploy` is meant for enforcement and intentionally
failing a build.
Mention `pipenv sync` in the same section to try to establish it more
clearly as the most obvious and normal way of doing installation from
``Pipfile.lock`` as part of a reproducible build process.

Explicitly recommend against `pipenv install --ignore-pipfile` and
suggest that it may be deprecated.
2018-08-27 15:15:43 +00:00
Sharla Kew 7678cba302 Expand and clarify custom script shortcut docs
This is a really neat feature and I felt the documentation would benefit
from being expanded slightly and being worded a little more clearly.
2018-08-25 10:54:13 +01:00
Giorgio Sironi 45b5e7d789 Do not recommend --system for a Docker context
Despite an application's Docker container not usually running other Python processes than the application itself, it still has a system Python whose packages should not necessarily be overwritten or upgraded by an application's choices.

For example, `python3-software-properties` in Ubuntu contains utilities
written in Python like `add-apt-repository` whose [use is widespread in
Dockerfiles](https://github.com/search?l=Dockerfile&q=%22add-apt-repository%22&type=Code).

By inadvertently applying an application's dependency onto the the container's Python, it is possible to:

- subtly break system-level software like these that is still present in the container image
- run into errors where that software is executed while extending the image with another Dockerfile
- run into errors when `docker run|exec ... COMMAND` is used to run another process inside the same container for debugging purposes

I realize this is not necessarily a likely use case, but we have seen
enough projects/tools vendoring `Requests` in fear of a conflict.

Very open on the wording and whether `system Python` is the correct term
to designate the global Python for that OS/container image.
2018-08-20 13:38:14 +01:00
Warix3 0170cdbf77 PyCharm now fully supports pipenv
As of the release version 2018.2 PyCharm has a full pipenv support. [Source](https://www.jetbrains.com/pycharm/whatsnew/#v2018-2-python "New features")
2018-07-30 01:28:42 +02:00
James Howe 8dcb187b56 Delete "Changing Where Pipenv Stores Virtualenvs"
It's a partial duplicate of the "Custom Virtual Environment Location" section.
2018-07-10 15:21:09 +01:00
Tzu-ping Chung 9bd49f9759 Automatically generate environment variable docs
Default values are added to docstrings so they appear in the docs.
This should help maintainers to keep them up-to-date.

Fix #2547.
2018-07-10 18:38:15 +08:00
gkdoc ec93a9e10e Insert space before a bracket 2018-07-05 21:35:22 -07:00
Tzu-ping Chung a5a9583c2d Un-vendor Pew 2018-07-05 16:43:11 +08:00
Jacob Henner af91eb68bb Add support for PyPI mirrors
Adds support for the --pypi-mirror command line parameter and the
PIPENV_PYPI_MIRROR environment variable for most pipenv operations.
This permits pipenv to function without pypi.org, which is necessary for
users:

    1. behind restrictive networks
    2. facing strict artifact sourcing policies
    3. experiencing poor performance connecting to pypi.org
    4. who've configured a local cache for performance reasons

When specified, the value of this parameter replaces all instances of
pypi.org and pypi.python.org within pipenv operations without modifying
or requring the modification of Pipfiles.

- Resolves #2075
2018-06-07 18:24:18 -04:00
Dan Ryan cf051ef1d4 Merge branch 'master' into patch-2 2018-04-29 15:26:04 -04:00
Stefane Fermigier 6707b0c19b I believe this tox config is more correct this way 2018-04-16 12:36:40 +02:00
Frost Ming 336f649e13 revise as suggested 2018-04-14 16:20:23 +08:00
frostming ea06c18565 change the term of conda 2018-04-14 16:17:26 +08:00
frostming a28bfd96fe make names consistent 2018-04-14 16:17:26 +08:00
Cody 828652680e Merge branch 'master' into master 2018-04-12 23:13:21 -04:00
Cody abaf244cfc add PIPENV_INSTALL_TIMEOUT to envar index 2018-04-12 02:42:49 -04:00
Cody a0e11e56a0 add section on PIPENV_DEFAULT_PYTHON_VERSION 2018-04-12 02:37:04 -04:00
Cody 927fd19a4c clarify wording on some envars 2018-04-11 23:35:21 -04:00
Cody c3990c778c add section explaining PIPENV_VENV_IN_PROJECT 2018-04-11 23:27:16 -04:00
Cody d74e2afb38 fix typo 2018-04-11 23:09:59 -04:00
frostming 92f3789abb Mention scripts section in doc 2018-04-12 10:51:28 +08:00
Cody fa9f649d90 add more envars to docs 2018-04-11 22:35:05 -04:00
Cody 81b8bd3737 add section about PIPENV_CACHE_DIR in documentation 2018-04-11 19:39:57 -04:00
Dan Ryan 8d078f8a0b Update advanced.rst 2018-04-11 00:14:05 -04:00
Dan Ryan a60077862c Update advanced.rst 2018-04-11 00:12:58 -04:00
Jan Vlcinsky 31230b1a37 Documentation about usage in tox.ini updated (shorter call). 2018-04-07 23:27:11 +02:00
Stefan VanBuren 939d77cf40 Update advanced.rst
Needs an extra `:` to render the .rst properly
2018-03-29 11:31:30 -04:00
luz.paz 63f7e988f7 Misc. typos
Found via `codespell -q 3`
2018-03-27 13:42:27 -04:00
Jeff Tratner 5cf7a7d552 Add doc note about environment variables 2018-03-23 00:17:28 -07:00
kennethreitz e8e38d7929 Merge pull request #1769 from dvf/dvf/parse-environment-variables
Allow values in Pipfile to consume Environment Variables
2018-03-20 08:16:31 -04:00
Kalle Jepsen 72bbd6206a Remove recommendation to add passenv=HOME to tox.ini
I believe `passenv=HOME` is no (or no longer?) necessary, as pipenv will
use the virtualenv it is running in. In addition this adds a
recommendation to add `--ignore-pipfile` to `pipenv install`, to protect
the locked dependency set from accidental changes.
2018-03-17 20:35:14 +01:00
Daniel van Flymen f87e434cb2 Add explanation to Docs 2018-03-16 18:34:26 -04:00
Nick Coghlan 993525b539 Update pipenv check docs for Safety-DB removal
We removed the embedded copy of Safety-DB, so there's
no longer any copyright concern about the CC-BY-NC-SA
license, but it does mean `pipenv check` may end up throttled
eventually as all requests to the backend API use a common
key.
2018-03-15 21:20:51 +10:00
kennethreitz 7353803b89 --sequential flag
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-14 12:06:37 -04:00
kennethreitz ed1d34a373 lock
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-14 08:32:55 -04:00
kennethreitz 7a44a5ae76 more patterns
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-14 08:32:14 -04:00
kennethreitz ee864f813e commas
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-14 08:31:53 -04:00
kennethreitz 30a94b79a7 caps
Signed-off-by: Kenneth Reitz <me@kennethreitz.org>
2018-03-14 08:31:35 -04:00
kennethreitz 4a112ff859 Merge pull request #1733 from ksonj/master
Add section on distinction between setup.py and Pipfile
2018-03-14 08:26:10 -04:00
Kalle Jepsen 05a82a2b2d Add section on distinction between setup.py and Pipfile 2018-03-14 13:16:59 +01:00
Nick Coghlan c1947126dc Revise pipenv check caveat for pyup.io feedback
Jannis Gebauer of pyup.io let us know that he's definitely fine
with commercial *use* of the `pipenv check` feature, so it's
only commercial redistributors of `pipenv` that may need to
take a closer look at the licensing situation, and perhaps
talk to `pyup.io` directly.

Follow-up to #1651
2018-03-14 21:06:13 +10:00
kennethreitz 043166d867 document caveats
#1683
2018-03-13 12:31:05 -04:00
Nick Coghlan 6c4ab02f63 Add a legal caveat on pipenv check
Closes #1651
2018-03-10 14:53:03 +10:00
kennethreitz 550d2d6630 Update advanced.rst 2018-03-09 15:15:39 -05:00
Jeff Tratner 2ca6255734 Site packages with conda 2018-03-09 11:59:00 -08:00
Brett Cannon 01c34e3b72 Use VS Code as the example editor for EDITOR usage
Now that VS Code has pipenv support out of the box, might at well use an example that doesn't require any extra setup 😉
2018-03-08 15:23:14 -08:00