=======================================
dbus-python_: Python bindings for D-Bus
=======================================

.. _dbus-python: http://www.freedesktop.org/wiki/Software/DBusBindings#python

Usage
=====

Online documentation can be found at
<http://dbus.freedesktop.org/doc/dbus-python/>.

There is an incomplete tutorial in `doc/tutorial.txt`__
(if you compile dbus-python with ``rst2html`` installed or you're reading
this document on the D-Bus website, there's also an `HTML version`__).

__ doc/tutorial.txt
__ doc/tutorial.html

For client code, see the docstring for dbus/__init__.py.

To export objects, see the docstring for dbus/service.py.

To develop on dbus-python, see `doc/HACKING.txt`__ or the `HTML version`__.

__ doc/HACKING.txt
__ doc/HACKING.html

Building the API documentation
==============================

Because the API documentation is generated with a pre-release version of
epydoc, it's not currently built by default. To do so, install
`epydoc`_ 3 alpha and `docutils`_, and run ``./configure`` with the
``--enable-api-docs`` option. Documentation starts from ``api/index.html``.

.. _epydoc: http://epydoc.sourceforge.net/
.. _docutils: http://docutils.sourceforge.net/

A copy of the documentation can be found here:
`dbus-python API documentation on people.freedesktop.org`__

__ http://dbus.freedesktop.org/doc/dbus-python/api/