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.
24 lines
1021 B
Markdown
24 lines
1021 B
Markdown
# virtualenv
|
|
|
|
## Custom Virtual Environment Location
|
|
|
|
Pipenv automatically honors the `WORKON_HOME` environment variable, if you
|
|
have it set — so you can tell pipenv to store your virtual environments
|
|
wherever you want, e.g.:
|
|
|
|
export WORKON_HOME=~/.venvs
|
|
|
|
In addition, you can also have Pipenv stick the virtualenv in `project/.venv` by setting the `PIPENV_VENV_IN_PROJECT` environment variable.
|
|
|
|
## Virtual Environment Name
|
|
|
|
The virtualenv name created by Pipenv may be different from what you were expecting.
|
|
Dangerous characters (i.e. `$`!*@"` as well as space, line feed, carriage return,
|
|
and tab) are converted to underscores. Additionally, the full path to the current
|
|
folder is encoded into a "slug value" and appended to ensure the virtualenv name
|
|
is unique.
|
|
|
|
Pipenv supports a arbitrary custom name for the virtual environment set at `PIPENV_CUSTOM_VENV_NAME`.
|
|
|
|
The logical place to specify this would be in a user's `.env` file in the root of the project, which gets loaded by pipenv when it is invoked.
|