ohmyzsh/plugins/virtualenvwrapper
2019-10-07 18:04:49 +02:00
..
README.md virtualenvwrapper: add README (#8226) 2019-10-07 18:04:49 +02:00
virtualenvwrapper.plugin.zsh virtualenvwrapper: set $WORKON_HOME if undefined 2018-06-06 17:14:19 +02:00

Virtualenvwrapper plugin

This plugin loads Python's virtualenvwrapper shell tools.

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

plugins=(... virtualenvwrapper)

Usage

The plugin allows to automatically activate virtualenvs on cd into git repositories with a matching name:

➜  github $ cd ansible
(ansible) ➜  ansible git:(devel) $ cd docs
(ansible) ➜  docs git:(devel) $ cd ..
(ansible) ➜  ansible git:(devel) $ cd ..
➜  github $

We can override this by having a .venv file in the directory containing a differently named virtualenv:

➜  github $ cat ansible/.venv
myvirtualenv
➜  github $ cd ansible
(myvirtualenv) ➜  ansible git:(devel) $ cd ..
➜  github $

We can disable this behaviour by setting DISABLE_VENV_CD=1 before Oh My Zsh is sourced:

DISABLE_VENV_CD=1
plugins=(... virtualenvwrapper)
source $ZSH/oh-my-zsh.sh