How do I?

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Python Virtual Environments ======

==== What and Why ====
A Virtual Environment is a tool to keep the dependencies required by different projects in separate places, by creating virtual Python environments for them. It solves the “Project X depends on version 1.x but, Project Y needs 4.x” dilemma, and keeps your global site-packages directory clean and manageable. For example, you can work on a project which requires Django 1.3 while also maintaining a project which requires Django 1.0. ((http://docs.python-guide.org/en/latest/dev/virtualenvs))

==== Using Virtual Environments ====
The python virtual environment package is installed by default on most CS machines. To make sure you can do the following:
<code>
user@computer:~/projects$ which virtualenv
/usr/bin/virtualenv
</code>

==== Creating a new project ====
<code>
user@hester:~/projects$ virtualenv --no-site-packages exampleproject
The --no-site-packages flag is deprecated; it is now the default behavior.
New python executable in exampleproject/bin/python
Installing
distribute................................................................................done.
Installing pip...............done.
</code>
<code>
user@computer:~/projects$ ls -l exampleproject/
total 4
drwxrwxr-x 2 user group 4096 Nov 25 10:16 bin
drwxrwxr-x 2 user group   30 Nov 25 10:16 include
drwxrwxr-x 3 user group   30 Nov 25 10:16 lib
drwxrwxr-x 2 user group   56 Nov 25 10:16 local
</code>
<code>
user@computer:~/projects$ cd exampleproject/
</code>

==== Activate ====
Now you need to activate your virtual environment. This will setup some path variables to make the evironments bin and lib directory to be the default.
<code>
user@computer:~/projects/exampleproject$ source bin/activate
(exampleproject)user@computer:~/projects/exampleproject$ 
</code>
==== Deactivate ====
To deactivate or stop working on your environment use the fuction that gets sourced when you activate your environment:
<code>
(exampleproject)user@computer:~/projects/exampleproject$ deactivate
user@computer:~/projects/exampleproject$ 
</code>

====== virtualenvwrapper ======
virtualenvwrappers goal is to make virtualenv easier to use... sort of like when iTunes automatically organizes your iTunes library.

==== Basic Usage ====
=== Create a virtual environment ===
This creates the exampleproject folder inside ~/Envs.
<code>
user@computer:~/$ mkvirtualenv venv
</code>

=== Work on a virtual environment ===
'virtualenvwrapper' provides tab-completion on environment names. It really helps when you have a lot of environments and have trouble remembering their names.
'workon' also deactivates whatever environment you are currently in, so you can quickly switch between environments.
<code>
user@computer:~/$ workon venv
</code>

Deactivating is still the same:
<code>
user@computer:~/$ deactivate
</code>
To delete:
<code>
user@computer:~/$ rmvirtualenv venv
</code>

=== Other useful commands ===
<code>
lsvirtualenv
  List all of the environments.
cdvirtualenv
  Navigate into the directory of the currently activated virtual environment, 
  so you can browse its site-packages, for example.
cdsitepackages
  Like the above, but directly into site-packages directory.
lssitepackages
  Shows contents of site-packages directory.
</code>