Mercurial > hg > simpypi

annotate README.txt @ 75:809153401986

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update documentation
author Jeff Hammel <jhammel@mozilla.com>
date Fri, 02 Mar 2012 14:57:06 -0800
parents 619b7612c7e9
children 5fbe4374bc8a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
93e830409685 initial stub commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
1 simpypi
33
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
2 =======
0
93e830409685 initial stub commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
3
75
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
4 Simple python package index
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
5
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
6 How simpypi works
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
7 -----------------
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
8
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
9 Currently ``simpypi`` only works on source distributions (that is,
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
10 packages made with ``python setup.py sdist``).
0
93e830409685 initial stub commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
11
33
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
12 Running the Tests
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
13 -----------------
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
14
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
15 ``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
16 to run the tests.
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
17
39
619b7612c7e9 note in todo
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
18 TODO
619b7612c7e9 note in todo
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
19 ----
619b7612c7e9 note in todo
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
20
75
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
21 While simpypi is pretty simple, just because it is only 100 lines of
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
22 code doesn't mean that it is the *right* 100 lines of code. The
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
23 following issues could be addressed:
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
24
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
25 * the temporary package should be dealt with entirely in memory,
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
26 ideally. Currently we write to a file and move it.
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
27
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
28 * ``simpypi`` use ``pkginfo.sdist`` to read the data from a source
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
29 distribution. Instead, the uploaded package should probably be
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
30 unpacked and ``python setup.py sdist`` run and the resulting
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
31 package put in the appropriate place. This will allow archives
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
32 without ``PKG-INFO``
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
33 (e.g. http://hg.mozilla.org/build/talos/archive/tip.tar.gz )
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
34 to be uploaded as well as at least partially correct for the fact
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
35 that currently ``simpypi`` only works for uploaded source
809153401986 update documentation
Jeff Hammel <jhammel@mozilla.com>
parents: 39
diff changeset
36 distributions.
39
619b7612c7e9 note in todo
Jeff Hammel <jhammel@mozilla.com>
parents: 33
diff changeset
37
0
93e830409685 initial stub commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
38 --
93e830409685 initial stub commit
Jeff Hammel <jhammel@mozilla.com>
parents:
diff changeset
39
33
058182b7b309 note test-requires.txt in the readme
Jeff Hammel <jhammel@mozilla.com>
parents: 0
diff changeset
40 http://k0s.org/mozilla/hg/simpypi