Imported Upstream version 2.90.1
[platform/upstream/pygobject2.git] / README
1 PyGObject
2 =====
3 Original authors:   James Henstridge <james@daa.com.au>
4                     Johan Dahlin <johan@gnome.org>
5
6 Current maintainers:  Gustavo J A M Carneiro <gjc@gnome.org>
7                       Paul Pogonyshev <pogonyshev@gmx.net>
8                       Gian Mario Tagliaretti <gianmt@gnome.org>
9                       Tomeu Vizoso <tomeu.vizoso@collabora.co.uk>
10
11 This archive contains bindings for the GLib, and GObject,
12 to be used in Python. It is a fairly complete set of bindings,
13 it's already rather useful, and is usable to write moderately
14 complex programs.  (see the examples directory for some examples
15 of the simpler programs you could write).
16
17 If you have any enhancements or bug reports, please file them in
18 bugzilla at:
19   http://bugzilla.gnome.org/enter_bug.cgi?product=pygobject
20
21 If you have a patch, file the bug first and then use the "create new
22 attachment" link on the bug's info page.  My preferred format for
23 patches is unified diff format (ie. diff -u).  Please don't send me
24 diffs which don't have any context, as these make it very difficult to
25 see what the patch does.
26
27 New Versions
28 ============
29
30 New versions of this package can be found at:
31   http://ftp.gnome.org/pub/GNOME/sources/pygobject/
32
33
34 Mailing list
35 ============
36
37 pygobject share mailing list with pygtk. You can subscribe to it through
38 the web interface:
39   http://www.daa.com.au/mailman/listinfo/pygtk
40
41
42 Requirements
43 ============
44   * C compiler (GCC and MSVC supported)
45   * Python 2.3.5 or higher
46   * Glib 2.22.4 or higher
47   * GIO 2.22.4 or higher
48   * libffi (optional)
49
50 Copyright Information
51 =====================
52
53 This software is covered by the GNU Lesser General Public Licence
54 (version 2.1, or if you choose, a later version).  Basically just don't
55 say you wrote bits you didn't.
56
57 Compilation
58 ===========
59
60 PyGObject uses the standard autotools for the build infrastructure.  To
61 build, it should be as simple as running:
62
63     $ ./configure --prefix=<prefix where python is installed>
64     $ make
65     $ make install
66
67 If your Python interpreter isn't in the path, or is not called
68 "python", you can set the PYTHON environment variable to the full path
69 of the interpreter:
70
71     $ PYTHON=/prefix/bin/python
72     $ export PYTHON
73
74 If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
75 environment variable to help it find the libraries.
76
77 The "make install" target will generate normal and optimised bytecode
78 for all the .py files.
79
80 Note. If you're installing to another prefix than the one where python
81 is installed you'll need to set the PYTHONPATH variable to the
82 $prefix/lib/pythonX.Y/site-packages directory created by
83 the PyGObject installation.
84
85 Tests
86 =====
87
88 After having compiled and installed pygobject, you may want to test them.
89 There are a number of example programs available in the examples/
90 subdirectory.
91
92
93 Getting Help
94 ============
95
96 If you have questions about programming with PyGObject, you might want to
97 send a message to the mailing list (information on subscribing is
98 above).  Alternatively, your question may be answered in the PyGTK FAQ:
99
100     http://www.async.com.br/faq/pygtk/?req=index