Cornelicorn/oh-my-zsh
1
0
Fork 0
mirror of https://github.com/robbyrussell/oh-my-zsh.git synced 2025-12-06 15:30:40 +01:00
Code Issues Releases Wiki Activity

feat(python): add auto venv activation (#12248)

Browse Source 
Co-authored-by: Carlo Sala <carlosalag@protonmail.com>
This commit is contained in:
Robert Crews
2024-03-03 04:04:19 -08:00
committed by GitHub
parent 97a86ed167
commit 12cd3b3e39
2 changed files with 32 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
plugins/python/README.md
View File

@@ -22,8 +22,18 @@ plugins=(... python)
## Virtual environments
The plugin provides two utilities to manage Python venvs:
The plugin provides three utilities to manage Python 3.3+ [venv](https://docs.python.org/3/library/venv.html)
virtual environments:
- `mkv [name]`: make a new virtual environment called `name` (default: `venv`) in current directory.
- `mkv [name]`: make a new virtual environment called `name` (default: if set `$PYTHON_VENV_NAME`, else
`venv`) in the current directory.
- `vrun [name]`: activate virtual environment called `name` (default: `venv`) in current directory.
- `vrun [name]`: Activate the virtual environment called `name` (default: if set `$PYTHON_VENV_NAME`, else
`venv`) in the current directory.
- `auto_vrun`: Automatically activate the venv virtual environment when entering a directory containing
`<venv-name>/bin/activate`, and automatically deactivate it when navigating out of it (including
subdirectories!).
- To enable the feature, set `export PYTHON_AUTO_VRUN=true` before sourcing oh-my-zsh.
- The default virtual environment name is `venv`. To use a different name, set
`export PYTHON_VENV_NAME=<venv-name>`. For example: `export PYTHON_VENV_NAME=".venv"`