https://github.com/compose-x/kafka-connect-api
Python API to interact with Kafka Connect cluster
https://github.com/compose-x/kafka-connect-api
kafka-connect
Last synced: about 2 months ago
JSON representation
Python API to interact with Kafka Connect cluster
- Host: GitHub
- URL: https://github.com/compose-x/kafka-connect-api
- Owner: compose-x
- License: mpl-2.0
- Created: 2021-11-24T12:44:13.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T13:03:09.000Z (about 1 year ago)
- Last Synced: 2025-06-05T00:45:55.586Z (12 months ago)
- Topics: kafka-connect
- Language: Python
- Homepage:
- Size: 236 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: HISTORY.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
========================================
Apache Kafka Connect API Python client
========================================
|PYPI_VERSION| |PYPI_LICENSE|
|CODE_STYLE| |TDD| |BDD|
|DOCS_BUILD|
Documentation: https://kafka-connect-api.readthedocs.io.
Install
========
.. code-block::
pip install kafka-connect-api
Usage
======
.. code-block:: python
from kafka_connect_api.kafka_connect_api import Api, Cluster
api = Api(connect.cluster, port=8083)
cluster = Cluster(api)
print(cluster.connectors)
Features
==========
Allows you to interact with the Kafka Connect API (`API Reference`_) in a simple way.
* Connection to cluster (supports Basic Auth)
* List all connectors in the cluster
* Describe the connector configuration
* Update the connector configuration
* Pause / Resume Connector
* Restart all tasks for the connector
Some pre-made functions can help with operational activities.
See `kafka_connect_api.aws_lambdas.py`
.. _API Reference: https://docs.confluent.io/platform/current/connect/references/restapi.html
.. |DOCS_BUILD| image:: https://readthedocs.org/projects/kafka-connect-api/badge/?version=latest
:target: https://kafka-connect-api.readthedocs.io/en/latest/
:alt: Documentation Status
.. |PYPI_VERSION| image:: https://img.shields.io/pypi/v/kafka-connect-api.svg
:target: https://pypi.python.org/pypi/kafka_connect_api
.. |PYPI_LICENSE| image:: https://img.shields.io/pypi/l/kafka-connect-api
:alt: PyPI - License
:target: https://github.com/compose-x/kafka-connect-api/blob/master/LICENSE
.. |PYPI_PYVERS| image:: https://img.shields.io/pypi/pyversions/kafka-connect-api
:alt: PyPI - Python Version
:target: https://pypi.python.org/pypi/kafka-connect-api
.. |PYPI_WHEEL| image:: https://img.shields.io/pypi/wheel/kafka-connect-api
:alt: PyPI - Wheel
:target: https://pypi.python.org/pypi/kafka-connect-api
.. |CODE_STYLE| image:: https://img.shields.io/badge/codestyle-black-black
:alt: CodeStyle
:target: https://pypi.org/project/black/
.. |TDD| image:: https://img.shields.io/badge/tdd-pytest-black
:alt: TDD with pytest
:target: https://docs.pytest.org/en/latest/contents.html
.. |BDD| image:: https://img.shields.io/badge/bdd-behave-black
:alt: BDD with Behave
:target: https://behave.readthedocs.io/en/latest/
.. |QUALITY| image:: https://sonarcloud.io/api/project_badges/measure?project=compose-x_kafka-connect-api&metric=alert_status
:alt: Code scan with SonarCloud
:target: https://sonarcloud.io/dashboard?id=compose-x_kafka-connect-api
.. |PY_DLS| image:: https://img.shields.io/pypi/dm/kafka-connect-api
:target: https://pypi.org/project/kafka-connect-api/