comparison 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
comparison
equal deleted inserted replaced
74:0e84dd7d740a 75:809153401986
1 simpypi 1 simpypi
2 ======= 2 =======
3 3
4 Simple pypi package 4 Simple python package index
5
6 How simpypi works
7 -----------------
8
9 Currently ``simpypi`` only works on source distributions (that is,
10 packages made with ``python setup.py sdist``).
5 11
6 Running the Tests 12 Running the Tests
7 ----------------- 13 -----------------
8 14
9 ``tests-require.txt`` contains dependencies that should be installed 15 ``tests-require.txt`` contains dependencies that should be installed
10 to run the tests. 16 to run the tests.
11 17
12 TODO 18 TODO
13 ---- 19 ----
14 20
15 * the temporary package should be dealt with entirely in memory 21 While simpypi is pretty simple, just because it is only 100 lines of
22 code doesn't mean that it is the *right* 100 lines of code. The
23 following issues could be addressed:
24
25 * the temporary package should be dealt with entirely in memory,
26 ideally. Currently we write to a file and move it.
27
28 * ``simpypi`` use ``pkginfo.sdist`` to read the data from a source
29 distribution. Instead, the uploaded package should probably be
30 unpacked and ``python setup.py sdist`` run and the resulting
31 package put in the appropriate place. This will allow archives
32 without ``PKG-INFO``
33 (e.g. http://hg.mozilla.org/build/talos/archive/tip.tar.gz )
34 to be uploaded as well as at least partially correct for the fact
35 that currently ``simpypi`` only works for uploaded source
36 distributions.
16 37
17 -- 38 --
18 39
19 http://k0s.org/mozilla/hg/simpypi 40 http://k0s.org/mozilla/hg/simpypi