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                       Simon Feltman <sfeltman@gnome.org>
  12
  13
  14 This archive contains bindings for the GLib, and GObject,
  15 to be used in Python. It is a fairly complete set of bindings,
  16 it's already rather useful, and is usable to write moderately
  17 complex programs.  (see the examples directory for some examples
  18 of the simpler programs you could write).
  19
  20 If you have any enhancements or bug reports, please file them in
  21 bugzilla at:
  22   http://bugzilla.gnome.org/enter_bug.cgi?product=pygobject
  23
  24 If you have a patch, file the bug first and then use the "create new
  25 attachment" link on the bug's info page.  My preferred format for
  26 patches is unified diff format (ie. diff -u).  Please don't send me
  27 diffs which don't have any context, as these make it very difficult to
  28 see what the patch does.
  29
  30 New Versions
  31 ============
  32
  33 New versions of this package can be found at:
  34   http://ftp.gnome.org/pub/GNOME/sources/pygobject/
  35
  36
  37 Mailing list
  38 ============
  39
  40 pygobject development is discussed on the GNOME python-hackers mailing list.
  41 You can subscribe to it through the web interface:
  42
  43   https://mail.gnome.org/mailman/listinfo/python-hackers-list/
  44
  45 Requirements
  46 ============
  47   * C compiler (GCC and MSVC supported)
  48   * Python 2.7 or higher
  49   * Glib/Gio 2.38.0 or higher
  50   * gobject-introspection 1.46.0 or higher
  51   * libffi (optional)
  52
  53 Copyright Information
  54 =====================
  55
  56 This software is covered by the GNU Lesser General Public Licence
  57 (version 2.1, or if you choose, a later version).  Basically just don't
  58 say you wrote bits you didn't.
  59
  60 Compilation
  61 ===========
  62
  63 PyGObject uses the standard autotools for the build infrastructure.  To
  64 build, it should be as simple as running:
  65
  66     $ ./configure --prefix=<prefix where python is installed>
  67     $ make
  68     $ make install
  69
  70 By default, configure searches for a few well-known Python interpreter
  71 names, such as "python3", "python2", "python2.7", or "python".  If your
  72 Python interpreter isn't in the path, or is not called "python", you can
  73 configure pygobject to build against that with --with-python=<path> or
  74 setting the PYTHON environment variable:
  75
  76    $ ./configure --with-python=python3
  77    $ PYTHON=python3.2 ./configure
  78    $ ./configure --with-python=~/my-patched-python/python
  79
  80 If configure can't find GTK+, you may need to set the PKG_CONFIG_PATH
  81 environment variable to help it find the libraries.
  82
  83 The "make install" target will generate normal and optimised bytecode
  84 for all the .py files.
  85
  86 Note. If you're installing to another prefix than the one where python
  87 is installed you'll need to set the PYTHONPATH variable to the
  88 $prefix/lib/pythonX.Y/site-packages directory created by
  89 the PyGObject installation.
  90
  91 Tests
  92 =====
  93
  94 After having compiled and installed pygobject, you may want to test them.
  95 There are a number of example programs available in the examples/
  96 subdirectory.
  97
  98
  99 Getting Help
 100 ============
 101
 102 If you have questions about programming with PyGObject, you might want to
 103 check the documentation on
 104
 105   https://live.gnome.org/PyGObject/
 106
 107 If that does not help, send a message to the mailing list (information on
 108 subscribing is above), or join #python on irc.gnome.org.