Skip to main content

Messaging module of Project Thoth

Project description

This provides a library called thoth-messaging used in project Thoth. It is a basic module to encapsule all messaging (here it is Kafka via Faust) primitives.

Message Factory

For the purposes of Thoth we have a few of our custom messages defined within the messaging module. However, we wanted to allow individuals to be able to use our module without having to add their own messages first. For testing and development purposes you can use message_factory(…) which allows you to create arbitrary messages using thoth-messaging using the following syntax:

message_factory(t_name=<str>, message_contents=<Tuple[str, str]>, [num_partitions=<int>], [replication_factor=<int>])

bracketed arguments are optional.

Development and Testing

For development and testing it is very useful to have a local instance of Kafka running on your machine

We provide a docker-compose file to get you up and running quickly with a basic Kafka server; this file is based on Single Zookeeper/Multiple Kafka.

In order to start Zookeeper as well as the Kafka Servers simply run $ podman-compose up or $ docker-compose up, choose the appropriate option based on the system which you are using.

Once you have Kafka up and running you should be ready to begin coding your own messaging producers and consumers. The interface between Kafka and Python is handled by a library called Faust. Faust’s documentation will be extremely helpful to you when you are developing your own applications. If you would like examples of producers and consumers from Team Thoth, look at the following two repositories, investigator and package-update.

You may find it useful to use console producers and consumers while testing your, to create one simply attach a bash shell to one of your Kafka Servers by running: $ podman exec -it messaging_kafka1_1 bash, your container names should be the same as given here, if not, run $ podman ps and choose the correct container. These containers have all Kafka binaries in appropriate places so you can simply run $ kafka-console-consumer, $ kafka-console-producer, or any other kafka command that you may find useful.

example: ` $ kafka-console-consumer --bootstrap-server localhost:9092 --topic test --from-beginning `

Note Data is not persistent. Once pods are deleted so is the data associated with them.

Note Faust producers and consumers can’t be run by calling $ python producer.py, instead they are Faust specific applications, in order to run them you need to call faust -A <filename> <function> [options]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

thoth-messaging-0.7.3.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

thoth_messaging-0.7.3-py3-none-any.whl (24.5 kB view details)

Uploaded Python 3

File details

Details for the file thoth-messaging-0.7.3.tar.gz.

File metadata

  • Download URL: thoth-messaging-0.7.3.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.8

File hashes

Hashes for thoth-messaging-0.7.3.tar.gz
Algorithm Hash digest
SHA256 c1a7545f845f2317c83cc99cc88253e3ea398023c06e45710d8a6a4c84d447e7
MD5 fc94b631e8bc210e5b5bc21df99b2161
BLAKE2b-256 1d1c89fbaa9caf00b080b4f3c7564678e9ca7b5e34a7ba827e141b2f31ce8e7f

See more details on using hashes here.

File details

Details for the file thoth_messaging-0.7.3-py3-none-any.whl.

File metadata

  • Download URL: thoth_messaging-0.7.3-py3-none-any.whl
  • Upload date:
  • Size: 24.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/39.2.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.6.8

File hashes

Hashes for thoth_messaging-0.7.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4a677319d04f2703e867f2b9d065774a60c2029c282eee5d1840a7bd23662481
MD5 8080d39e29434672d2de2e391fbede43
BLAKE2b-256 696c2415082de4ec909d0082c4c30f956518ba27ccb2198524694b2d0b4a540e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page