Mercurial > hg > simpypi
diff README.txt @ 76:5fbe4374bc8a
more documentation
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Fri, 02 Mar 2012 15:21:43 -0800 |
parents | 809153401986 |
children | 4415ba355f25 |
line wrap: on
line diff
--- a/README.txt Fri Mar 02 14:57:06 2012 -0800 +++ b/README.txt Fri Mar 02 15:21:43 2012 -0800 @@ -6,6 +6,25 @@ How simpypi works ----------------- +The heart of simpypi is ``simpypi.wsgi.SimPyPI``, a simple +`WSGI <http://www.python.org/dev/peps/pep-0333/>`_ web app that +accepts a uploaded +`python package <http://guide.python-distribute.org/introduction.html>`_ +distribution and places it according to its name and version metadata +appropriate to the +`simple index protocol <http://guide.python-distribute.org/contributing.html#the-simple-index-protocol>`_ . + +For security, ``SimPyPI`` returns straight +`HTTP 400 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ s +for invalid requests. + +``SimPyPI`` itself does not serve this directory. The directory +should be served by a fileserver that will generate directory indices +(as apprpropriate to +http://guide.python-distribute.org/contributing.html#the-simple-index-protocol +) such as Apache or +`FileServer <http://pypi.python.org/pypi/FileServer>`_ . + Currently ``simpypi`` only works on source distributions (that is, packages made with ``python setup.py sdist``).