Source

virtualenvwrapper / virtualenvwrapper_bashrc

Full commit
Doug Hellmann d5fffcb 
Doug Hellmann 6172dee 
Doug Hellmann b80c26f 


Doug Hellmann 6172dee 



Doug Hellmann 218a10a 


Doug Hellmann 6172dee 
Doug Hellmann 218a10a 
Doug Hellmann 6172dee 
Doug Hellmann 218a10a 







Doug Hellmann 6172dee 


Doug Hellmann 45a4c44 
Doug Hellmann 6172dee 




Doug Hellmann 0a86a4f 

Doug Hellmann c11ee79 
Doug Hellmann 0a86a4f 

Doug Hellmann 6172dee 
Doug Hellmann d8112e5 
Doug Hellmann 6172dee 

w...@talyn.cisco… e9a9d1c 
Doug Hellmann 6172dee 




Doug Hellmann eddb292 















































Doug Hellmann 218a10a 
Doug Hellmann c11ee79 















Doug Hellmann 0b39409 
Doug Hellmann d8112e5 
Doug Hellmann ebfcd01 

Doug Hellmann 0b39409 
w...@talyn.cisco… e9a9d1c 
Doug Hellmann 0b39409 




Doug Hellmann ebfcd01 
Doug Hellmann d8112e5 
Doug Hellmann fb56732 
Doug Hellmann ebfcd01 
w...@talyn.cisco… e9a9d1c 
Doug Hellmann ebfcd01 




Doug Hellmann 09365bc 
Doug Hellmann d8112e5 







Doug Hellmann 09365bc 
Doug Hellmann d8112e5 








Doug Hellmann 45a4c44 




Doug Hellmann 6172dee 
Doug Hellmann dca7642 
Doug Hellmann a423ba6 
Doug Hellmann c11ee79 
Doug Hellmann 2453f61 

Doug Hellmann d8112e5 

Doug Hellmann 2453f61 



Doug Hellmann eddb292 




Doug Hellmann dca7642 
Doug Hellmann e3cca27 
Doug Hellmann 6172dee 

Doug Hellmann 45a4c44 
Doug Hellmann 6172dee 

Doug Hellmann a423ba6 
Doug Hellmann 09cbcc9 
Doug Hellmann 8c46828 
w...@talyn.cisco… e9a9d1c 
Doug Hellmann 8c46828 

Doug Hellmann 6172dee 
Doug Hellmann 09cbcc9 
Doug Hellmann 6172dee 
w...@talyn.cisco… e9a9d1c 

Doug Hellmann 6172dee 

Doug Hellmann d8112e5 
Doug Hellmann 6172dee 
Doug Hellmann d8112e5 
Doug Hellmann 6172dee 

Doug Hellmann 45a4c44 
Doug Hellmann d8112e5 
Doug Hellmann a423ba6 
Doug Hellmann 91777a6 

Doug Hellmann 2453f61 
Doug Hellmann c11ee79 
Doug Hellmann 2453f61 
Doug Hellmann 6172dee 

Doug Hellmann 45a4c44 



Doug Hellmann 6172dee 



Doug Hellmann d8112e5 
Doug Hellmann 6172dee 


Doug Hellmann d8112e5 

Doug Hellmann 0b39409 
Doug Hellmann 6172dee 


w...@talyn.cisco… e9a9d1c 
Doug Hellmann 6172dee 

Doug Hellmann 2683617 
Doug Hellmann 0a86a4f 







Doug Hellmann 2683617 
Doug Hellmann 6172dee 
Doug Hellmann 2683617 
Doug Hellmann 0a86a4f 





















ChrisHas35 23827b3 
Doug Hellmann 511994f 

ChrisHas35 23827b3 
Doug Hellmann 6172dee 
Doug Hellmann 4738f0b 

Doug Hellmann 0a86a4f 
Doug Hellmann 4738f0b 




Doug Hellmann 8bea150 



Doug Hellmann d8112e5 
Doug Hellmann 8bea150 

w...@talyn.cisco… e9a9d1c 






Doug Hellmann 8bea150 


Doug Hellmann d8112e5 
Doug Hellmann 8bea150 
Doug Hellmann ebfcd01 
Doug Hellmann 09365bc 









Doug Hellmann ebfcd01 
Doug Hellmann 2579189 
Doug Hellmann ebfcd01 










Doug Hellmann d8112e5 
Doug Hellmann ebfcd01 
Doug Hellmann 09365bc 
Doug Hellmann ebfcd01 


w...@talyn.cisco… e9a9d1c 
Doug Hellmann ebfcd01 


Doug Hellmann fb56732 
Doug Hellmann ebfcd01 












Doug Hellmann fb56732 
Doug Hellmann ebfcd01 

Doug Hellmann 8af191b 





