diff --git a/README.md b/README.md index 8bb95cb..519e0fa 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,54 @@ Enable debugging. Multiple levels are supported (max 2). Default: `0` +## Recipes + +### Automatically activate Python virtualenvs + +Given `AUTOENV_FILE_ENTER=.autoenv.zsh`, `AUTOENV_FILE_LEAVE=.autoenv.zsh` and +`AUTOENV_HANDLE_LEAVE=1` the following script will activate Python virtualenvs +automatically in all subdirectories (`.venv` directories get used by +[pipenv](https://github.com/kennethreitz/pipenv) with +`PIPENV_VENV_IN_PROJECT=1`): + +```zsh +# Environment file for all projects. +# - (de)activates Python virtualenvs (.venv) from pipenv + +if [[ $autoenv_event == 'enter' ]]; then + autoenv_source_parent + + _my_autoenv_venv_chpwd() { + if [[ -z "$_ZSH_ACTIVATED_VIRTUALENV" && -n "$VIRTUAL_ENV" ]]; then + return + fi + + local -a venv + venv=(./(../)#.venv(NY1:A)) + + if [[ -n "$_ZSH_ACTIVATED_VIRTUALENV" ]]; then + if ! (( $#venv )) || [[ "$_ZSH_ACTIVATED_VIRTUALENV" != "$venv[1]" ]]; then + echo "De-activating virtualenv: $VIRTUAL_ENV" >&2 + deactivate + unset _ZSH_ACTIVATED_VIRTUALENV + fi + fi + + if [[ -z "$VIRTUAL_ENV" ]]; then + if (( $#venv )); then + echo "Activating virtualenv: $venv" >&2 + source $venv[1]/bin/activate + _ZSH_ACTIVATED_VIRTUALENV="$venv[1]" + fi + fi + } + autoload -U add-zsh-hook + add-zsh-hook chpwd _my_autoenv_venv_chpwd + _my_autoenv_venv_chpwd +else + add-zsh-hook -d chpwd _my_autoenv_venv_chpwd +fi +``` ## Related projects - https://github.com/direnv/direnv