Twomemo 1.0.0

Backend implementation of the namespace `urn:xmpp:omemo:2` for python-omemo.

python-twomemo

Backend implementation for python-omemo, equipping python-omemo with support for OMEMO under the namespace urn:xmpp:omemo:2 (casually/jokingly referred to as "twomemo").

Installation

python-twomemo depends on two system libraries, libxeddsa>=2,<3 and libsodium.

Install the latest release using pip (pip install twomemo) or manually from source by running pip install . (recommended) or python setup.py install in the cloned repository. The installation requires libsodium and the Python development headers to be installed. If a locally installed version of libxeddsa is available, python-xeddsa (a dependency of python-x3dh) tries to use that. Otherwise it uses prebuilt binaries of the library, which are available for Linux, MacOS and Windows for the amd64 architecture, and potentially for MacOS arm64 too. Set the LIBXEDDSA_FORCE_LOCAL environment variable to forbid the usage of prebuilt binaries.

Protobuf

Install protoc. Then, in the root directory of this repository, run:

$ pip install protobuf mypy mypy-protobuf types-protobuf
$ protoc --python_out=twomemo/ --mypy_out=twomemo/ twomemo.proto

This will generate twomemo/twomemo_pb2.py and twomemo/twomemo_pb2.pyi.

Testing, Type Checks and Linting

python-twomemo uses pytest as its testing framework, mypy for static type checks and both pylint and Flake8 for linting. All tests/checks can be run locally with the following commands:

$ pip install --upgrade pytest pytest-asyncio mypy pylint flake8 mypy-protobuf types-protobuf
$ mypy --strict twomemo/ setup.py tests/
$ pylint twomemo/ setup.py tests/
$ flake8 twomemo/ setup.py tests/
$ pytest

Getting Started

Refer to the documentation on readthedocs.io, or build/view it locally in the docs/ directory. To build the docs locally, install the requirements listed in docs/requirements.txt, e.g. using pip install -r docs/requirements.txt, and then run make html from within the docs/ directory. The documentation can then be found in docs/_build/html/.