Doug Hellmann ebfcd01 


James Bennett a3bb5e5 



Doug Hellmann dda0e4d 
Doug Hellmann 09365bc 

James Bennett a3bb5e5 



Doug Hellmann dda0e4d 
w...@talyn.cisco… ad1ac90 
James Bennett a3bb5e5 
Sander Smits 7fe9ee2 




Doug Hellmann 09365bc 

Sander Smits 7744f50 







Sander Smits 7fe9ee2 
# -*- mode: shell-script -*-
#
# Shell functions to act as wrapper for Ian Bicking's virtualenv
# (http://pypi.python.org/pypi/virtualenv)
#

#
# Setup:
#
#  1. Create a directory to hold the virtual environments.
#     (mkdir $HOME/.virtualenvs).
#  2. Add a line like "export WORKON_HOME=$HOME/.virtualenvs"
#     to your .bashrc.
#  3. Add a line like "source /path/to/this/file/virtualenvwrapper_bashrc"
#     to your .bashrc.
#  4. Run: source ~/.bashrc
#  5. Run: workon
#  6. A list of environments, empty, is printed.
#  7. Run: mkvirtualenv temp
#  8. Run: workon
#  9. This time, the "temp" environment is included.
# 10. Run: workon temp
# 11. The virtual environment is activated.
#

# Make sure there is a default value for WORKON_HOME.
# You can override this setting in your .bashrc.
if [ "$WORKON_HOME" = "" ]
then
    export WORKON_HOME="$HOME/.virtualenvs"
fi

# Normalize the directory name in case it includes 
# relative path components.
WORKON_HOME=$(python -c "import os; print os.path.abspath(os.path.expandvars(os.path.expanduser(\"$WORKON_HOME\")))")
export WORKON_HOME

# Verify that the WORKON_HOME directory exists
function virtualenvwrapper_verify_workon_home () {
    if [ ! -d "$WORKON_HOME" ]
    then
        echo "ERROR: Virtual environments directory '$WORKON_HOME' does not exist." >&2
        return 1
    fi
    return 0
}

# Create a hook script
#
# Usage: virtualenvwrapper_make_hook filename comment
#
function virtualenvwrapper_make_hook () {
    filename="$1"
    comment="$2"
    if [ ! -f "$filename" ]
    then
        #echo "Creating $filename"
        cat - > "$filename" <<EOF
#!/bin/sh
# $comment

EOF
    fi
    if [ ! -x "$filename" ]
    then
        chmod +x "$filename"
    fi
}

# Set up virtualenvwrapper properly
function virtualenvwrapper_initialize () {
    virtualenvwrapper_verify_workon_home || return 1
    # mkvirtualenv
    virtualenvwrapper_make_hook "$WORKON_HOME/premkvirtualenv" \
        "This hook is run after a new virtualenv is created and before it is activated."
    virtualenvwrapper_make_hook "$WORKON_HOME/postmkvirtualenv" \
        "This hook is run after a new virtualenv is activated."
    # rmvirtualenv
    virtualenvwrapper_make_hook "$WORKON_HOME/prermvirtualenv" \
        "This hook is run before a virtualenv is deleted."
    virtualenvwrapper_make_hook "$WORKON_HOME/postrmvirtualenv" \
        "This hook is run after a virtualenv is deleted."
    # deactivate
    virtualenvwrapper_make_hook "$WORKON_HOME/predeactivate" \
        "This hook is run before every virtualenv is deactivated."
    virtualenvwrapper_make_hook "$WORKON_HOME/postdeactivate" \
        "This hook is run after every virtualenv is deactivated."
    # activate
    virtualenvwrapper_make_hook "$WORKON_HOME/preactivate" \
        "This hook is run before every virtualenv is activated."
    virtualenvwrapper_make_hook "$WORKON_HOME/postactivate" \
        "This hook is run after every virtualenv is activated."
}

virtualenvwrapper_initialize

# Verify that virtualenv is installed and visible
function virtualenvwrapper_verify_virtualenv () {
    venv=$(which virtualenv | grep -v "not found")
    if [ "$venv" = "" ]
    then
        echo "ERROR: virtualenvwrapper could not find virtualenv in your path" >&2
        return 1
    fi
    if [ ! -e "$venv" ]
    then
        echo "ERROR: Found virtualenv in path as \"$venv\" but that does not exist" >&2
        return 1
    fi
    return 0
}

# Verify that the requested environment exists
function virtualenvwrapper_verify_workon_environment () {
    typeset env_name="$1"
    if [ ! -d "$WORKON_HOME/$env_name" ]
    then
       echo "ERROR: Environment '$env_name' does not exist. Create it with 'mkvirtualenv $env_name'." >&2
       return 1
    fi
    return 0
}

