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.2.tar.gz (7.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: thoth-messaging-0.7.2.tar.gz
  • Upload date:
  • Size: 7.9 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.2.tar.gz
Algorithm Hash digest
SHA256 151d36e65ec579266aadaf4f479286ae4d2c02f1f2fe4393d9cc17a45d132696
MD5 2ee86a4b6648f60f32a3ac29db50da2d
BLAKE2b-256 5d47f1d538c468eac93c71be5c619274799c8e35b9a122fd14fe566607ffac78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thoth_messaging-0.7.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1bf2308f96c0d86d56e4719ddc9b830459386dea1b9d1c199326211ce9cb79e8
MD5 cfc780bb663e4d2fb581ac402f61acc0
BLAKE2b-256 a827db343ade37e498a62ec8ec941efd333b97db8f6f51d003a6a8599dd9d98c

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