diff README.txt @ 77:4415ba355f25

flush out README
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 02 Mar 2012 16:03:37 -0800
parents 5fbe4374bc8a
children d5c3fdceb718
line wrap: on
line diff
--- a/README.txt	Fri Mar 02 15:21:43 2012 -0800
+++ b/README.txt	Fri Mar 02 16:03:37 2012 -0800
@@ -16,7 +16,7 @@
 
 For security, ``SimPyPI`` returns straight
 `HTTP 400 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ s
-for invalid requests.
+for invalid requests.  This could probably be improved.
 
 ``SimPyPI`` itself does not serve this directory.  The directory
 should be served by a fileserver that will generate directory indices
@@ -24,6 +24,10 @@
 http://guide.python-distribute.org/contributing.html#the-simple-index-protocol
 ) such as Apache or
 `FileServer <http://pypi.python.org/pypi/FileServer>`_ .
+``simpypi.factory.factory`` does provide a factory to make a WSGI app
+that wraps ``FileServer`` in middleware and serves the simple index
+under ``/index/`` and the ``SimPyPI`` app at ``/``.  Additionally, a
+``simpypi`` command line program is provided that front-ends this.
 
 Currently ``simpypi`` only works on source distributions (that is,
 packages made with ``python setup.py sdist``).
@@ -33,6 +37,12 @@
 
 ``tests-require.txt`` contains dependencies that should be installed
 to run the tests.
+`Paste <http://pythonpaste.org/>`_
+`TestApp <http://pythonpaste.org/testing-applications.html>`_ ,
+though this could be transitioned to
+`WebTest <http://webtest.pythonpaste.org/en/latest/index.html>`_ .
+`virtualenv <http://www.virtualenv.org/>`_
+is used for isolating python environments.
 
 TODO
 ----