~ubuntu-branches/ubuntu/utopic/telepathy-python/utopic

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Simon McVittie
  • Date: 2008-02-21 10:42:31 UTC
  • mfrom: (1.2.1 upstream) (7.1.10 hardy)
  • Revision ID: james.westby@ubuntu.com-20080221104231-88bloeih42cmsb0x
* New upstream version 0.15.0
* Don't mention Cohoba and telepathy-msn in description (-msn is now
  -butterfly, and Cohoba is obsolete)
* Standards-Version: 3.7.3 (no changes)
* Add XS-Dm-Upload-Allowed: yes so I can upload it in future

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
D-Bus Version
2
 
-------------
3
 
Currently you need D-Bus from CVS HEAD, for new features and bug fixes to the
4
 
Python bindings. These patches should be included in version 0.51, and
5
 
snapshots and .debs for Ubuntu Breezy are available here:
6
 
 http://telepathy.freedesktop.org/dbus
7
 
 
8
 
Specification
9
 
-------------
10
 
Type 'make' in the doc/ directory to generate a spec.html with the latest
11
 
version of the D-Bus interface specification, from the base classes in
12
 
telepathy/.
 
1
Requirements
 
2
------------
 
3
telepathy-python requires dbus-python version >= 0.71; version >= 0.80 is
 
4
recommended.
 
5
 
 
6
Using an uninstalled version
 
7
----------------------------
 
8
Because telepathy-python contains generated code, the src directory
 
9
is incomplete. To run this version of telepathy-python without installing it,
 
10
you'll have to run ``python setup.py build`` and arrange for build/lib to be
 
11
on your ``sys.path``, for instance:
 
12
 
 
13
    python setup.py build
 
14
    PYTHONPATH=$PWD/build/lib python examples/call.py a.account b@example.com
 
15
 
 
16
(See ``examples/README`` for details of the .account files used by the
 
17
examples.)
13
18
 
14
19
Server Base Classes
15
20
-------------------
16
 
telepathy/server/ implements base classes and mixins for implementing all of
 
21
telepathy.server implements base classes and mixins for implementing all of
17
22
the D-Bus interfaces in Telepathy. Many methods are abstract and they are
18
23
intended to be overridden in mixins for the concrete implementations, but some
19
24
perform housekeeping for you and maintain structures with some of the state
20
25
necessary to answer Get* calls. The API for implementing managers needs some
21
26
fixing really.
22
27
 
23
 
Swiss
24
 
-----
25
 
swiss.py is the pyxmpp-based connection manager. Currently, you should copy
26
 
swiss.manager into ~/.telepathy/ so the client can discover it, but it needs to
27
 
be executed manually.
28
 
 
29
28
Client Library
30
29
--------------
31
 
The client lib in telepathy/client/ has some base classes to help with
32
 
implementing a client in python. For examples, see ./test-client.py and
33
 
./scw-client.py, both of which will read .manager files from ~/.telepathy/ and
34
 
start a connection for you. The latter, scw-client, has a simple UI to show
35
 
your subscribe list and allow text messages to your contacts.
 
30
The client lib in telepathy.client has some base classes to help with
 
31
implementing a client in python.