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

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

15
16
## Optional Runtime Requirements

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

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

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

## Starting Points

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

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

34
35
36
37
38
39
or

    pip install .[gssapi]

to also install the optional dependency `gssapi`.

Daniel Brötzmann's avatar
Daniel Brötzmann committed
40
41
### Usage

42
To use python-nbxmpp, `import nbxmpp` in your application.
Philipp Hörist's avatar
Philipp Hörist committed
43
44

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