Repository files navigation

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

On machines where Python 3 is not the default Python runtime, you shouldusepip3 instead ofpip.

$ sudo apt-get install python3 python3-pip

We recommend usingvenv to create an isolated Python environment:

$ pyvenv venv

You can switch into the created virtual environmentvenv by runningthis command:

$source venv/bin/activate

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

To deactivate the virtual environment, just run:

$ deactivate

If you want easier handling of your virtualenvs, you might also want totake a look atvirtualenvwrapper.

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

Install the module by running:

$ pip install threema.gateway

The dependencylibnacl will be installed automatically. However, youmay need to installlibsodium forlibnacl to work.

The scriptthreema-gateway provides a command line interface forthe Threema gateway. Run the following command to see usage information:

$ threema-gateway --help

The default Gateway API Endpoint URL used ishttps://msgapi.threema.ch/.

If you are a Threema OnPrem customer or have another reason to use a differentGateway API Endpoint, you may override the URL as follows:

$export GATEWAY_API_URL=https://onprem.myinstance.tld/msgapi

Any following calls tothreema-gateway will then use the supplied GatewayAPI Endpoint URL.

You can find a few example scripts in theexamples/ directory.

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

You can see the implemented feature level by invoking the followingcommand:

$ threema-gateway version

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

$ 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 followingcommands to check for code style violations (flake8), optimiseimports (isort) and run the project's tests:

$ flake8.$ isort.$ py.test

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

$ mypy setup.py tests examples threema