# Verify that the active environment exists
function virtualenvwrapper_verify_active_environment () {
    if [ ! -n "${VIRTUAL_ENV}" ] || [ ! -d "${VIRTUAL_ENV}" ]
    then
        echo "ERROR: no virtualenv active, or active virtualenv is missing" >&2
        return 1
    fi
    return 0
}

# Run a hook script in the current shell
function virtualenvwrapper_source_hook () {
    scriptname="$1"
    if [ -f "$scriptname" ]
    then
        source "$scriptname"
    fi
}

# Run a hook script in its own shell
function virtualenvwrapper_run_hook () {
    scriptname="$1"
    shift
    if [ -x "$scriptname" ]
    then
        "$scriptname" "$@"
    fi
}

# Create a new environment, in the WORKON_HOME.
#
# Usage: mkvirtualenv [options] ENVNAME
# (where the options are passed directly to virtualenv)
#
function mkvirtualenv () {
    eval "envname=\$$#"
    virtualenvwrapper_verify_workon_home || return 1
    virtualenvwrapper_verify_virtualenv || return 1
    (cd "$WORKON_HOME" &&
        virtualenv "$@" &&
        virtualenvwrapper_run_hook "./premkvirtualenv" "$envname"
        )
    # If they passed a help option or got an error from virtualenv,
    # the environment won't exist.  Use that to tell whether
    # we should switch to the environment and run the hook.
    [ ! -d "$WORKON_HOME/$envname" ] && return 0
    # Create stubs for the environment-specific hook scripts.
    virtualenvwrapper_make_hook "$WORKON_HOME/$envname/bin/postactivate" "This hook is sourced after the virtualenv is activated."
    virtualenvwrapper_make_hook "$WORKON_HOME/$envname/bin/predeactivate" "This hook is sourced before the virtualenv is deactivated."
    virtualenvwrapper_make_hook "$WORKON_HOME/$envname/bin/postdeactivate" "This hook is sourced after the virtualenv is deactivated."
    # Now activate the new environment
    workon "$envname"
    virtualenvwrapper_source_hook "$WORKON_HOME/postmkvirtualenv"
}

# Remove an environment, in the WORKON_HOME.
function rmvirtualenv () {
    typeset env_name="$1"
    virtualenvwrapper_verify_workon_home || return 1
    if [ "$env_name" = "" ]
    then
        echo "Please specify an enviroment." >&2
        return 1
    fi
    env_dir="$WORKON_HOME/$env_name"
    if [ "$VIRTUAL_ENV" = "$env_dir" ]
    then
        echo "ERROR: You cannot remove the active environment ('$env_name')." >&2
        echo "Either switch to another environment, or run 'deactivate'." >&2
        return 1
    fi
    virtualenvwrapper_run_hook "$WORKON_HOME/prermvirtualenv" "$env_dir"
    rm -rf "$env_dir"
    virtualenvwrapper_run_hook "$WORKON_HOME/postrmvirtualenv" "$env_dir"
}

# List the available environments.
function virtualenvwrapper_show_workon_options () {
    virtualenvwrapper_verify_workon_home || return 1
    # NOTE: DO NOT use ls here because colorized versions spew control characters
    #       into the output list.
    # echo seems a little faster than find, even with -depth 3.
    (cd "$WORKON_HOME"; for f in */bin/activate; do echo $f; done) 2>/dev/null | sed 's|^\./||' | sed 's|/bin/activate||' | sort
#    (cd "$WORKON_HOME"; find -L . -depth 3 -path '*/bin/activate') | sed 's|^\./||' | sed 's|/bin/activate||' | sort
}

# List or change working virtual environments
#
# Usage: workon [environment_name]
#
function workon () {
	typeset env_name="$1"
	if [ "$env_name" = "" ]
    then
        virtualenvwrapper_show_workon_options
        return 1
    fi

    virtualenvwrapper_verify_workon_home || return 1
    virtualenvwrapper_verify_workon_environment $env_name || return 1
    
    activate="$WORKON_HOME/$env_name/bin/activate"
    if [ ! -f "$activate" ]
    then
        echo "ERROR: Environment '$WORKON_HOME/$env_name' does not contain an activate script." >&2
        return 1
    fi
    
    # Deactivate any current environment "destructively"
    # before switching so we use our override function,
    # if it exists.
    type deactivate >/dev/null 2>&1
    if [ $? -eq 0 ]
    then
        deactivate
    fi
    
    source "$activate"
    
    # Save the deactivate function from virtualenv
    virtualenvwrapper_saved_deactivate=$(typeset -f deactivate)

    # Replace the deactivate() function with a wrapper.
    eval 'function deactivate () {
        # Call the local hook before the global so we can undo
        # any settings made by the local postactivate first.
        virtualenvwrapper_source_hook "$VIRTUAL_ENV/bin/predeactivate"
        virtualenvwrapper_source_hook "$WORKON_HOME/predeactivate"
        
        env_postdeactivate_hook="$VIRTUAL_ENV/bin/postdeactivate"
        
        # Restore the original definition of deactivate
        eval "$virtualenvwrapper_saved_deactivate"

        # Instead of recursing, this calls the now restored original function.
        deactivate

        virtualenvwrapper_source_hook "$env_postdeactivate_hook"
        virtualenvwrapper_source_hook "$WORKON_HOME/postdeactivate"
    }'
    
    virtualenvwrapper_source_hook "$WORKON_HOME/postactivate"

    virtualenvwrapper_source_hook "$VIRTUAL_ENV/bin/postactivate"    
    
	return 0
}


