Oldmemo 1.1.0

Backend implementation of the namespace `eu.siacs.conversations.axolotl` for python-omemo.

python-oldmemo

Backend implementation for python-omemo, equipping python-omemo with support for OMEMO under the namespace eu.siacs.conversations.axolotl (casually/jokingly referred to as "oldmemo").

This repository is based on python-twomemo and will be rebased on top of new commits to that repository regularly, so expect commit hashes to be unstable. For the same reason, release tags might not be available or point to non-existing commit hashes.

Installation

Install the latest release using pip (pip install oldmemo) or manually from source by running pip install . in the cloned repository.

Protobuf

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

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

This will generate oldmemo/oldmemo_pb2.py and oldmemo/oldmemo_pb2.pyi.

Type Checks and Linting

python-oldmemo uses mypy for static type checks and both pylint and Flake8 for linting. All checks can be run locally with the following commands:

$ pip install --upgrade mypy pylint flake8 mypy-protobuf types-protobuf
$ mypy --strict oldmemo/ setup.py
$ pylint oldmemo/ setup.py
$ flake8 oldmemo/ setup.py

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