Imported Upstream version 3.7.3
[platform/upstream/python-gobject.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 development is discussed on the GNOME python-hackers mailing list.
40 You can subscribe to it through the web interface:
41
42   https://mail.gnome.org/mailman/listinfo/python-hackers-list/
43
44 Requirements
45 ============
46   * C compiler (GCC and MSVC supported)
47   * Python 2.6 or higher
48   * Glib/Gio 2.34.2 or higher
49   * libffi (optional)
50
51 Copyright Information
52 =====================
53
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.
57
58 Compilation
59 ===========
60
61 PyGObject uses the standard autotools for the build infrastructure.  To
62 build, it should be as simple as running:
63
64     $ ./configure --prefix=<prefix where python is installed>
65     $ make
66     $ make install
67
68 By default, configure searches for a few well-known Python interpreter
69 names, such as "python3", "python2", "python2.7", or "python".  If your
70 Python interpreter isn't in the path, or is not called "python", you can
71 configure pygobject to build against that with --with-python=<path> or
72 setting the PYTHON environment variable:
73
74    $ ./configure --with-python=python3
75    $ PYTHON=python3.2 ./configure
76    $ ./configure --with-python=~/my-patched-python/python
77
78 If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
79 environment variable to help it find the libraries.
80
81 The "make install" target will generate normal and optimised bytecode
82 for all the .py files.
83
84 Note. If you're installing to another prefix than the one where python
85 is installed you'll need to set the PYTHONPATH variable to the
86 $prefix/lib/pythonX.Y/site-packages directory created by
87 the PyGObject installation.
88
89 Tests
90 =====
91
92 After having compiled and installed pygobject, you may want to test them.
93 There are a number of example programs available in the examples/
94 subdirectory.
95
96
97 Getting Help
98 ============
99
100 If you have questions about programming with PyGObject, you might want to
101 check the documentation on
102
103   https://live.gnome.org/PyGObject/
104
105 If that does not help, send a message to the mailing list (information on
106 subscribing is above), or join #python on irc.gnome.org.