2021-09-03 18:53:33 +08:00
# pyenv
2019-10-07 23:53:18 +08:00
This plugin looks for [pyenv ](https://github.com/pyenv/pyenv ), a Simple Python version
management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv
2024-08-02 02:07:55 +08:00
plugin to manage virtualenv, if it's found. If a venv is found pyenv won't load.
2019-10-07 23:53:18 +08:00
To use it, add `pyenv` to the plugins array in your zshrc file:
```zsh
plugins=(... pyenv)
```
2024-03-14 18:37:06 +08:00
If you receive a `Found pyenv, but it is badly configured.` error on startup, you may need to ensure that `pyenv` is initialized before the oh-my-zsh pyenv plugin is loaded. This can be achieved by adding the following earlier in the `.zshrc` file than the `plugins=(...)` line:
2023-05-15 21:27:31 +08:00
```zsh
export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init --path)"
```
2021-09-03 18:53:33 +08:00
## Settings
- `ZSH_PYENV_QUIET` : if set to `true` , the plugin will not print any messages if it
finds that `pyenv` is not properly configured.
2021-09-03 18:56:00 +08:00
- `ZSH_PYENV_VIRTUALENV` : if set to `false` , the plugin will not load pyenv-virtualenv
when it finds it.
2024-11-20 03:32:01 +08:00
- `ZSH_THEME_PYENV_NO_SYSTEM` : if set to `true` , the plugin will not show the system or
default Python version when it finds it.
- `ZSH_THEME_PYENV_PREFIX` : the prefix to display before the Python version in
the prompt.
- `ZSH_THEME_PYENV_SUFFIX` : the prefix to display after the Python version in
the prompt.
2019-10-07 23:53:18 +08:00
## Functions
- `pyenv_prompt_info` : displays the Python version in use by pyenv; or the global Python
version, if pyenv wasn't found.
