kennethreitz/pipenv
1
0
Fork 0
mirror of https://github.com/kennethreitz/pipenv.git synced 2026-06-05 06:46:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Address Issue #5129 Document how to rename (move) project directory

Browse Source 
- Added documentation in installation.md under 'Virtualenv' mapping caveat
- Added documentation to the virtualenv.md
This commit is contained in:
langaaegeskov
2023-08-05 20:25:14 -04:00
committed by Oz Tiram
parent 549c6611c6
commit b84d924179
2 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/virtualenv.md
+7
View File
@@ -21,3 +21,10 @@ 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.
## Renaming or Moving a project folder managed by pipenv
By default pipenv creates a virtualenv for your project and gives it a name. The default name is how pipenv maps the individual project to the correct virtualenv. Pipenv names the virtualenv 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 rename or move the project folder this will change the project path. Then, pipenv will no longer be able to find your virtualenv and it will make a new virtualenv. This leaves you with the old virtualenv still lying around on you system. Luckily the fix is simple.
- Run 'pipenv --rm' *before* renaming or moving your project directory
- Then, after renaming or moving the directory run 'pipenv install' to recreate the virtualenv