linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2026-01-16 02:27:03 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

some changes

Browse source
This commit is contained in:
Carlo Sala 2024-03-03 13:02:06 +01:00
commit b6839fdea8
No known key found for this signature in database
GPG key ID: DA6FB450C1A4FE9A
2 changed files with 26 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

39
plugins/python/README.md
View file

@ -22,33 +22,18 @@ plugins=(... python)
## Virtual environments
The plugin provides three utilities to manage Python 3.3+
[venv](https://docs.python.org/3/library/venv.html) virtual
environments:
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* (else
`$PYTHON_VENV_NAME`, else "venv") in the 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 the virtual environment called *name* (else
`$PYTHON_VENV_NAME`, else "venv") in the 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
cd’ing into a directory containing `venv/bin/activate`, and
automatically deactivate it when cd’ing into any other directory,
including subdirectories.
- To enable, set `PYTHON_AUTO_VRUN` to anything. For example:
export PYTHON_AUTO_VRUN='true'
- To disable, either unset the environment variable:
unset PYTHON_AUTO_VRUN
or entirely remove `auto_vrun` from the list of functions associated
with the `chpwd` hook:
add-zsh-hook -d chpwd auto_vrun
If you disable `auto_vrun` while a virtual environment is active,
you'll need to manually `deactivate`.
- The default virtual environment name is "venv". To use a different
name, set `PYTHON_VENV_NAME`. For example:
export PYTHON_VENV_NAME='.venv'
- `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"`