README.md 824 Bytes
Newer Older
Daniel Brötzmann's avatar
Daniel Brötzmann committed
1
# Welcome to python-nbxmpp
Yann Leboulanger's avatar
Yann Leboulanger committed
2

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 initially a fork of `xmpppy`, but is now using non-blocking sockets.
Yann Leboulanger's avatar
Yann Leboulanger committed
4

Philipp Hörist's avatar
Philipp Hörist committed
5 6
## Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
7
- python >= 3.7.0
Philipp Hörist's avatar
Philipp Hörist committed
8 9 10 11 12
- PyGObject
- GLib >= 2.60
- libsoup
- precis-i18n

Yann Leboulanger's avatar
Yann Leboulanger committed
13 14
## Features

15
* List of [supported XEPs](https://dev.gajim.org/gajim/python-nbxmpp/-/wikis/Supported-XEPs-in-python-nbxmpp/)
Yann Leboulanger's avatar
Yann Leboulanger committed
16 17 18

## Starting Points

Daniel Brötzmann's avatar
Daniel Brötzmann committed
19 20 21 22 23 24 25
* [Downloads](https://dev.gajim.org/gajim/python-nbxmpp/tags)
* You can also clone the [git repository](https://dev.gajim.org/gajim/python-nbxmpp.git)

### Setup

Run the following:

26
    pip install .
Daniel Brötzmann's avatar
Daniel Brötzmann committed
27 28 29

### Usage

30
To use python-nbxmpp, `import nbxmpp` in your application.
Philipp Hörist's avatar
Philipp Hörist committed
31 32

or use the example client `python3 -m nbxmpp.examples.client`