adding docs for configuring and sourcing a virtualenv
authorSeth Woodworth <seth@sethish.com>
Wed, 2 Jan 2013 20:40:58 +0000 (15:40 -0500)
committerSeth Woodworth <seth@sethish.com>
Wed, 2 Jan 2013 20:40:58 +0000 (15:40 -0500)
docs/source/virtualenv.rst [new file with mode: 0644]

diff --git a/docs/source/virtualenv.rst b/docs/source/virtualenv.rst
new file mode 100644 (file)
index 0000000..2655211
--- /dev/null
@@ -0,0 +1,20 @@
+Virtualenv
+==========
+
+`Virtualenv <http://www.virtualenv.org/en/latest/index.html>`_ is a tool for managing python requirements.
+We use it to manage development and deployment requirements when we have multiple python projects on the same host.
+
+This isn't strictly required for the project, but we recommend it.
+You can install virtualenv with 
+
+    $ pip install virtualenv
+
+Then create an environment to contain karmaworld packages:
+
+    virtualenv venv
+
+And then activate the virtual enviroment with:
+
+    source ./venv/bin/activate
+
+Run this activate script before trying to run ./manage.py commands or other server commands.