1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-30 09:40:09 +00:00
ohmyzsh/plugins/pyenv/README.md
Carlo Sala 5c532a85cf
fix(pyenv)!: do not load if a virtualenv is present
BREAKING CHANGE: `pyenv` will not be loaded at startup anymore if a
virtual env if found to avoid overwriting the expected python version.

Closes #12589
2024-08-01 20:12:16 +02:00

1.1 KiB

pyenv

This plugin looks for pyenv, a Simple Python version management system, and loads it if it's found. It also loads pyenv-virtualenv, a pyenv plugin to manage virtualenv, if it's found. If a venv is found pyenv won't load.

To use it, add pyenv to the plugins array in your zshrc file:

plugins=(... pyenv)

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:

export PYENV_ROOT="$HOME/.pyenv"
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init --path)"

Settings

  • ZSH_PYENV_QUIET: if set to true, the plugin will not print any messages if it finds that pyenv is not properly configured.

  • ZSH_PYENV_VIRTUALENV: if set to false, the plugin will not load pyenv-virtualenv when it finds it.

Functions

  • pyenv_prompt_info: displays the Python version in use by pyenv; or the global Python version, if pyenv wasn't found.