# HG changeset patch
# User Jeff Hammel <jhammel@mozilla.com>
# Date 1330729026 28800
# Node ID 80915340198628d8567a6019153ad4a3d75f25c7
# Parent  0e84dd7d740afc9715eedea1acb20851b22620fe
update documentation

diff -r 0e84dd7d740a -r 809153401986 README.txt
--- a/README.txt	Fri Mar 02 13:12:08 2012 -0800
+++ b/README.txt	Fri Mar 02 14:57:06 2012 -0800
@@ -1,7 +1,13 @@
 simpypi
 =======
 
-Simple pypi package
+Simple python package index
+
+How simpypi works
+-----------------
+
+Currently ``simpypi`` only works on source distributions (that is,
+packages made with ``python setup.py sdist``).
 
 Running the Tests
 -----------------
@@ -12,7 +18,22 @@
 TODO
 ----
 
- * the temporary package should be dealt with entirely in memory
+While simpypi is pretty simple, just because it is only 100 lines of
+code doesn't mean that it is the *right* 100 lines of code.  The
+following issues could be addressed:
+
+ * the temporary package should be dealt with entirely in memory,
+   ideally.  Currently we write to a file and move it.
+
+ * ``simpypi`` use ``pkginfo.sdist`` to read the data from a source
+   distribution. Instead, the uploaded package should probably be
+   unpacked and ``python setup.py sdist`` run and the resulting
+   package put in the appropriate place.  This will allow archives
+   without ``PKG-INFO``
+   (e.g. http://hg.mozilla.org/build/talos/archive/tip.tar.gz )
+   to be uploaded as well as at least partially correct for the fact
+   that currently ``simpypi`` only works for uploaded source
+   distributions.
 
 --
 
diff -r 0e84dd7d740a -r 809153401986 simpypi/wsgi.py
--- a/simpypi/wsgi.py	Fri Mar 02 13:12:08 2012 -0800
+++ b/simpypi/wsgi.py	Fri Mar 02 14:57:06 2012 -0800
@@ -1,8 +1,3 @@
-"""
-request dispatcher:
-data persisting across requests should go here
-"""
-
 import os
 import pkginfo
 import shutil
@@ -12,6 +7,7 @@
 here = os.path.dirname(os.path.abspath(__file__))
 
 class SimPyPI(object):
+    """Simple Python Package Index"""
 
     def __init__(self, directory, index=None):