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

docs(python): improve docs for settings

Browse source
This commit is contained in:
Marc Cornellà 2025-01-23 19:51:55 +01:00
commit 60e0ce4bb1
No known key found for this signature in database
GPG key ID: 0314585E776A9C1B
1 changed files with 23 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

25
plugins/python/README.md
View file

@ -41,7 +41,28 @@ virtual environments:
### Settings
You can set these variables in your `.zshrc` file, before Oh My Zsh is sourced.
For example:
- `$PYTHON_VENV_NAME`: preferred name for virtual environments (default: `venv`).
```sh
PYTHON_VENV_NAME=".venv"
PYTHON_VENV_NAMES=($PYTHON_VENV_NAME venv)
...
plugins=(... python)
source "$ZSH/oh-my-zsh.sh"
```
## `$PYTHON_VENV_NAME`
**Default**: `venv`.
Preferred name for virtual environments, for example when creating via `mkv`.
## `$PYTHON_VENV_NAMES`
**Default**: `$PYTHON_VENV_NAME venv .venv`.
Array of virtual environment names to be checked, in order, by `vrun` and `auto_vrun`.
This means these functions will load the first existing virtual environment in this list.
Duplicate names are ignored.
- `$PYTHON_VENV_NAMES`: list of virtual environment names to be checked, in order, by `vrun` and `auto_vrun`.