Mercurial > hg > simpypi

comparison README.txt @ 77:4415ba355f25

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
flush out README
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 02 Mar 2012 16:03:37 -0800
parents 5fbe4374bc8a
children d5c3fdceb718
comparison
equal deleted inserted replaced
76:5fbe4374bc8a 77:4415ba355f25
14 appropriate to the 14 appropriate to the
15 `simple index protocol <http://guide.python-distribute.org/contributing.html#the-simple-index-protocol>`_ . 15 `simple index protocol <http://guide.python-distribute.org/contributing.html#the-simple-index-protocol>`_ .
16 16
17 For security, ``SimPyPI`` returns straight 17 For security, ``SimPyPI`` returns straight
18 `HTTP 400 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ s 18 `HTTP 400 <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html>`_ s
19 for invalid requests. 19 for invalid requests. This could probably be improved.
20 20
21 ``SimPyPI`` itself does not serve this directory. The directory 21 ``SimPyPI`` itself does not serve this directory. The directory
22 should be served by a fileserver that will generate directory indices 22 should be served by a fileserver that will generate directory indices
23 (as apprpropriate to 23 (as apprpropriate to
24 http://guide.python-distribute.org/contributing.html#the-simple-index-protocol 24 http://guide.python-distribute.org/contributing.html#the-simple-index-protocol
25 ) such as Apache or 25 ) such as Apache or
26 `FileServer <http://pypi.python.org/pypi/FileServer>`_ . 26 `FileServer <http://pypi.python.org/pypi/FileServer>`_ .
27 ``simpypi.factory.factory`` does provide a factory to make a WSGI app
28 that wraps ``FileServer`` in middleware and serves the simple index
29 under ``/index/`` and the ``SimPyPI`` app at ``/``. Additionally, a
30 ``simpypi`` command line program is provided that front-ends this.
27 31
28 Currently ``simpypi`` only works on source distributions (that is, 32 Currently ``simpypi`` only works on source distributions (that is,
29 packages made with ``python setup.py sdist``). 33 packages made with ``python setup.py sdist``).
30 34
31 Running the Tests 35 Running the Tests
32 ----------------- 36 -----------------
33 37
34 ``tests-require.txt`` contains dependencies that should be installed 38 ``tests-require.txt`` contains dependencies that should be installed
35 to run the tests. 39 to run the tests.
40 `Paste <http://pythonpaste.org/>`_
41 `TestApp <http://pythonpaste.org/testing-applications.html>`_ ,
42 though this could be transitioned to
43 `WebTest <http://webtest.pythonpaste.org/en/latest/index.html>`_ .
44 `virtualenv <http://www.virtualenv.org/>`_
45 is used for isolating python environments.
36 46
37 TODO 47 TODO
38 ---- 48 ----
39 49
40 While simpypi is pretty simple, just because it is only 100 lines of 50 While simpypi is pretty simple, just because it is only 100 lines of