#688228 python-gi: Add README.Debian explaining how to get information on the python bindings

Package:
python-gi
Source:
pygobject
Submitter:
Osamu Aoki
Date:
2021-01-23 18:45:03 UTC
Severity:
important
Tags:
#688228#5
Date:
2012-09-20 14:31:43 UTC
From:
To:
Library without availability of the definitive refrence information may become
not as useful as it should be.  If one wish to use this package, there is no
pointer to such information now.

Please consider to add following information to this package as
README.Debian.

=====
PyGObject binding for GTK+3 is provided through this python-gi package.
Programs using this Python binding are started with "from gi.repository
import Gtk".

Tutorial is available as "The Python GTK+ 3 Tutorial" at:
http://python-gtk-3-tutorial.readthedocs.org/en/latest/

Unfortunately, as of 2012 on Debian wheezy, we can not find good
reference documentations of GTK+3 and its related libraries for Python.

We can create a usable reference documentation of GTK+3 and related
libraries by yourself using the g-ir-doc-tool command from the
gobject-introspection package as explained in GObject Introspection
Doctools. (https://live.gnome.org/GObjectIntrospection/Doctools)

 $ g-ir-doc-tool --language Python -o ./output_dir /usr/share/gir-1.0/Gtk-3.0.gir
 $ yelp ./output_dir/index.page

There are new GTK+3 Python codes using PyGObject such as accerciser,
caribou-preferences, gdebi-gtk, gnome-shell-timer-config, software-center, and
software-properties-gtk providing us with good examples.

=====

I was playing with new GTK+3 programing as shown in
http://people.debian.org/~osamu/fun2prog.html#_gtk_3

I thought having some pointer should have reduced my learning time :-)

#688228#10
Date:
2021-01-23 18:40:05 UTC
From:
To:
Just reading through this issues, and this seems to be fixed a while ago.

1. The documentation for PyGObject is available now [1].
2. Gtk bindings are now in a separate package, e.g. gir1.2-gtk-3.0

I think this can be closed by now.

Regards,
Stephan Lachnit

[1] https://lazka.github.io/pgi-docs/