[tor-commits] [ooni-probe/master] Update install.rst instructions

[art at torproject.org]

commit 0b13fabfa4c6279a21fc489df2da37273a9cff5c
Author: aagbsn <aagbsn at torproject.org>
Date:   Sun Oct 7 12:29:44 2012 -0700

    Update install.rst instructions
    
    Adds instructions for building Twisted
    Adds instructions for installing txtorcon and its dependencies
    Adds instructions for using python-virtualenv and virtualenvwrapper
    Adds additional debian package dependencies
    BeautifulSoup is now considered a required dependency, and must be
    built from source.
---
 docs/source/install.rst |   79 +++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 76 insertions(+), 3 deletions(-)

diff --git a/docs/source/install.rst b/docs/source/install.rst
index a2352d0..4651064 100644
--- a/docs/source/install.rst
+++ b/docs/source/install.rst
@@ -10,15 +10,89 @@ Dependencies
 
 OONI depends on the following pieces of software.
 
-* Twisted: http://twistedmatrix.com/trac/
+* Twisted (>12.0.0): http://twistedmatrix.com/trac/
 * PyYAML: http://pyyaml.org/
 * Scapy: http://www.secdev.org/projects/scapy/
     * pypcap: http://code.google.com/p/pypcap/
     * libdnet: http://code.google.com/p/libdnet/
+* BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
 
 *Optional*
 
-* BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
+* Dnspython[1]: http://www.dnspython.org/
+* Paramiko[2]: http://www.lag.net/paramiko/
+* Txtorcon: https://github.com/meejah/txtorcon
+
+[1][2] These dependencies will soon be removed completely.
+
+Debian packages
+---------------
+
+On debian you can install most of the dependecies with apt-get with this command::
+
+    apt-get install python-yaml python-scapy python-beautifulsoup python-pypcap python-dumbnet python-dnspython
+
+Note that debian (squeeze) distributes version 10.1.0 of python-twisted,
+and ubuntu (precise) distributes version 11.1.0.
+You need the following packages for twisted to compile::
+
+    apt-get install python-dev build-essential
+
+Txtorcon has the following addtitional dependencies::
+    
+    apt-get install python-geoip python-ipaddr python-psutil  
+
+Python virtual environmentsa (virtualenv)
+-----------------------------------------
+
+You may prefer to install these dependencies within a python virtualenv[3]::
+
+    sudo apt-get install python-virtualenv virtualenvwrapper
+
+From the docs (/usr/share/doc/virtualenvwrapper/README.Debian):
+
+    Virtualenvwrapper is enabled if you install the package bash-completion and
+    enable bash completion support in /etc/bash.bashrc or your ~/.bashrc.
+
+    If you only want to use virtualenvwrapper you may just add
+    source /etc/bash_completion.d/virtualenvwrapper to your ~/.bashrc.
+
+Source the script or login again and set up a virtualenv::
+
+    mkdir $HOME/.virtualenvs
+    mkvirtualenv ooni-probe
+
+You will automatically enter the environment. easy_install and pip will install
+packages inside this environment, and will not require root privileges.
+[3] http://www.virtualenv.org
+
+Manual installation of  python dependencies
+-------------------------------------------
+
+This involves installing the dependencies installable via easy_install/pip and
+the ones that are not by building them from source.
+
+"simple" dependencies via easy_install::
+
+    sudo easy_install pyyaml
+    sudo easy_install twisted
+    sudo easy_install beautifulsoup
+    sudo easy_install pygeoip
+    sudo easy_install six
+    sudo easy_install ipaddr
+    sudo easy_install psutil
+    sudo easy_install txtorcon
+
+"simple" dependencies via pip::
+
+    sudo pip install pyyaml
+    sudo pip install twisted
+    sudo pip install beautifulsoup
+    sudo pip install pygeoip
+    sudo pip install six
+    sudo pip install ipaddr
+    sudo pip install psutil
+    sudo pip install txtorcon
 
 Manual installation of scapy
 ----------------------------
@@ -52,4 +126,3 @@ scapy::
     cd scapy-2.2.0/
     sudo python setup.py install
     cd ../ && rm -rf scapy-*
-