From 4c77978ed2a3d03ebf32df3d5eca6c81b8cc26e7 Mon Sep 17 00:00:00 2001
From: Dolph Mathews <dolph.mathews@gmail.com>
Date: Fri, 30 Sep 2011 11:08:04 -0500
Subject: [PATCH] Organizing and documenting pypi requirements

Change-Id: I94d82f55eab5f4ce953fda3b3cb989b7660a7f80
---
 tools/pip-requires | 37 ++++++++++++++++++-------------------
 1 file changed, 18 insertions(+), 19 deletions(-)

diff --git a/tools/pip-requires b/tools/pip-requires
index 657d820309..7037173cad 100644
--- a/tools/pip-requires
+++ b/tools/pip-requires
@@ -3,32 +3,31 @@
 #   sudo apt-get install python-dev libxml2-dev libxslt1-dev libsasl2-dev libldap2-dev libsqlite3-dev libssl-dev
 
 # Production
-eventlet
-lxml
-paste
-pastedeploy
-pastescript
-pysqlite
-sqlalchemy
-webob
-Routes
-httplib2
-#For Hashing
-passlib
+httplib2 # handles additional HTTP features such as SSL, HEAD/PUT/DELETE, etc
+eventlet # scalable networking lib
+paste # wsgi framework
+pastedeploy # loads & configures wsgi apps
+pastescript # command line frontend
+webob # wsgi framework
+Routes # URL matching / controller routing
+sqlalchemy # core backend
+pysqlite # default backend database lib
+lxml # xml library providing ElementTree API
+passlib # password hashing
 
 # Optional backend: LDAP
-python-ldap==2.3.13
+python-ldap==2.3.13 # authenticate against an existing LDAP server
 
 # Optional backend: Memcache
-python-memcached
+python-memcached # increases performance of token validation calls
 
 # Development
 Sphinx # required to build documentation
 coverage # computes code coverage percentages
 
 # Testing
-webtest
-unittest2
-pylint
-pep8
-mox
+unittest2 # backport of unittest lib in python 2.7
+webtest # test wsgi apps without starting an http server
+pylint # static code analysis
+pep8 # checks for PEP8 code style compliance
+mox # mock object framework