pep/slixmpp-omemo: Slixmpp plugin for OMEMO

Slixmpp plugin for OMEMO

Go to file

Maxime “pep” Buquet c16d3f1cd9 Bump version to 0.9.0 I would have bumped to 0.8.1 only for a deprecation notice fix, but it seems poezio breaks without this fix for some users.. Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>		2022-10-19 21:52:14 +02:00
examples	echo_bot: re-add space before echoing unencrypted message	2022-03-12 01:38:56 +01:00
slixmpp_omemo	Bump version to 0.9.0	2022-10-19 21:52:14 +02:00
.gitignore	Initial split version of this repo	2019-02-17 18:05:43 +00:00
.gitlab-ci.yml	CI: Remove Python 3.{7,8}	2022-03-14 16:19:15 +01:00
CONTRIBUTING.rst	Modify CONTRIBUTING. Remove mentions of github	2019-02-24 16:25:59 +00:00
ChangeLog	Bump version to 0.9.0	2022-10-19 21:52:14 +02:00
LICENSE	Initial split version of this repo	2019-02-17 18:05:43 +00:00
README.rst	README: mention example bot	2022-03-12 01:33:28 +01:00
requirements.txt	Update version requirements for OMEMO lib	2022-08-23 21:26:06 +02:00
setup.py	Add Python 3.11 in classifiers	2022-10-19 21:41:58 +02:00
tox.ini	Initial split version of this repo	2019-02-17 18:05:43 +00:00

README.rst

Slixmpp OMEMO plugin
####################

This library provides an interface to `python-omemo <https://github.com/syndace/python-omemo>`_.

License
-------

This plugin is licensed under GPLv3.

Note on the underlying OMEMO library
------------------------------------

As stated in `python-xeddsa's
README <https://github.com/Syndace/python-xeddsa/blob/136b9f12c8286b9463566308963e70f090b60e50/README.md>`_,
(dependency of python-omemo), this library has not undergone any
security audits. If you have the knowledge, any help is welcome.

Please take this into consideration when using this library.

Installation
------------

- ArchLinux (AUR):
   `python-slixmpp-omemo <https://aur.archlinux.org/packages/python-slixmpp-omemo>`_, or
   `python-slixmpp-omemo-git <https://aur.archlinux.org/packages/python-slixmpp-omemo-git>`_
- PIP: `slixmpp-omemo`
- Manual: `python3 setup.py install`

Examples
--------

The repository contains an example bot that contains many comments, and
can be used to test against other setups. To use it:

```
python examples/echo_bot.py --debug -j foo@bar -p passwd --data-dir /foo/bar
```

It also contains commands. Feel free to open merge requests or issues to
add new useful ones.

Credits
-------

For the help on OMEMO:

- Syndace
- Daniel Gultsch (`gultsch.de <https://gultsch.de/>`_)

And on Slixmpp:

- Mathieu Pasquet (`mathieui@mathieui.net <xmpp:mathieui@mathieui.net?message>`_)
- Emmanuel Gil Peyrot (`Link mauve <xmpp:linkmauve@linkmauve.fr?message>`_)