#
# Set up tab completion.  (Adapted from Arthur Koziel's version at 
# http://arthurkoziel.com/2008/10/11/virtualenvwrapper-bash-completion/)
# 

if [ -n "$BASH" ] ; then
    _virtualenvs ()
    {
        local cur="${COMP_WORDS[COMP_CWORD]}"
        COMPREPLY=( $(compgen -W "`virtualenvwrapper_show_workon_options`" -- ${cur}) )
    }

    _cdvirtualenv_complete ()
    {
        local cur="$2"
        # COMPREPLY=( $(compgen -d -- "${VIRTUAL_ENV}/${cur}" | sed -e "s@${VIRTUAL_ENV}/@@" ) )
        COMPREPLY=( $(cdvirtualenv && compgen -d -- "${cur}" ) )
    }
    complete -o nospace -F _cdvirtualenv_complete -S/ cdvirtualenv
    complete -o default -o nospace -F _virtualenvs workon
    complete -o default -o nospace -F _virtualenvs rmvirtualenv
elif [ -n "$ZSH_VERSION" ] ; then
    compctl -g "`virtualenvwrapper_show_workon_options`" workon rmvirtualenv
fi

# Prints the Python version string for the current interpreter.
function virtualenvwrapper_get_python_version () {
    python -c 'import sys; print ".".join(str(p) for p in sys.version_info[:2])'
}

# Prints the path to the site-packages directory for the current environment.
function virtualenvwrapper_get_site_packages_dir () {
    echo "$VIRTUAL_ENV/lib/python`virtualenvwrapper_get_python_version`/site-packages"    
}

# Path management for packages outside of the virtual env.
# Based on a contribution from James Bennett and Jannis Leidel.
#
# add2virtualenv directory1 directory2 ...
#
# Adds the specified directories to the Python path for the
# currently-active virtualenv. This will be done by placing the
# directory names in a path file named
# "virtualenv_path_extensions.pth" inside the virtualenv's
# site-packages directory; if this file does not exist, it will be
# created first.
function add2virtualenv () {

    virtualenvwrapper_verify_active_environment || return 1
    
    site_packages="`virtualenvwrapper_get_site_packages_dir`"
    
    if [ ! -d "${site_packages}" ]
    then
        echo "ERROR: currently-active virtualenv does not appear to have a site-packages directory" >&2
        return 1
    fi
    
    path_file="$site_packages/virtualenv_path_extensions.pth"

    if [ "$*" = "" ]
    then
        echo "Usage: add2virtualenv dir [dir ...]"
        if [ -f "$path_file" ]
        then
            echo
            echo "Existing paths:"
            cat "$path_file"
        fi
        return 1
    fi

    touch "$path_file"
    for pydir in "$@"
    do
        absolute_path=$(python -c "import os; print os.path.abspath(\"$pydir\")")
        if [ "$absolute_path" != "$pydir" ]
        then
            echo "Warning: Converting \"$pydir\" to \"$absolute_path\"" 1>&2
        fi
        echo "$absolute_path" >> "$path_file"
    done
    return 0
}

# Does a ``cd`` to the site-packages directory of the currently-active
# virtualenv.
function cdsitepackages () {
    virtualenvwrapper_verify_active_environment || return 1
    site_packages="`virtualenvwrapper_get_site_packages_dir`"
    cd "$site_packages"
}

# Does a ``cd`` to the root of the currently-active virtualenv.
function cdvirtualenv () {
    virtualenvwrapper_verify_active_environment || return 1
    cd $VIRTUAL_ENV/$1
}

# Shows the content of the site-packages directory of the currently-active
# virtualenv
function lssitepackages () {
    virtualenvwrapper_verify_active_environment || return 1
    site_packages="`virtualenvwrapper_get_site_packages_dir`"
    ls $@ $site_packages
    
    path_file="$site_packages/virtualenv_path_extensions.pth"
    if [ -f "$path_file" ]
    then
        echo
        echo "virtualenv_path_extensions.pth:"
        cat "$path_file"
    fi
}