Overview¶

docs
tests
package

This is an implementation OMEMO Multi-End Message and Object Encryption in Python.

Installation¶

pip install python-omemo

Documentation¶

https://python-omemo.readthedocs.org/

Development¶

To set up python-omemo for local development:

Fork python-omemo on GitHub.

Clone your fork locally:

git clone git@github.com:your_name_here/python-omemo.git

Create a branch for local development:
```
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
Run all the checks, doc builder and spell checker with tox one command:
```
tox
```

Tips¶

To run a subset of tests:

tox -e envname -- py.test -k test_myfeature

To run all the test environments in parallel (you need to pip install detox):

detox

Contributing¶

The Python OMEMO project direction is the sum of documented problems: everybody is invited to describe and discuss a problem in the issue tracker. Contributed solutions

encourage participation.

Some problem fields we initially focus on are:

Creation of a reusable python omemo implementation
Reusability bu the Gajim OMEMO plugin