README.md 875 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

Philipp Hörist's avatar
Philipp Hörist committed
3
`python-nbxmpp` is a Python library that provides a way for Python applications to use the XMPP network. This library was initially a fork of `xmpppy`.
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
- PyGObject
- GLib >= 2.60
- libsoup
- precis-i18n
12
- idna
Philipp Hörist's avatar
Philipp Hörist committed
13

14 15
## Optional Runtime Requirements

Philipp Hörist's avatar
Philipp Hörist committed
16
- python-gssapi (for GSSAPI authentication https://pypi.org/project/gssapi/)
17

Yann Leboulanger's avatar
Yann Leboulanger committed
18 19
## Features

20
* List of [supported XEPs](https://dev.gajim.org/gajim/python-nbxmpp/-/wikis/Supported-XEPs-in-python-nbxmpp/)
Yann Leboulanger's avatar
Yann Leboulanger committed
21 22 23

## Starting Points

Daniel Brötzmann's avatar
Daniel Brötzmann committed
24 25 26 27 28 29 30
* [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:

31
    pip install .
Daniel Brötzmann's avatar
Daniel Brötzmann committed
32 33 34

### Usage

35
To use python-nbxmpp, `import nbxmpp` in your application.
Philipp Hörist's avatar
Philipp Hörist committed
36 37

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