Skip to content

README.md

Latest commit

 

History

History
38 lines (32 loc) · 1.89 KB

README.md

File metadata and controls

38 lines (32 loc) · 1.89 KB

python-test-bed-adapter

DEPRECATED: PLEASE USE THE NEW VERSION!

This is the test-bed adapter for Python: it allows you to easily connect Python services to the Apache Kafka test-bed via Python. Although it is specifically created for connecting to our test-bed, it should work for any Apache Kafka version too.

The implementation is a wrapper around Pykafka and avro-python3 offering support for:

  • AVRO schema's and messages: both key's and values should have a schema as explained here.
  • Kafka consumer and producer for the test-bed topics.
  • Management
    • Heartbeat (topic: connect-status-heartbeat), so you know which clients are online. Each time the test-bed-adapter is executed, it starts a heartbeat process to notify the its activity to other clients.
    • Configuration (topic: connect-status-configuration), so you can see which topics clients consume and produce.

Installation

You need to install Python 3+.

To install the PYPI package run pip3 install python-test-bed-adapter

Using the Github repo

If you clone the Github repository, to run the examples you will need to install the dependencies specified on the file requirements.txt For that, run pip3 install -r requirements.txt from the project folder.

Examples and usage

Check the examples of consumer and producer.