summaryrefslogtreecommitdiff
path: root/plugins/virtualenvwrapper
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-24 17:57:01 +0200
committerGitHub <noreply@github.com>2019-10-24 17:57:01 +0200
commitcad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch)
tree2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/virtualenvwrapper
parent225425fe091ca052997833279ccc08643818c24a (diff)
parent40df67bc3b9b51caa24df5d220487043040d1f9a (diff)
downloadzsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/virtualenvwrapper')
-rw-r--r--plugins/virtualenvwrapper/README.md38
-rw-r--r--plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh18
2 files changed, 55 insertions, 1 deletions
diff --git a/plugins/virtualenvwrapper/README.md b/plugins/virtualenvwrapper/README.md
new file mode 100644
index 000000000..63eb58541
--- /dev/null
+++ b/plugins/virtualenvwrapper/README.md
@@ -0,0 +1,38 @@
+# Virtualenvwrapper plugin
+
+This plugin loads Python's [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) shell tools.
+
+To use it, add `virtualenvwrapper` to the plugins array in your zshrc file:
+
+```zsh
+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:
+```zsh
+DISABLE_VENV_CD=1
+plugins=(... virtualenvwrapper)
+source $ZSH/oh-my-zsh.sh
+```
diff --git a/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh b/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh
index 6cd30732e..e27c6bb76 100644
--- a/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh
+++ b/plugins/virtualenvwrapper/virtualenvwrapper.plugin.zsh
@@ -1,11 +1,27 @@
virtualenvwrapper='virtualenvwrapper.sh'
+virtualenvwrapper_lazy='virtualenvwrapper_lazy.sh'
-if (( $+commands[$virtualenvwrapper] )); then
+if (( $+commands[$virtualenvwrapper_lazy] )); then
+ function {
+ setopt local_options
+ unsetopt equals
+ virtualenvwrapper=${${virtualenvwrapper_lazy}:c}
+ source ${${virtualenvwrapper_lazy}:c}
+ [[ -z "$WORKON_HOME" ]] && WORKON_HOME="$HOME/.virtualenvs"
+ }
+elif (( $+commands[$virtualenvwrapper] )); then
function {
setopt local_options
unsetopt equals
source ${${virtualenvwrapper}:c}
}
+elif [[ -f "/usr/local/bin/virtualenvwrapper.sh" ]]; then
+ function {
+ setopt local_options
+ unsetopt equals
+ virtualenvwrapper="/usr/local/bin/virtualenvwrapper.sh"
+ source "/usr/local/bin/virtualenvwrapper.sh"
+ }
elif [[ -f "/etc/bash_completion.d/virtualenvwrapper" ]]; then
function {
setopt local_options