Skip to main content

Robot Framework - ConfluentKafkaLibrary

ConfluentKafkaLibrary library is a wrapper for the confluent-kafka-python.

ConfluentKafkaLibrary version names follow confluent-kafka-python: ConfluentKafkaLibrary X.Y.Z.postN requires at least confluent-kafka-python X.Y.Z and is tested with it (e.g., 2.16.1.post2 requires confluent-kafka >= 2.16.1, < 3). Newer confluent-kafka-python releases are allowed and tested weekly in CI. The first release for each confluent-kafka-python version is .post1, further fixes increment the post number. If you need a fixed version, pin confluent-kafka in your own requirements.

Documentation

The keyword documentation for ConfluentKafkaLibrary can be found here

To generate the documentation, use the following command:

python -m robot.libdoc -f html src/ConfluentKafkaLibrary docs/index.html

Installation

To install the library, run the following command:

pip install robotframework-confluentkafkalibrary

Extra packages:

  • [avro] = ['fastavro >= 1.5.4, < 2', 'avro >= 1.11.1, < 2']

  • [json] = ['jsonschema >= 4.18.0', 'orjson >= 3.10']

  • [protobuf] = ['protobuf >= 4.22.0', 'googleapis-common-protos >= 1.66.0']

  • [schemaregistry] = ['httpx2 >= 2.0' (Python >= 3.10) or 'httpx >= 0.26', 'cachetools >= 5.5.0', 'attrs >= 24.3.0', 'certifi >= 2026.10.19', 'authlib >= 1.8.0' (Python >= 3.10) or 'authlib >= 1.0.0']

  • To install all dependencies use [all] extension like:

pip install robotframework-confluentkafkalibrary[all]

Usage

In most cases, you can refer to the confluent-kafka-python documentation for guidance. Every keyword in ConfluentKafkaLibrary is designed to match the corresponding Python functions. If you are unsure about the pre-configured keywords, please visit the robotframework-ConfluentKafkaLibrary documentation. The Kafka team maintains the up-to-date documentation for configuration properties and their values here.

  • You can find basic usage examples in the ./examples/test.robot
  • For more complex examples, such as handling byte data from a topic, using multiple consumers, or running threaded avro consumers, please refer to the documentation.

Testing

  • The library is tested using black-box tests written in Robot Framework.
  • For testing, a dockerized enterprise Kafka platform with schema registry support and REST proxy is used. The platform is deployed and tested for each pull request and merge to the master branch.
  • Tests are divided into the following files:
    • test.robot - Basic tests to verify functionality of the Consumer and Producer.
    • test_adminclient.robot - Verifications of admin client functionality.
    • test_avro.robot - Verifications of avro and serializers functionality.
  • Not executable example of oauth usage can be found here
  • The core testing logic involves producing data to Kafka, connecting one consumer in a thread, and working with the results in specific test cases.

Known Limitations:

  • Unable to install robotframework-confluentkafkalibrary on Amazon EC2 graviton instance type

Metadata

Release files for robotframework-confluentkafkalibrary 2.16.1.post2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for robotframework-confluentkafkalibrary 2.16.1.post2
File Size Uploaded Provenance Actions
robotframework_confluentkafkalibrary-2.16.1.post2.tar.gz 18.4 kB Without provenance Details for robotframework_confluentkafkalibrary-2.16.1.post2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for robotframework-confluentkafkalibrary 2.16.1.post2
File Interpreter ABI Platform Actions
robotframework_confluentkafkalibrary-2.16.1.post2-py3-none-any.whl Python 3 none any Details for robotframework_confluentkafkalibrary-2.16.1.post2-py3-none-any.whl

Total release size: 37.3 kB

Release files / robotframework_confluentkafkalibrary-2.16.1.post2.tar.gz

Download URL robotframework_confluentkafkalibrary-2.16.1.post2.tar.gz
Size 18.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f4dfc7a2fe818407bed57eb90afeedd108bfaf98b20512bbeef6087efcacca21
BLAKE2b-256 checksum
How to use checksums
464f8c21728ff31961d282ad33bec231df57a92b6f2a14858348a6cbecb11ee7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / robotframework_confluentkafkalibrary-2.16.1.post2-py3-none-any.whl

Download URL robotframework_confluentkafkalibrary-2.16.1.post2-py3-none-any.whl
Size 18.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c750fe6d3a27bb9ce8dd0285e08d48473f37acba85a48860274f35e7cb18dc3d
BLAKE2b-256 checksum
How to use checksums
a4eeb7626ad1b9857c0a7e036ce61e3cf04ed12785d93cbf316950beec850096
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for robotframework-confluentkafkalibrary 2.16.1.post2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page