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

Uploaded Source

Built Distribution

thoth_messaging-0.8.1-py3-none-any.whl (29.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: thoth-messaging-0.8.1.tar.gz
  • Upload date:
  • Size: 9.5 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.8.1.tar.gz
Algorithm Hash digest
SHA256 d33911209980644d0bfe93e3880c49ea2e0f0675b32ef1b06d43e3642133b34c
MD5 7a9df592485188c75817dcdd31f7457b
BLAKE2b-256 681a2906ece2adb6474b8d9900becd4a8c621a4a78232d92413835b31a71aff9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: thoth_messaging-0.8.1-py3-none-any.whl
  • Upload date:
  • Size: 29.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

Hashes for thoth_messaging-0.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 75caca2b8bb9c28189ead964dbaa21b473295743f17414a2fcd7c791e6e513cc
MD5 46949ae85a09c588e0362be788b73923
BLAKE2b-256 8be75bd9e18f41170c0304e16abae03e6bd365903d14cf6053cc341c3ee269eb

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