GitHub - omemo/python-omemo: Python OMEMO Library (original) (raw)

Overview

docs Documentation Status
tests Travis-CI Build Status AppVeyor Build Status Requirements Status Coverage Status
package PyPI Package latest release PyPI Package monthly downloads PyPI Wheel Supported versions Supported implementations

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:

  1. Fork python-omemo on GitHub.
  2. Clone your fork locally:
    git clone git@github.com:your_name_here/python-omemo.git
  3. Create a branch for local development:
    git checkout -b name-of-your-bugfix-or-feature
    Now you can make your changes locally.
  4. 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: