1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
============================================
PyXMPP -- Python Jabber/XMPPP implementation
============================================
Introduction
------------
PyXMPP is a Python XMPP (RFC 3920,3921) and Jabber
(http://www.jabber.org/protocol/) implementation. It is based on libxml2 --
fast and fully-featured XML parser.
PyXMPP provides most core features of the XMPP protocol and several JSF-defined
extensions. PyXMPP provides building blocks for creating Jabber clients and
components. Developer uses them to setup XMPP streams, handle incoming events
and create outgoing stanzas (XMPP "packets").
Features
--------
- nearly complete XMPP Core (RFC 3920) protocol for client connections
(includes SASL, TLS and Strinprep).
- mostly complete XMPP IM (RFC 3921) protocol (lacks privacy lists)
- XMPP error objects including translations to and from legacy codes for
backward compatibility (`JEP-0086
<http://www.jabber.org/jeps/jep-0086.html>`__).
- legacy authentication ("digest" and "plain") (`JEP-0078
<http://www.jabber.org/jeps/jep-0078.html>`__).
- component protocol (`JEP-0114 <http://www.jabber.org/jeps/jep-0114.html>`__).
- Service Discovery (`JEP-0030 <http://www.jabber.org/jeps/jep-0091.html>`__).
- vCards -- both Jabber "vcard-temp" and RFC 2426
- basic parts of the Multi-User Chat protocol (`JEP-0045
<http://www.jabber.org/jeps/jep-0045.html>`__)
- delayed delivery timestamps (`JEP-0091 <http://www.jabber.org/jeps/jep-0091.html>`__).
- Data Forms (`JEP-0004 <http://www.jabber.org/jeps/jep-0004.html>`__).
- In-Band Registration (`JEP-0077 <http://www.jabber.org/jeps/jep-0077.html>`__).
Requirements
------------
For PyXMPP you will need:
- `Python <http://www.python.org/>`__. PyXMPP was designed for Python 2.4,
2.3 should work too.
- `libxml2 <http://xmlsoft.org/>`__. Recent release (>=2.6.11) with python
bindings is required. Additionally, all development files for libxml2 (usually in
separate libxml2-devel package) are recommended for compilation of PyXMPP for best performance.
PyXMPP 1.0 was tested with libxml2-2.6.21.
- `dnspython <http://www.dnspython.org/>`__.
PyXMPP 1.0 was tested with version 1.3.4.
- `M2Crypto <http://sandbox.rulemaker.net/ngps/m2/>`__ for TLS support. Tested
with M2Crypto-0.13/swig-1.3.21.
Installation
------------
To build the package just invoke::
python setup.py build
To install it::
python setup.py install
If you had some older version of PyXMPP it is better to uninstall it (delete
pyxmpp subdirectory os your site-packages directory) before installing this one
or things may not work correctly.
You may also try::
make
and::
make install
instead.
Contact
-------
PyXMPP was written and is maintained by Jacek Konieczny <jajcus@jajcus.net>.
To report bugs or request features use `the project page on the JabberStudio
<http://jabberstudio.org/projects/pyxmpp>`__.
For discussion you may join `the PyXMPP mailing list
<http://lists.bnet.pl/mailman/listinfo/pyxmpp>`__.
Download
--------
Latest releases of PyXMPP may be downloaded from `the files section of the project page
<http://jabberstudio.org/projects/pyxmpp/releases/>`__. There are also
some `SVN snapshots <http://pyxmpp.jabberstudio.org/snapshots/>`__ available.
You can also checkout latest sources directly from the SVN repository::
svn checkout svn://svn.jabberstudio.org/pyxmpp/svn/trunk pyxmpp
Licence
-------
PyXMPP is free software, licenced under the GNU LGPL. See the
COPYING file for details.
.. $Id: README 618 2005-12-26 15:41:36Z jajcus $
|