types-confluent-kafka 1.4.1

Types for Confluent Kafka

types-confluent-kafka

[!IMPORTANT] Please make sure you have read this note before using this package or contributing to this project. As of v2.13.0+, confluent-kafka-python includes official type hints support. Users on v2.13.0 or above should prefer the official type hints over this package. This package is intended for users on versions below v2.13.0.

types-confluent-kafka is a package that provides type hints for the confluent-kafka Python package. It's designed to enhance your development experience by enabling type checking with tools like mypy and providing auto-completion support in your LSP (language server).

Important Note: Confluent does not officially endorse this package.

Compatibility

please check the table

Installation

The package can be installed from PyPI

pip install --no-cache-dir types-confluent-kafka

alternatively, if you use uv, for example,

uv add --group dev types-confluent-kafka

Semantic versioning

types-confluent-kafka follows Semantic Versioning 2.0.0. This means that we use version numbers like MAJOR.MINOR.PATCH to indicate changes in the package:

• MAJOR version for incompatible API changes,
• MINOR version for adding new features in a backward-compatible manner,
• PATCH version for backward-compatible bug fixes.

This package will be released as frequently as possible to iterate faster and provide you with the latest features and improvements. Frequent releases also allow us to quickly address and release bug fixes to ensure the stability of the package.

The commit follows conventional commits, which is the driver of how the versioning works.

Contribution

Contributions to types-confluent-kafka are welcome and encouraged! If you want to contribute, please follow these steps:

1. Fork this repository.
2. Create a new branch for your contribution: git checkout -b feature/your-feature-name.
3. Make your changes and ensure that the tests are passing.
4. Open a pull request describing your changes and their purpose.
5. The PR needs to link to an issue.

Please note that this project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

Development

please check the development guide

License

This project is licensed under the Apache 2.0 License. You are free to use, modify, and distribute the code according to the terms of this license.