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.
please check the table
The package can be installed from PyPI
pip install --no-cache-dir types-confluent-kafkaalternatively, if you use poetry, for example,
poetry add --group dev types-confluent-kafkatypes-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:
MAJORversion for incompatible API changes,MINORversion for adding new features in a backward-compatible manner,PATCHversion 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.
Contributions to types-confluent-kafka are welcome and encouraged! If you want to contribute, please follow these steps:
- Fork this repository.
- Create a new branch for your contribution:
git checkout -b feature/your-feature-name. - Make your changes and ensure that the tests are passing.
- Open a pull request describing your changes and their purpose.
- 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.
please check the development guide
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.