Mercurial > hg > simpypi
annotate 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 |
| rev | line source |
|---|---|
| 0 | 1 simpypi |
|
33
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
2 ======= |
| 0 | 3 |
| 75 | 4 Simple python package index |
| 5 | |
| 6 How simpypi works | |
| 7 ----------------- | |
| 8 | |
| 76 | 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>`_ . | |
| 27 | |
| 75 | 28 Currently ``simpypi`` only works on source distributions (that is, |
| 29 packages made with ``python setup.py sdist``). | |
| 0 | 30 |
|
33
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
31 Running the Tests |
|
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
32 ----------------- |
|
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
33 |
|
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
34 ``tests-require.txt`` contains dependencies that should be installed |
|
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
35 to run the tests. |
|
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
36 |
| 39 | 37 TODO |
| 38 ---- | |
| 39 | |
| 75 | 40 While simpypi is pretty simple, just because it is only 100 lines of |
| 41 code doesn't mean that it is the *right* 100 lines of code. The | |
| 42 following issues could be addressed: | |
| 43 | |
| 44 * the temporary package should be dealt with entirely in memory, | |
| 45 ideally. Currently we write to a file and move it. | |
| 46 | |
| 47 * ``simpypi`` use ``pkginfo.sdist`` to read the data from a source | |
| 48 distribution. Instead, the uploaded package should probably be | |
| 49 unpacked and ``python setup.py sdist`` run and the resulting | |
| 50 package put in the appropriate place. This will allow archives | |
| 51 without ``PKG-INFO`` | |
| 52 (e.g. http://hg.mozilla.org/build/talos/archive/tip.tar.gz ) | |
| 53 to be uploaded as well as at least partially correct for the fact | |
| 54 that currently ``simpypi`` only works for uploaded source | |
| 55 distributions. | |
| 39 | 56 |
| 0 | 57 -- |
| 58 | |
|
33
058182b7b309
note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents:
0
diff
changeset
|
59 http://k0s.org/mozilla/hg/simpypi |