Mercurial > hg > simpypi
diff README.txt @ 75:809153401986
update documentation
author | Jeff Hammel <jhammel@mozilla.com> |
---|---|
date | Fri, 02 Mar 2012 14:57:06 -0800 |
parents | 619b7612c7e9 |
children | 5fbe4374bc8a |
line wrap: on
line diff
--- 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. --