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
|
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.5: http://docutils.sourceforge.net/" />
<title>PyXMPP -- Python Jabber/XMPPP implementation</title>
<link rel="stylesheet" href="default.css" type="text/css" />
</head>
<body>
<h1 class="title">PyXMPP -- Python Jabber/XMPPP implementation</h1>
<div class="document" id="pyxmpp-python-jabber-xmppp-implementation">
<div class="section" id="introduction">
<h2><a name="introduction">Introduction</a></h2>
<p>PyXMPP is a Python XMPP (<a class="reference" href="http://www.faqs.org/rfcs/rfc3920.html">RFC 3920</a>,3921) and Jabber
(<a class="reference" href="http://www.jabber.org/protocol/">http://www.jabber.org/protocol/</a>) implementation. It is based on libxml2 --
fast and fully-featured XML parser.</p>
<p>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").</p>
</div>
<div class="section" id="features">
<h2><a name="features">Features</a></h2>
<ul class="simple">
<li>nearly complete XMPP Core (<a class="reference" href="http://www.faqs.org/rfcs/rfc3920.html">RFC 3920</a>) protocol for client connections
(includes SASL, TLS and Strinprep).</li>
<li>mostly complete XMPP IM (<a class="reference" href="http://www.faqs.org/rfcs/rfc3921.html">RFC 3921</a>) protocol (lacks privacy lists)</li>
<li>XMPP error objects including translations to and from legacy codes for
backward compatibility (<a class="reference" href="http://www.jabber.org/jeps/jep-0086.html">JEP-0086</a>).</li>
<li>legacy authentication ("digest" and "plain") (<a class="reference" href="http://www.jabber.org/jeps/jep-0078.html">JEP-0078</a>).</li>
<li>component protocol (<a class="reference" href="http://www.jabber.org/jeps/jep-0114.html">JEP-0114</a>).</li>
<li>Service Discovery (<a class="reference" href="http://www.jabber.org/jeps/jep-0091.html">JEP-0030</a>).</li>
<li>vCards -- both Jabber "vcard-temp" and <a class="reference" href="http://www.faqs.org/rfcs/rfc2426.html">RFC 2426</a></li>
<li>basic parts of the Multi-User Chat protocol (<a class="reference" href="http://www.jabber.org/jeps/jep-0045.html">JEP-0045</a>)</li>
<li>delayed delivery timestamps (<a class="reference" href="http://www.jabber.org/jeps/jep-0091.html">JEP-0091</a>).</li>
<li>Data Forms (<a class="reference" href="http://www.jabber.org/jeps/jep-0004.html">JEP-0004</a>).</li>
<li>In-Band Registration (<a class="reference" href="http://www.jabber.org/jeps/jep-0077.html">JEP-0077</a>).</li>
</ul>
</div>
<div class="section" id="requirements">
<h2><a name="requirements">Requirements</a></h2>
<p>For PyXMPP you will need:</p>
<blockquote>
<ul class="simple">
<li><a class="reference" href="http://www.python.org/">Python</a>. PyXMPP was designed for Python 2.4,
2.3 should work too.</li>
<li><a class="reference" href="http://xmlsoft.org/">libxml2</a>. 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.</li>
<li><a class="reference" href="http://www.dnspython.org/">dnspython</a>.
PyXMPP 1.0 was tested with version 1.3.4.</li>
<li><a class="reference" href="http://sandbox.rulemaker.net/ngps/m2/">M2Crypto</a> for TLS support. Tested
with M2Crypto-0.13/swig-1.3.21.</li>
</ul>
</blockquote>
</div>
<div class="section" id="installation">
<h2><a name="installation">Installation</a></h2>
<p>To build the package just invoke:</p>
<pre class="literal-block">
python setup.py build
</pre>
<p>To install it:</p>
<pre class="literal-block">
python setup.py install
</pre>
<p>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.</p>
<p>You may also try:</p>
<pre class="literal-block">
make
</pre>
<p>and:</p>
<pre class="literal-block">
make install
</pre>
<p>instead.</p>
</div>
<div class="section" id="contact">
<h2><a name="contact">Contact</a></h2>
<p>PyXMPP was written and is maintained by Jacek Konieczny <<a class="reference" href="mailto:jajcus@jajcus.net">jajcus@jajcus.net</a>>.</p>
<p>To report bugs or request features use <a class="reference" href="http://jabberstudio.org/projects/pyxmpp">the project page on the JabberStudio</a>.</p>
<p>For discussion you may join <a class="reference" href="http://lists.bnet.pl/mailman/listinfo/pyxmpp">the PyXMPP mailing list</a>.</p>
</div>
<div class="section" id="download">
<h2><a name="download">Download</a></h2>
<p>Latest releases of PyXMPP may be downloaded from <a class="reference" href="http://jabberstudio.org/projects/pyxmpp/releases/">the files section of the project page</a>. There are also
some <a class="reference" href="http://pyxmpp.jabberstudio.org/snapshots/">SVN snapshots</a> available.</p>
<p>You can also checkout latest sources directly from the SVN repository::
svn checkout svn://svn.jabberstudio.org/pyxmpp/svn/trunk pyxmpp</p>
</div>
<div class="section" id="licence">
<h2><a name="licence">Licence</a></h2>
<p>PyXMPP is free software, licenced under the GNU LGPL. See the
COPYING file for details.</p>
<!-- $Id: README 618 2005-12-26 15:41:36Z jajcus $ -->
</div>
</div>
</body>
</html>
|
