pep/poezio-omemo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Poezio plugin for OMEMO
13 commits 2 branches 10 tags 144 KiB
Python 100%
Find a file
Maxime “pep” Buquet 3858d80510
Use setuptools entry_point instead of namespace 
Requires poezio update (3577f887).

This simplifies some things for the tooling. No more name conflicts with
the omemo library for one, and no need for an almost empty folder.

Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
2020-02-17 03:07:58 +01:00
poezio_omemo Use setuptools entry_point instead of namespace 2020-02-17 03:07:58 +01:00
CONTRIBUTING.rst Initial commit. Import from poezio!18 2019-12-24 20:20:10 +01:00
LICENSE Initial commit. Import from poezio!18 2019-12-24 20:20:10 +01:00
README.rst README: Add note about experimental state, recommend master 2020-02-16 16:34:41 +01:00
requirements.txt Initial commit. Import from poezio!18 2019-12-24 20:20:10 +01:00
setup.py Use setuptools entry_point instead of namespace 2020-02-17 03:07:58 +01:00
tox.ini Initial commit. Import from poezio!18 2019-12-24 20:20:10 +01:00

README.rst 

Poezio OMEMO plugin
###################

This is a `Poezio <https://poez.io>`_ plugin providing OMEMO support. It
distributed separately for licensing reasons.

This plugin is very much **alpha**. It handles encryption and decryption
of OMEMO messages, but doesn't display the encryption state of messages,
and neither does it have a way to do trust management. As this plugin is
still changing often, it is recommended that users follow experimental
(master) versions of this project and its dependencies.

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
------------

As this plugin is still changing often, it is recommended that users
follow experimental (master) versions of this project and its
dependencies.

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

Use in poezio
-------------

Once installed (see the `Installation`_ section below), you can add
`omemo` in the `plugin_autoload` configuration. See the Poezio
`documentation
<https://doc.poez.io/plugins/index.html#plugin-autoload>`_ for more
information about autoloading plugins.