Release 2.28.7
[pygobject.git] / README
blobc5a70896a025f97f5a723c8fad63b5861ddd7d2d
1 PyGObject
2 =====
3 Original authors:   James Henstridge <james@daa.com.au>
4                     Johan Dahlin <johan@gnome.org>
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>
11 This archive contains bindings for the GLib, GObject and GIO,
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).
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
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.
27 New Versions
28 ============
30 New versions of this package can be found at:
31   http://ftp.gnome.org/pub/GNOME/sources/pygobject/
34 Mailing list
35 ============
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
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   * GIO-unix 2.22.4 or higher
49   * libffi (optional)
51 Copyright Information
52 =====================
54 This software is covered by the GNU Lesser General Public Licence
55 (version 2.1, or if you choose, a later version).  Basically just don't
56 say you wrote bits you didn't.
58 Compilation
59 ===========
61 PyGObject uses the standard autotools for the build infrastructure.  To
62 build, it should be as simple as running:
64     $ ./configure --prefix=<prefix where python is installed>
65     $ make
66     $ make install
68 If your Python interpreter isn't in the path, or is not called
69 "python", you can set the PYTHON environment variable to the full path
70 of the interpreter:
72     $ PYTHON=/prefix/bin/python
73     $ export PYTHON
75 If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
76 environment variable to help it find the libraries.
78 The "make install" target will generate normal and optimised bytecode
79 for all the .py files.
81 Note. If you're installing to another prefix than the one where python
82 is installed you'll need to set the PYTHONPATH variable to the
83 $prefix/lib/pythonX.Y/site-packages directory created by
84 the PyGObject installation.
86 Tests
87 =====
89 After having compiled and installed pygobject, you may want to test them.
90 There are a number of example programs available in the examples/
91 subdirectory.
94 Getting Help
95 ============
97 If you have questions about programming with PyGObject, you might want to
98 send a message to the mailing list (information on subscribing is
99 above).  Alternatively, your question may be answered in the PyGTK FAQ:
101     http://www.async.com.br/faq/pygtk/?req=index