mirror of
https://github.com/kennethreitz/pipenv.git
synced 2026-06-05 22:50:18 +00:00
Matt Davis
761a03d088
* Begin reviewing the basics docs. * Check in delta * More doc revisions. * Split apart basics docs. * Refactor based on building docs * add the files back as markdown. * more conversions to markdown. * more conversions to markdown. * fix markdown formatting. * convert index to markdown. * More docs review * More markdown and doc revisions. * Fix docs. * Update doc build requirements. * fix lint * Fix build with update/upgrade command. * remove useless quickstart and update the commands section. * Fix lint * change ordering of table of contents. * fix changelog duplicate headings. * Start splitting advanced topics. * minor nits * Move some sections from advanced to shell. * remove this section as its stale and kind of off topic. * move scripts out into its own section. * Wrap up revisions1 * fix lint * address PR feedback and other nits. * fix lint * Try improving ordering of table of contents, fix issue with indexes.md file location. * fix lint * PR feedback.
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Configuration
|
|
|
|
## Configuration With Environment Variables
|
|
|
|
Pipenv comes with a handful of options that can be set via shell environment
|
|
variables.
|
|
|
|
To enable boolean options, create the variable in your shell and assign to it a
|
|
true value. Allowed values are: `"1", "true", "yes", "on"`
|
|
|
|
$ PIPENV_IGNORE_VIRTUALENVS=1
|
|
|
|
To explicitly disable a boolean option, assign to it a false value (i.e. `"0"`).
|
|
|
|
```{eval-rst}
|
|
.. autoclass:: pipenv.environments.Setting
|
|
:members:
|
|
```
|
|
|
|
Also note that `pip` supports additional [environment variables](https://pip.pypa.io/en/stable/user_guide/#environment-variables), if you need additional customization.
|
|
|
|
For example:
|
|
|
|
$ PIP_INSTALL_OPTION="-- -DCMAKE_BUILD_TYPE=Release" pipenv install -e .
|
|
|
|
## Changing 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.
|
|
|
|
## Changing Default Python Versions
|
|
|
|
By default, pipenv will initialize a project using whatever version of python the system has as default.
|
|
Besides starting a project with the `--python` flag, you can also use `PIPENV_DEFAULT_PYTHON_VERSION` to specify what version to use when starting a project when `--python` isn't used.
|