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 Confluent Kafka. 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 `

You can test sending a message via the CLI using a file as -

example: ` pipenv shell python cli.py --message-file messages_to_be_sent.json `

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

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

Uploaded Source

Built Distribution

thoth_messaging-0.11.2-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thoth-messaging-0.11.2.tar.gz
  • Upload date:
  • Size: 11.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.6

File hashes

Hashes for thoth-messaging-0.11.2.tar.gz
Algorithm Hash digest
SHA256 de081d93ddbc9ae9712e22ef900219aae40610281dfb9b0dade00044601dbc92
MD5 fd0d316399a11420862845da60efbe22
BLAKE2b-256 ea470142789d775870a198ef3ee88e015690587167106a149559f372bbdaf8d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thoth_messaging-0.11.2-py3-none-any.whl
  • Upload date:
  • Size: 31.2 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.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 94ac2e1dc0a34e4015e7afd13eb5037359d3b9c56f1421a4e63618359baf5eb7
MD5 0ac721d43ec670f4b2c9c8f60391324b
BLAKE2b-256 569b7b3d19194011a832ac9ab0ed1b22810608e9032c52f3f215b8961abb090e

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