kafka-connect-api


Namekafka-connect-api JSON
Version 0.5.9 PyPI version JSON
download
home_page
SummaryApache Kafka Connect client
upload_time2023-08-23 10:13:48
maintainer
docs_urlNone
authorJohn Preston
requires_python>=3.8,<4.0
licenseMPL-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ========================================
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/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "kafka-connect-api",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "John Preston",
    "author_email": "john@compose-x.io",
    "download_url": "https://files.pythonhosted.org/packages/fc/6e/dfad707351e7b2c4c1212bc918c438b1e1c6bc9730f5c0cacec89af45bd4/kafka_connect_api-0.5.9.tar.gz",
    "platform": null,
    "description": "========================================\nApache Kafka Connect API Python client\n========================================\n\n|PYPI_VERSION| |PYPI_LICENSE|\n\n|CODE_STYLE| |TDD| |BDD|\n\n|DOCS_BUILD|\n\nDocumentation: https://kafka-connect-api.readthedocs.io.\n\n\nInstall\n========\n\n.. code-block::\n\n    pip install kafka-connect-api\n\nUsage\n======\n\n.. code-block:: python\n\n    from kafka_connect_api.kafka_connect_api import Api, Cluster\n\n    api = Api(connect.cluster, port=8083)\n    cluster = Cluster(api)\n    print(cluster.connectors)\n\n\nFeatures\n==========\n\nAllows you to interact with the Kafka Connect API (`API Reference`_) in a simple way.\n\n* Connection to cluster (supports Basic Auth)\n* List all connectors in the cluster\n* Describe the connector configuration\n* Update the connector configuration\n* Pause / Resume Connector\n* Restart all tasks for the connector\n\nSome pre-made functions can help with operational activities.\nSee `kafka_connect_api.aws_lambdas.py`\n\n.. _API Reference: https://docs.confluent.io/platform/current/connect/references/restapi.html\n\n.. |DOCS_BUILD| image:: https://readthedocs.org/projects/kafka-connect-api/badge/?version=latest\n        :target: https://kafka-connect-api.readthedocs.io/en/latest/\n        :alt: Documentation Status\n\n.. |PYPI_VERSION| image:: https://img.shields.io/pypi/v/kafka-connect-api.svg\n        :target: https://pypi.python.org/pypi/kafka_connect_api\n\n.. |PYPI_LICENSE| image:: https://img.shields.io/pypi/l/kafka-connect-api\n    :alt: PyPI - License\n    :target: https://github.com/compose-x/kafka-connect-api/blob/master/LICENSE\n\n.. |PYPI_PYVERS| image:: https://img.shields.io/pypi/pyversions/kafka-connect-api\n    :alt: PyPI - Python Version\n    :target: https://pypi.python.org/pypi/kafka-connect-api\n\n.. |PYPI_WHEEL| image:: https://img.shields.io/pypi/wheel/kafka-connect-api\n    :alt: PyPI - Wheel\n    :target: https://pypi.python.org/pypi/kafka-connect-api\n\n.. |CODE_STYLE| image:: https://img.shields.io/badge/codestyle-black-black\n    :alt: CodeStyle\n    :target: https://pypi.org/project/black/\n\n.. |TDD| image:: https://img.shields.io/badge/tdd-pytest-black\n    :alt: TDD with pytest\n    :target: https://docs.pytest.org/en/latest/contents.html\n\n.. |BDD| image:: https://img.shields.io/badge/bdd-behave-black\n    :alt: BDD with Behave\n    :target: https://behave.readthedocs.io/en/latest/\n\n.. |QUALITY| image:: https://sonarcloud.io/api/project_badges/measure?project=compose-x_kafka-connect-api&metric=alert_status\n    :alt: Code scan with SonarCloud\n    :target: https://sonarcloud.io/dashboard?id=compose-x_kafka-connect-api\n\n.. |PY_DLS| image:: https://img.shields.io/pypi/dm/kafka-connect-api\n    :target: https://pypi.org/project/kafka-connect-api/\n",
    "bugtrack_url": null,
    "license": "MPL-2.0",
    "summary": "Apache Kafka Connect client",
    "version": "0.5.9",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "671835e5ddfb3839ec9b1c7ed5fafd28afada035370f3f1b98533fa7d5501a3e",
                "md5": "8b9c0a92171248b75b18555af4ec0a26",
                "sha256": "7947c77087eb4ebfb98ac900a5bbcd06bb52bfcf2d98d95bc7d1bc7c9d18a940"
            },
            "downloads": -1,
            "filename": "kafka_connect_api-0.5.9-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "8b9c0a92171248b75b18555af4ec0a26",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 14320,
            "upload_time": "2023-08-23T10:13:47",
            "upload_time_iso_8601": "2023-08-23T10:13:47.093670Z",
            "url": "https://files.pythonhosted.org/packages/67/18/35e5ddfb3839ec9b1c7ed5fafd28afada035370f3f1b98533fa7d5501a3e/kafka_connect_api-0.5.9-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fc6edfad707351e7b2c4c1212bc918c438b1e1c6bc9730f5c0cacec89af45bd4",
                "md5": "cbc91ce600523996cf133769fdf30195",
                "sha256": "cfb0f3effbba14ec88caeecf0b99b75384c22b17265e870aeb0efdefc0093478"
            },
            "downloads": -1,
            "filename": "kafka_connect_api-0.5.9.tar.gz",
            "has_sig": false,
            "md5_digest": "cbc91ce600523996cf133769fdf30195",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 13911,
            "upload_time": "2023-08-23T10:13:48",
            "upload_time_iso_8601": "2023-08-23T10:13:48.873344Z",
            "url": "https://files.pythonhosted.org/packages/fc/6e/dfad707351e7b2c4c1212bc918c438b1e1c6bc9730f5c0cacec89af45bd4/kafka_connect_api-0.5.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-23 10:13:48",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "kafka-connect-api"
}
        
Elapsed time: 0.10223s