Threema Gateway API

|Travis| |codecov|

threema-gateway is a Python 3 module for the Threema gateway service. This API can be used to send and receive text messages to and from any Threema user.

Note

On machines where Python 3 is not the default Python runtime, you should use pip3 instead of pip.

Prerequisites

.. code-block:: bash

$ sudo apt-get install python3 python3-pip

We recommend using venv_ to create an isolated Python environment:

.. code-block:: bash

$ pyvenv venv

You can switch into the created virtual environment venv by running this command:

.. code-block:: bash

$ source venv/bin/activate

While the virtual environment is active, all packages installed using pip will be installed into this environment.

To deactivate the virtual environment, just run:

.. code-block:: bash

$ deactivate

If you want easier handling of your virtualenvs, you might also want to take a look at virtualenvwrapper_.

Installation

If you are using a virtual environment, activate it first.

Install the module by running:

.. code-block:: bash

$ pip install threema.gateway

The dependency libnacl will be installed automatically. However, you may need to install libsodium_ for libnacl to work.

Command Line Usage

The script threema-gateway provides a command line interface for the Threema gateway. Run the following command to see usage information:

.. code-block:: bash

$ threema-gateway --help

Examples

You can find a few example scripts in the examples/ directory.

Note that most of them need to be adjusted to at least add your gateway ID credentials before they run successfully.

Feature Levels

+---------+--------+----------------+---------+--------+-----------+ | Level | Text | Capabilities | Image | File | Credits | +=========+========+================+=========+========+===========+ | 1 | X | | | | | +---------+--------+----------------+---------+--------+-----------+ | 2 | X | X | X | X | | +---------+--------+----------------+---------+--------+-----------+ | 3 | X | X | X | X | X | +---------+--------+----------------+---------+--------+-----------+

You can see the implemented feature level by invoking the following command:

.. code-block:: bash

$ threema-gateway version

Contributing

If you want to contribute to this project, you should install the optional dev requirements of the project in an editable environment:

.. code-block:: bash

$ git clone https://github.com/threema-ch/threema-msgapi-sdk-python.git
$ cd threema-msgapi-sdk-python
$ pip install -e .[dev]

Before creating a pull request, it is recommended to run the following commands to check for code style violations (flake8), optimise imports (isort) and run the project's tests:

.. code-block:: bash

$ flake8 .
$ isort .
$ py.test

You should also run the type checker that might catch some additional bugs:

.. code-block:: bash

$ mypy setup.py tests examples threema

Reporting Security Issues

Please report security issues directly to one or both of the following contacts:

• Danilo Bargen

  • Email: [email protected]
  • Threema: EBEP4UCA
  • GPG: EA456E8BAF0109429583EED83578F667F2F3A5FA_

• Lennart Grahl

  • Email: [email protected]
  • Threema: MSFVEW6C
  • GPG: 3FDB14868A2B36D638F3C495F98FBED10482ABA6_

.. _asyncio: https://docs.python.org/3/library/asyncio.html .. _venv: https://docs.python.org/3/library/venv.html .. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/ .. _libsodium: https://download.libsodium.org/doc/installation/index.html

.. |Travis| image:: https://travis-ci.org/threema-ch/threema-msgapi-sdk-python.svg?branch=master :target: https://travis-ci.org/threema-ch/threema-msgapi-sdk-python .. |codecov| image:: https://codecov.io/gh/threema-ch/threema-msgapi-sdk-python/branch/master/graph/badge.svg :target: https://codecov.io/gh/threema-ch/threema-msgapi-sdk-python .. |PyPI| image:: https://badge.fury.io/py/threema.gateway.svg :target: https://badge.fury.io/py/threema.gateway .. _EA456E8BAF0109429583EED83578F667F2F3A5FA: https://keybase.io/dbrgn .. _3FDB14868A2B36D638F3C495F98FBED10482ABA6: https://keybase.io/lgrahl