List our dependencies in README.
[g-pypi.git] / README
1 g-pypi
2 ======
3
4
5 `http://code.google.com/p/g-pypi/ <http://code.google.com/p/g-pypi/>`_
6
7 g-pypi creates Python package ebuilds for Gentoo Linux by querying The Cheese Shop.
8
9 Although it's in the early stages of development, testing has generated over 1,200 ebuilds automatically.
10
11 Note: g-pypi will only be as good at creating ebuilds as The Python Package Index information is. People can leave out a lot of information when submitting info to PyPI, making ebuild creation impossible.
12
13
14 Basic Usage
15 ===========
16
17 Output ebuild to stdout:
18
19 ::
20
21   g-pypi -p package_name
22
23
24 Write ebuild to your overlay:
25
26 ::
27
28   g-pypi package_name
29
30 Create live svn ebuild (if subversion URI is listed in PyPI):
31
32 ::
33
34   g-pypi -s package_name
35
36 By default your first overlay listed in /etc/make.conf PORTDIR_OVERLAY
37 is used. If you want to use a different one, edit ~/.g-pypirc
38
39 By default your first KEYWORD listed in /etc/make.conf KEYWORDS
40 is used. If you want to use a different one, edit ~/.g-pypirc or prefix your command with ACCEPT_KEYWORDS e.g. 
41
42 ::
43
44    $ ACCEPT_KEYWORDS='~amd64' g-pypi foopkg
45
46
47 You can over-ride some variables if g-pypi can't figure out the
48 PN, PV etc.
49
50
51 ::
52
53    -n or --PN=package-name
54
55    -v or --PV=version
56
57    --MY_P=my_p
58
59    --MY_PN=my_pn
60
61    --MY_PV=my_pv
62
63
64 If you don't specify a portage category with '-c' the ebuild will be
65 placed in dev-python
66
67 Use '-V' for verbose output for debugging.
68
69
70 Testing
71 =======
72
73 Use nose_ to run unitests::
74
75   $ PYTHONPATH=.:../gentoolkit/pym nosetests tests/test_enamer.py
76
77 Note that some of the tests in :file:`tests` run on all PyPI packages,
78 so it's good to glance at a given test's docstring before you run it.
79
80 .. _nose: http://somethingaboutorange.com/mrl/projects/nose/
81
82
83 INSTALL
84 =======
85
86 g-pypi is available in my overlay directory.
87
88 If you haven't emerged and configured app-portage/layman::
89
90   # emerge layman
91   # layman --add pythonhead
92   # echo "source /var/lib/layman/make.conf" >> /etc/make.conf
93   # emerge g-pypi
94
95 If you have emerged and configured app-portage/layman::
96
97   # layman --add pythonhead
98   # emerge g-pypi
99
100 Dependencies
101 ------------
102
103 * Cheetah
104 * gentoolkit
105 * portage
106 * pygments
107 * yolk
108
109
110 Subversion
111 ==========
112
113 `subversion repository <http://g-pypi.googlecode.com/svn/trunk/#egg=g-pypi-dev>`_
114
115 Hint: You can use to create a live svn ebuild for g-pypi ;)
116  
117 ::
118
119   g-pypi -s g-pypi
120
121