|
1
|
|
-## Welcome to python-nbxmpp website
|
|
|
1
|
+# Welcome to python-nbxmpp
|
|
2
|
2
|
|
|
3
|
|
-python-nbxmpp is a Python library that provides a way for Python applications to use Jabber/XMPP networks in a non-blocking way. This library is initialy a fork of xmpppy one, but using non-blocking sockets.
|
|
|
3
|
+`python-nbxmpp` is a Python library that provides a way for Python applications to use the Jabber/XMPP network in a non-blocking way. This library was initialy a fork of `xmpppy`, but is now using non-blocking sockets.
|
|
4
|
4
|
|
|
5
|
5
|
## Features
|
|
6
|
6
|
|
|
7
|
|
- * Asynchronous
|
|
8
|
|
- * Supports ANONYMOUS, EXTERNAL, GSSAPI, SCRAM-SHA-1(PLUS), SCRAM-SHA-256(PLUS) and PLAIN authentication mechanisms.
|
|
9
|
|
- * Supports connection via proxies
|
|
10
|
|
- * Suppors TLS
|
|
11
|
|
- * Supports [BOSH (XEP-0124)](https://xmpp.org/extensions/xep-0124.html)
|
|
12
|
|
- * Support [Stream Management (XEP-0198)](https://xmpp.org/extensions/xep-0198.html)
|
|
|
7
|
+* Asynchronous
|
|
|
8
|
+* Supports ANONYMOUS, EXTERNAL, GSSAPI, SCRAM-SHA-1, DIGEST-MD5, PLAIN, and X-MESSENGER-OAUTH2 authentication mechanisms.
|
|
|
9
|
+* Supports connection via proxies
|
|
|
10
|
+* Supports TLS
|
|
|
11
|
+* Supports [BOSH (XEP-0124)](https://xmpp.org/extensions/xep-0124.html)
|
|
|
12
|
+* Supports [Stream Managemen (XEP-0198)](https://xmpp.org/extensions/xep-0198.html)
|
|
|
13
|
+* List of [supported XEPs](./Supported-XEPs-in-python-nbxmpp/)
|
|
13
|
14
|
|
|
14
|
15
|
## Starting Points
|
|
15
|
16
|
|
|
16
|
|
- * [Downloads](http://dev.gajim.org/gajim/python-nbxmpp/tags)
|
|
17
|
|
- * You can also clone the git repository at http://dev.gajim.org/gajim/python-nbxmpp.git
|
|
18
|
|
- * [Example](http://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples)
|
|
|
\ No newline at end of file |
|
|
17
|
+* [Downloads](https://dev.gajim.org/gajim/python-nbxmpp/tags)
|
|
|
18
|
+* You can also clone the [git repository](https://dev.gajim.org/gajim/python-nbxmpp.git)
|
|
|
19
|
+* [Examples](https://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples)
|
|
|
20
|
+
|
|
|
21
|
+### Setup
|
|
|
22
|
+
|
|
|
23
|
+Run the following:
|
|
|
24
|
+
|
|
|
25
|
+ sudo python setup.py install
|
|
|
26
|
+
|
|
|
27
|
+### Usage
|
|
|
28
|
+
|
|
|
29
|
+To use python-nbxmpp, `import nbxmpp` in your application. Have a look at the [Examples](https://dev.gajim.org/gajim/python-nbxmpp/tree/master/doc/examples) in the doc folder.
|