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<https://github.com/simplesteph/kafka-stack-docker-compose#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<https://faust.readthedocs.io/en/latest/>_. 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 <https://github.com/thoth-station/investigator>_ and package-update<https://github.com/thoth-station/package-update-job>_.
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]
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file thoth-messaging-0.6.7.tar.gz.
File metadata
- Download URL: thoth-messaging-0.6.7.tar.gz
- Upload date:
- Size: 6.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 455bd26b15f1b66a76084e7271184499718766a219f540f3f38e18d54689cd07 |
|
| MD5 | b63243eb159a906647b749a1cafb7a00 |
|
| BLAKE2b-256 | 32234b6d62b9ef37195239ce244b0a73cec14d5128f462e9bb1b15981701058a |
File details
Details for the file thoth_messaging-0.6.7-py3-none-any.whl.
File metadata
- Download URL: thoth_messaging-0.6.7-py3-none-any.whl
- Upload date:
- Size: 16.9 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fae3805c6bd320dae5ea7808829e36297e382c56cb35800b112d46651425b07d |
|
| MD5 | 08ef1569f71fdfe9c6c2eb660f8e022c |
|
| BLAKE2b-256 | 17f80aba1d7f60652f0d091ab3282ef35ade42624f95c65c5c1a85d885df5329 |
