Registry / http-networking / kafka-connect-py

kafka-connect-py

library1.0.0pypypi✓ verified 85d ago

kafka-connect-py is a Python client library for interacting with the Confluent Platform Kafka Connect REST API. It provides a convenient way to manage Kafka Connect clusters, including listing, creating, updating, and deleting connectors. The current stable version is 1.0.0, and releases appear to be infrequent, driven by new feature additions or maintenance.

http-networking data

pip install kafka-connect-py

github ↗package ↗

INSTALL

IMPORT

SIG · KAFKA-CONNECT-PY

kafka-connect-py

http-networkingpythonv1.0.0

Install

2.3s avg

Import

621ms

Disk

20MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.654s · 22.1MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 2.3s · import 0.587s · 23MB

20MB installed

● package 20MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

KafkaConnect

✓ from kafka_connect import KafkaConnect

Initialize the KafkaConnect client, retrieve the cluster version, and list existing connectors. Requires the `KAFKA_CONNECT_URL` environment variable to be set to the base URL of your Kafka Connect REST API.

import os from kafka_connect import KafkaConnect # Ensure KAFKA_CONNECT_URL is set in your environment # e.g., export KAFKA_CONNECT_URL="http://localhost:8083" connect_url = os.environ.get('KAFKA_CONNECT_URL', 'http://localhost:8083') try: client = KafkaConnect(connect_url) print(f"Connected to Kafka Connect at: {client.base_url}") # Get Kafka Connect cluster version version_info = client.get_connect_version() print(f"Kafka Connect Version: {version_info.get('version')}") # List active connectors connectors = client.get_connectors() if connectors: print(f"Active connectors: {', '.join(connectors)}") else: print("No active connectors found.") except Exception as e: print(f"An error occurred: {e}") print("Please ensure the Kafka Connect REST API is running and accessible at the configured URL.")

Debug

Known issues

gotchaThe client raises `requests.exceptions.ConnectionError` if the Kafka Connect REST API URL is incorrect, unreachable, or the service is down. Always ensure the `KAFKA_CONNECT_URL` is correct and the Kafka Connect cluster is running.

fix

Verify the `KAFKA_CONNECT_URL` environment variable or the URL passed to the `KafkaConnect` constructor. Use `try-except requests.exceptions.ConnectionError` for robust error handling.

affects: All versions

gotchaWhen interacting with non-existent connectors (e.g., calling `get_connector_status('my_non_existent_connector')`), the Kafka Connect API typically returns a 404 Not Found response. The client translates this into a `requests.exceptions.HTTPError`.

fix

Implement specific error handling for `requests.exceptions.HTTPError` and check the status code (e.g., `if e.response.status_code == 404:`). Consider listing connectors (`client.get_connectors()`) before attempting operations on specific ones.

affects: All versions

gotchaInvalid connector configurations (e.g., missing required fields, invalid values) passed to `create_connector` or `update_connector_config` will result in a `requests.exceptions.HTTPError` (typically 400 Bad Request). The underlying Kafka Connect API provides detailed error messages in the response body.

fix

Catch `requests.exceptions.HTTPError` and inspect `e.response.json()` (if JSON) or `e.response.text` for the specific validation errors from the Kafka Connect cluster. Correct your connector configuration dictionary accordingly.

affects: All versions

Errors

Common errors & fixes

requests.exceptions.ConnectionError: ('Connection aborted.', ConnectionResetError(104, 'Connection reset by peer'))

The Python client could not establish a connection to the Kafka Connect REST API. This often means the API URL is wrong, the network is blocking the connection, or the Kafka Connect service is not running or accessible.

fix

Double-check the `KAFKA_CONNECT_URL` environment variable or the URL provided to `KafkaConnect`. Ensure the Kafka Connect cluster is running and accessible from the machine where your Python code is executed. Verify firewall rules or network configuration if necessary.

requests.exceptions.HTTPError: 404 Client Error: Not Found for url: http://localhost:8083/connectors/my_missing_connector/status

You attempted an operation (like getting status, pausing, or resuming) on a Kafka Connect connector name that does not exist on the connected cluster.

fix

Verify the connector name for typos. Before attempting operations, you can list existing connectors using `client.get_connectors()` to confirm its presence. Implement `try-except` blocks to handle 404 errors gracefully.

requests.exceptions.HTTPError: 400 Client Error: Bad Request for url: http://localhost:8083/connectors

This error, often occurring during `create_connector` or `update_connector_config`, indicates that the provided connector configuration is invalid based on the Kafka Connect cluster's validation rules (e.g., missing required properties, incorrect plugin names, invalid values).

fix

Inspect the error response body for detailed validation messages from the Kafka Connect API. When catching the `HTTPError`, access `e.response.json()` or `e.response.text` to read the specific reasons for the 'Bad Request' and adjust your connector configuration dictionary.

Upgrade

Version history

1.0.0latest on PyPI · released Jan 6, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/aidanmelen/kafka-connect-py ↗

packagehttps://pypi.org/project/kafka-connect-py/ ↗