A bash script to setup various settings for a django virtualenv

mkdjangovirtualenv.sh

#!/usr/bin/env bash

#
# Make a virtualenv specifically for a django project using virtualenvwrapper
#
# *   Set the project directory in the .project file
# *   Set the DJANGO_SETTINGS_MODULE and PYTHONPATH in postactivate
# *   Install pip requirements if there's a requirements.txt file
# *   Install git submodules if a git repo with submodules
#

_settings='project.settings'
_env_name=
_collect_path=


die () {
    if [ $# != 0 ]; then
        echo >&2 "$@"
        echo
    fi
    echo "Usage: source `basename $0` [--settings DJANGO__settings_MODULE]"\
         "ENV_NAME [PROJECT_DIRECTORY]"
    echo
    echo " --settings DJANGO_SETTINGS_MODULE"
    echo
    echo "    Provide a python import path for the settings file."
    echo "    Defaults to ${_settings}"
    echo
    exit 1
}


## make sure we're not in another virtualenv
deactivate > /dev/null 2>&1


## load virtualenvwrapper in case this wasn't called via `source`
if [ "`type -t mkvirtualenv`" != function ]; then
    _wrapper_locations="
/usr/local/share/python/virtualenvwrapper.sh
/usr/local/bin/virtualenvwrapper.sh
/usr/bin/virtualenvwrapper.sh"
    _wrapper_success=
    for f in $_wrapper_locations; do
        if [ -e "$f" ]; then
            source $f && _wrapper_success=1
            break
        fi
    done
    if [ ! $_wrapper_success ]; then
        die "Unable to find virtualenvwrapper.sh in the standard locations:\
            ${_wrapper_locations}";
    fi
fi


## parse args
until [ -z "$1" ]; do
    case $1 in
        --settings|-s )
            shift
            _settings=$1
            ;;
        --help|-h )
            die
            ;;
        -* )
            die "Unrecognized option: $1"
            ;;
        * )
            if [ ! $_env_name ]; then
                _env_name=$1
            elif [ ! $_collect_path ]; then
                _collect_path=$1
            else
                die "Invalid number of arguments."
            fi
            ;;
    esac
    shift
    if [ "$#" = "0" ]; then break; fi
done

if [ ! $_collect_path ]; then _collect_path=`pwd`; fi
if [ ! $_env_name ]; then die "You must specify the name of your environment."; fi


## start from the proper directory
cd $_collect_path


## create virtual env
echo
echo "## setting up virtualenv: ${_env_name}"
echo
mkvirtualenv -a `pwd` $_env_name || die "Unable to create virtualenv with name ${_env_name}"


## set DJANGO_SETTINGS_MODULE and PYTHONPATH in postactivate
echo "
export DJANGO_SETTINGS_MODULE=\"${_settings}\"
export PYTHONPATH=`pwd`" >> ~/.virtualenvs/$_env_name/bin/postactivate
source ~/.virtualenvs/$_env_name/bin/postactivate


## try to install requirements - separate from [-r requirements_file]
if [ -e "requirements.txt" ]; then
    echo
    echo "## installing pip requirements"
    echo
    pip install -r requirements.txt
    if (( $? )); then echo "Error installing requirements..."; fi
fi


## try to pull down submodules
git status > /dev/null 2>&1
if [ $? == 0 ]; then
    echo
    echo "## checking for submodules"
    echo
    git submodule init
    git submodule update
fi


## print out results
_tpath=~/.virtualenvs/$_env_name/.project
echo
echo "##"
echo "## new project path (${_tpath}):"
echo "##"
echo
cat $_tpath

_tpath=~/.virtualenvs/$_env_name/bin/postactivate
echo
echo "##"
echo "## postactivate script (${_tpath}):"
echo "##"
echo
cat $_tpath

echo
echo "##"
echo "## Work on your project with..."
echo "##"
echo
echo "workon ${_env_name}"
echo

This is script simplifies the setup steps that you might do after pulling down a django git project and then creating a virtualenv for it. It covers the following steps:

• Set the project directory in the .project file
• Set the DJANGO_SETTINGS_MODULE and PYTHONPATH in postactivate.
• Install pip requirements.
• Install git submodules if possible.

This is meant to be used to setup the environment for an existing django project, and can be used like this:

git clone <a_django_repo>
source mkdjangovirtualenv.sh --settings "project.settings" <name_of_the_new_envirnoment> <path_to_the_local_repo>