Merge lp:~soren/surveilr/add-venv-and-readme into lp:surveilr

[Soren Hansen]

Add a utility to setup a virtualenv and a README.md documenting how to use it.

=== added file 'README.md'
--- README.md	1970-01-01 00:00:00 +0000
+++ README.md	2011-11-30 22:05:27 +0000
@@ -0,0 +1,25 @@
+# Getting Started #
+
+Starting with an Ubuntu Oneiric box, install Riak:
+
+## Riak setup ##
+
+    wget http://downloads.basho.com/riak/CURRENT/riak_1.0.2-1_ubuntu_11_amd64.deb
+	sudo dpkg -i riak_1.0.2-1_ubuntu_11_amd64.deb
+
+You need to make a few changes to Riak's app.config.
+
+    sudo sed -e '/^ {riak_kv/ a {delete_mode, immediate},' \
+             -e 's/storage_backend, riak_kv_bitcask_backend/storage_backend, riak_kv_eleveldb_backend/' \
+             -e '/^ {riak_search/,+2 s/enabled, false/enabled, true/' -i.bak /etc/riak/app.config
+
+Now we're ready to start Riak:
+
+    sudo /etc/init.d/riak start
+
+## Other dependencies ##
+
+`tools/setup_virtualenv.sh` will pull in all the necessary dependencies and should let you run the test suite:
+
+    tools/setup_virtualenv.sh
+	.venv/bin/python setup.py nosetests

=== added directory 'tools'
=== added file 'tools/pip-requirements.txt'
--- tools/pip-requirements.txt	1970-01-01 00:00:00 +0000
+++ tools/pip-requirements.txt	2011-11-30 22:05:27 +0000
@@ -0,0 +1,8 @@
+-e git://github.com/basho/riak-python-client.git@master#egg=riak
+-e bzr+http://bazaar.launchpad.net/~linux2go-jenkins/riakalchemy/trunk#egg=riakalchemy
+nose
+routes
+webob
+python-clickatell
+mock
+eventlet

=== added file 'tools/setup_virtualenv.sh'
--- tools/setup_virtualenv.sh	1970-01-01 00:00:00 +0000
+++ tools/setup_virtualenv.sh	2011-11-30 22:05:27 +0000
@@ -0,0 +1,8 @@
+#!/bin/bash
+
+topdir=$(dirname $0)/../
+cd $topdir
+
+rm -rf .venv
+virtualenv --no-site-packages .venv
+.venv/bin/pip install -r tools/pip-requirements.txt