threema.gateway 8.0.0

Installation

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

Install the module by running:

$ pip install threema.gateway

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

Gateway API Endpoint

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

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

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

Any following calls to threema-gateway will then use the supplied Gateway API Endpoint URL.

8.0.0 (2024-08-21)

• Add support for Python 3.10/3.11/3.12

• Drop support for Python versions below 3.8

• Bump dependencies

• Add caption to file message and to the CLI

• Add an optional parameter to the CLI for send-simple and send-e2e to allow passing the text as an argument instead from stdin.

• Make the random padding spec compliant

• Add an optional environment variable GATEWAY_API_URL to override the Gateway API Endpoint URL

7.0.1 (2023-02-21)

• Fix parsing of unknown reception capabilities

• Add new ReceptionCapability items

• Remove ReceptionCapabilitiesError (breaking)

6.0.0 (2022-06-13)

General:

• Add support for Python 3.10

• Drop support for Python versions below 3.7

• Major dependencies bump to increase compatibility with other packages

• Updated all tests to work with the newest dependencies

• Changed CLI syntax: All commands are now dash-case instead of snake_case, e.g. the send_e2e command is now called send-e2e.

5.0.0 (2021-05-17)

• Add custom session and session arguments to Connection (#55, #56)

• Remove the fingerprint and verify_fingerprint arguments, see #55 for a detailed explanation and how to achieve pinning

4.0.0 (2021-01-23)

General:

• Drop support for Python versions below 3.6.1.

• Remove ReceiptType.user_ack after deprecation. Use ReceiptType.user_acknowledge instead.

• Simplify util.aio_run. It does not allow for passing a specific event loop or closing the event loop on completion any longer.

• Rename util.aio_run_proxy_decorator to aio_run_proxy. It now always creates the class instance within a running event loop.

Client:

• In async mode, creation of the Connection instance must now be done within an async function.

• If you have used a with context manager block in async mode before, you must now do this within an async with asynchronous context manager. No change is required in blocking mode.

• Connection.close is now an async function.

Server:

• The callback server has been refactored and the AbstractCallback class has been removed for more flexibility and control of the underlying aiohttp server. Take a look at examples/callback.py on how to use it.

• The callback server CLI has been removed because it was redundant. The example provides the same functionality.

3.1.0 (2020-04-21)

• Add video message

• Fix slightly off calculation of image byte length

3.0.6 (2017-09-22)

• Migrate to aiohttp2

3.0.5 (2017-07-25)

• Fix to handle new libnacl exceptions.

3.0.4 (2017-05-23)

• Fix CLI

3.0.2 (2017-05-12)

• Initial publication on PyPI