From 81b8bd3737f2a59c414edb48c3e7e716bee25d63 Mon Sep 17 00:00:00 2001 From: Cody Date: Wed, 11 Apr 2018 19:39:57 -0400 Subject: [PATCH 1/7] add section about PIPENV_CACHE_DIR in documentation --- docs/advanced.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/advanced.rst b/docs/advanced.rst index dfa7356a..33420ea1 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -533,3 +533,8 @@ You can also do this:: $ pipenv install -e . This will tell Pipenv to lock all your ``setup.py``–declared dependencies. + +☤ Changing Location Pipenv's Cache +---------------------------------- + +You can force Pipenv to use a different cache location by setting the environment variable ``PIPENV_CACHE_DIR`` to the location you wish. This is useful in the same situations that you would change ``PIP_CACHE_DIR`` to a different directory. From fa9f649d9027c2ca7d88d8afaaf9ee5d390432ce Mon Sep 17 00:00:00 2001 From: Cody Date: Wed, 11 Apr 2018 22:32:55 -0400 Subject: [PATCH 2/7] add more envars to docs --- docs/advanced.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/advanced.rst b/docs/advanced.rst index 33420ea1..cab71bbe 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -371,6 +371,17 @@ will detect it. directory where the Pipfile is located, instruct pipenv to find the Pipfile in the location specified by this environment variable. + - ``PIPENV_CACHE_DIR`` — Location for Pipenv to store it's package cache. This is useful in the + same situations that you would change ``PIP_CACHE_DIR``. + + - ``PIPENV_HIDE_EMOJIS`` — Disable emojis in output. + + - ``PIPENV_DOTENV_LOCATION`` — Location of the project's .env file, only useful to set if it's not inthe same directory as the Pipfile. + + - ``PIPENV_DONT_LOAD_ENV`` — Tell Pipenv not to load the .env file. + + - ``PIPENV_VENV_IN_PROJECT`` — Set to create the virtual environment folder in the project instead of the default location. + If you'd like to set these environment variables on a per-project basis, I recommend utilizing the fantastic `direnv `_ project, in order to do so. Also note that `pip itself supports environment variables `_, if you need additional customization. From d74e2afb38be55b5ed3834ed5cb96c225e75b456 Mon Sep 17 00:00:00 2001 From: Cody Date: Wed, 11 Apr 2018 23:09:59 -0400 Subject: [PATCH 3/7] fix typo --- docs/advanced.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index cab71bbe..fa922cd4 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -545,7 +545,7 @@ You can also do this:: This will tell Pipenv to lock all your ``setup.py``–declared dependencies. -☤ Changing Location Pipenv's Cache +☤ Changing Pipenv's Cache Location ---------------------------------- You can force Pipenv to use a different cache location by setting the environment variable ``PIPENV_CACHE_DIR`` to the location you wish. This is useful in the same situations that you would change ``PIP_CACHE_DIR`` to a different directory. From c3990c778ca4b33b8bcc15915ba8c4369a701403 Mon Sep 17 00:00:00 2001 From: Cody Date: Wed, 11 Apr 2018 23:24:51 -0400 Subject: [PATCH 4/7] add section explaining PIPENV_VENV_IN_PROJECT --- docs/advanced.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index fa922cd4..a33e81b8 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -380,8 +380,6 @@ will detect it. - ``PIPENV_DONT_LOAD_ENV`` — Tell Pipenv not to load the .env file. - - ``PIPENV_VENV_IN_PROJECT`` — Set to create the virtual environment folder in the project instead of the default location. - If you'd like to set these environment variables on a per-project basis, I recommend utilizing the fantastic `direnv `_ project, in order to do so. Also note that `pip itself supports environment variables `_, if you need additional customization. @@ -549,3 +547,8 @@ This will tell Pipenv to lock all your ``setup.py``–declared dependencies. ---------------------------------- You can force Pipenv to use a different cache location by setting the environment variable ``PIPENV_CACHE_DIR`` to the location you wish. This is useful in the same situations that you would change ``PIP_CACHE_DIR`` to a different directory. + +☤ Changing Where Pipenv Stores Virtualenvs +------------------------------------------ + +By default, Pipenv stores all of your virtualenvs in a single place. Usually this isn't a problem, but if you'd like to change it for developer ergonomics, or if it's causing issues on build servers you can set ``PIPENV_VENV_IN_PROJECT`` to create the virtualenv inside the root of your project. From 927fd19a4c22093399e6411b732f2c0424b85878 Mon Sep 17 00:00:00 2001 From: Cody Date: Wed, 11 Apr 2018 23:29:21 -0400 Subject: [PATCH 5/7] clarify wording on some envars --- docs/advanced.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index a33e81b8..c47aa7d5 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -371,14 +371,13 @@ will detect it. directory where the Pipfile is located, instruct pipenv to find the Pipfile in the location specified by this environment variable. - - ``PIPENV_CACHE_DIR`` — Location for Pipenv to store it's package cache. This is useful in the - same situations that you would change ``PIP_CACHE_DIR``. + - ``PIPENV_CACHE_DIR`` — Location for Pipenv to store it's package cache. - ``PIPENV_HIDE_EMOJIS`` — Disable emojis in output. - - ``PIPENV_DOTENV_LOCATION`` — Location of the project's .env file, only useful to set if it's not inthe same directory as the Pipfile. + - ``PIPENV_DOTENV_LOCATION`` — Location for Pipenv to load your project's .env. - - ``PIPENV_DONT_LOAD_ENV`` — Tell Pipenv not to load the .env file. + - ``PIPENV_DONT_LOAD_ENV`` — Tell Pipenv not to load the .env files automatically. If you'd like to set these environment variables on a per-project basis, I recommend utilizing the fantastic `direnv `_ project, in order to do so. From a0e11e56a073c89b7d41631288b93dc8613bc3e3 Mon Sep 17 00:00:00 2001 From: Cody Date: Thu, 12 Apr 2018 02:37:04 -0400 Subject: [PATCH 6/7] add section on PIPENV_DEFAULT_PYTHON_VERSION --- docs/advanced.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/advanced.rst b/docs/advanced.rst index c47aa7d5..7ba95d1e 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -551,3 +551,8 @@ You can force Pipenv to use a different cache location by setting the environmen ------------------------------------------ By default, Pipenv stores all of your virtualenvs in a single place. Usually this isn't a problem, but if you'd like to change it for developer ergonomics, or if it's causing issues on build servers you can set ``PIPENV_VENV_IN_PROJECT`` to create the virtualenv inside the root of your project. + +☤ Changing Default Python Versions +---------------------------------- + +By default, Pipenv will initialize a project using whatever version of python the python3 is. Besides starting a project with the ``--three`` or ``--two`` flags, you can also use ``PIPENV_DEFAULT_PYTHON_VERSION`` to specify what version to use when starting a project when ``--three`` or ``--two`` aren't used. From abaf244cfc81aaa08b1ebc6be9fc0cdde87a23d0 Mon Sep 17 00:00:00 2001 From: Cody Date: Thu, 12 Apr 2018 02:42:49 -0400 Subject: [PATCH 7/7] add PIPENV_INSTALL_TIMEOUT to envar index --- docs/advanced.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/advanced.rst b/docs/advanced.rst index 7ba95d1e..f1a13e39 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -364,6 +364,9 @@ will detect it. - ``PIPENV_TIMEOUT`` — Set to an integer for the max number of seconds Pipenv will wait for virtualenv creation to complete. Defaults to 120 seconds. + - ``PIPENV_INSTALL_TIMEOUT`` — Set to an integer for the max number of seconds Pipenv will wait + for package installation before timing out. Defaults to 900 seconds. + - ``PIPENV_IGNORE_VIRTUALENVS`` — Set to disable automatically using an activated virtualenv over the current project's own virtual environment.