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