Skip to content

Commit

Permalink
Add brief description and caveats of project - virtualenv mapping (#3050
Browse files Browse the repository at this point in the history
)
  • Loading branch information
floatingpurr authored and uranusjr committed Oct 17, 2018
1 parent 8212a21 commit 9360058
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,15 @@ your script. It's also possible to spawn a new shell that ensures all commands
have access to your installed packages with ``$ pipenv shell``.


☤ Virtualenv mapping caveat
============

- Pipenv automatically maps projects to their specific virtualenvs.
- The virtualenv is stored globally with the name of the project’s root directory plus the hash of the full path to the project's root (e.g., ``my_project-a3de50``).
- If you change your project's path, you break such a default mapping and pipenv will no longer be able to find and to use the project's virtualenv.
- You might want to set ``export PIPENV_VENV_IN_PROJECT=1`` in your .bashrc/.zshrc (or any shell configuration file) for creating the virtualenv inside your project's directory, avoiding problems with subsequent path changes.


☤ Next steps
============

Expand Down

0 comments on commit 9360058

Please sign in to comment.