comparison 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
comparison
equal deleted inserted replaced
75:809153401986 76:5fbe4374bc8a
3 3
4 Simple python package index 4 Simple python package index
5 5
6 How simpypi works 6 How simpypi works
7 ----------------- 7 -----------------
8
9 The heart of simpypi is ``simpypi.wsgi.SimPyPI``, a simple
10 `WSGI <http://www.python.org/dev/peps/pep-0333/>`_ web app that
11 accepts a uploaded
12 `python package <http://guide.python-distribute.org/introduction.html>`_
13 distribution and places it according to its name and version metadata
14 appropriate to the
15 `simple index protocol <http://guide.python-distribute.org/contributing.html#the-simple-index-protocol>`_ .
16
17 For security, ``SimPyPI`` returns straight
18 `HTTP 400 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ s
19 for invalid requests.
20
21 ``SimPyPI`` itself does not serve this directory. The directory
22 should be served by a fileserver that will generate directory indices
23 (as apprpropriate to
24 http://guide.python-distribute.org/contributing.html#the-simple-index-protocol
25 ) such as Apache or
26 `FileServer <http://pypi.python.org/pypi/FileServer>`_ .
8 27
9 Currently ``simpypi`` only works on source distributions (that is, 28 Currently ``simpypi`` only works on source distributions (that is,
10 packages made with ``python setup.py sdist``). 29 packages made with ``python setup.py sdist``).
11 30
12 Running the Tests 31 Running the Tests