airbyte-cdk


Nameairbyte-cdk JSON
Version 6.41.8 PyPI version JSON
download
home_pagehttps://airbyte.com
SummaryA framework for writing Airbyte Connectors.
upload_time2025-03-21 13:00:24
maintainerNone
docs_urlNone
authorAirbyte
requires_python<3.13,>=3.10
licenseMIT
keywords airbyte connector-development-kit cdk
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # Airbyte Python CDK and Low-Code CDK

Airbyte Python CDK is a framework for building Airbyte API Source Connectors. It provides a set of
classes and helpers that make it easy to build a connector against an HTTP API (REST, GraphQL, etc),
or a generic Python source connector.

## Building Connectors with the CDK

If you're looking to build a connector, we highly recommend that you first
[start with the Connector Builder](https://docs.airbyte.com/connector-development/connector-builder-ui/overview).
It should be enough for 90% connectors out there. For more flexible and complex connectors, use the
[low-code CDK and `SourceDeclarativeManifest`](https://docs.airbyte.com/connector-development/config-based/low-code-cdk-overview).

For more information on building connectors, please see the [Connector Development](https://docs.airbyte.com/connector-development/) guide on [docs.airbyte.com](https://docs.airbyte.com).

## Python CDK Overview

Airbyte CDK code is within `airbyte_cdk` directory. Here's a high level overview of what's inside:

- `airbyte_cdk/connector_builder`. Internal wrapper that helps the Connector Builder platform run a declarative manifest (low-code connector). You should not use this code directly. If you need to run a `SourceDeclarativeManifest`, take a look at [`source-declarative-manifest`](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-declarative-manifest) connector implementation instead.
- `airbyte_cdk/cli/source_declarative_manifest`. This module defines the `source-declarative-manifest` (aka "SDM") connector execution logic and associated CLI.
- `airbyte_cdk/destinations`. Basic Destination connector support! If you're building a Destination connector in Python, try that. Some of our vector DB destinations like `destination-pinecone` are using that code.
- `airbyte_cdk/models` expose `airbyte_protocol.models` as a part of `airbyte_cdk` package.
- `airbyte_cdk/sources/concurrent_source` is the Concurrent CDK implementation. It supports reading data from streams concurrently per slice / partition, useful for connectors with high throughput and high number of records.
- `airbyte_cdk/sources/declarative` is the low-code CDK. It works on top of Airbyte Python CDK, but provides a declarative manifest language to define streams, operations, etc. This makes it easier to build connectors without writing Python code.
- `airbyte_cdk/sources/file_based` is the CDK for file-based sources. Examples include S3, Azure, GCS, etc.

## Contributing

For instructions on how to contribute, please see our [Contributing Guide](docs/CONTRIBUTING.md).

## Release Management

Please see the [Release Management](docs/RELEASES.md) guide for information on how to perform releases and pre-releases.


            

Raw data

            {
    "_id": null,
    "home_page": "https://airbyte.com",
    "name": "airbyte-cdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.10",
    "maintainer_email": null,
    "keywords": "airbyte, connector-development-kit, cdk",
    "author": "Airbyte",
    "author_email": "contact@airbyte.io",
    "download_url": "https://files.pythonhosted.org/packages/c4/c0/3cd0eb4f0a19714bb9718418d32f8d71a9560298311b8649ed501417dc97/airbyte_cdk-6.41.8.tar.gz",
    "platform": null,
    "description": "# Airbyte Python CDK and Low-Code CDK\n\nAirbyte Python CDK is a framework for building Airbyte API Source Connectors. It provides a set of\nclasses and helpers that make it easy to build a connector against an HTTP API (REST, GraphQL, etc),\nor a generic Python source connector.\n\n## Building Connectors with the CDK\n\nIf you're looking to build a connector, we highly recommend that you first\n[start with the Connector Builder](https://docs.airbyte.com/connector-development/connector-builder-ui/overview).\nIt should be enough for 90% connectors out there. For more flexible and complex connectors, use the\n[low-code CDK and `SourceDeclarativeManifest`](https://docs.airbyte.com/connector-development/config-based/low-code-cdk-overview).\n\nFor more information on building connectors, please see the [Connector Development](https://docs.airbyte.com/connector-development/) guide on [docs.airbyte.com](https://docs.airbyte.com).\n\n## Python CDK Overview\n\nAirbyte CDK code is within `airbyte_cdk` directory. Here's a high level overview of what's inside:\n\n- `airbyte_cdk/connector_builder`. Internal wrapper that helps the Connector Builder platform run a declarative manifest (low-code connector). You should not use this code directly. If you need to run a `SourceDeclarativeManifest`, take a look at [`source-declarative-manifest`](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-declarative-manifest) connector implementation instead.\n- `airbyte_cdk/cli/source_declarative_manifest`. This module defines the `source-declarative-manifest` (aka \"SDM\") connector execution logic and associated CLI.\n- `airbyte_cdk/destinations`. Basic Destination connector support! If you're building a Destination connector in Python, try that. Some of our vector DB destinations like `destination-pinecone` are using that code.\n- `airbyte_cdk/models` expose `airbyte_protocol.models` as a part of `airbyte_cdk` package.\n- `airbyte_cdk/sources/concurrent_source` is the Concurrent CDK implementation. It supports reading data from streams concurrently per slice / partition, useful for connectors with high throughput and high number of records.\n- `airbyte_cdk/sources/declarative` is the low-code CDK. It works on top of Airbyte Python CDK, but provides a declarative manifest language to define streams, operations, etc. This makes it easier to build connectors without writing Python code.\n- `airbyte_cdk/sources/file_based` is the CDK for file-based sources. Examples include S3, Azure, GCS, etc.\n\n## Contributing\n\nFor instructions on how to contribute, please see our [Contributing Guide](docs/CONTRIBUTING.md).\n\n## Release Management\n\nPlease see the [Release Management](docs/RELEASES.md) guide for information on how to perform releases and pre-releases.\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A framework for writing Airbyte Connectors.",
    "version": "6.41.8",
    "project_urls": {
        "Documentation": "https://docs.airbyte.io/",
        "Homepage": "https://airbyte.com",
        "Repository": "https://github.com/airbytehq/airbyte-python-cdk"
    },
    "split_keywords": [
        "airbyte",
        " connector-development-kit",
        " cdk"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "201cc5678b6e047c1dc28a46f00870f2368ebc78ddd24fc9ae13c694c3b12c32",
                "md5": "26c58603977a4ff00e4f82c8b244c37e",
                "sha256": "0a06428464ea9adc21a7c4ad092ac3fd962afef72d0b30a2f6993f00c9e4fcfb"
            },
            "downloads": -1,
            "filename": "airbyte_cdk-6.41.8-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "26c58603977a4ff00e4f82c8b244c37e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.10",
            "size": 616206,
            "upload_time": "2025-03-21T13:00:22",
            "upload_time_iso_8601": "2025-03-21T13:00:22.011315Z",
            "url": "https://files.pythonhosted.org/packages/20/1c/c5678b6e047c1dc28a46f00870f2368ebc78ddd24fc9ae13c694c3b12c32/airbyte_cdk-6.41.8-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "c4c03cd0eb4f0a19714bb9718418d32f8d71a9560298311b8649ed501417dc97",
                "md5": "dad886271fd4c59fc9b4c4b83af7665d",
                "sha256": "e88ef8659b2de726b58f7f44fa1e9e261d091d07acdf22be6ef84a2a5e4292aa"
            },
            "downloads": -1,
            "filename": "airbyte_cdk-6.41.8.tar.gz",
            "has_sig": false,
            "md5_digest": "dad886271fd4c59fc9b4c4b83af7665d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.10",
            "size": 434008,
            "upload_time": "2025-03-21T13:00:24",
            "upload_time_iso_8601": "2025-03-21T13:00:24.845280Z",
            "url": "https://files.pythonhosted.org/packages/c4/c0/3cd0eb4f0a19714bb9718418d32f8d71a9560298311b8649ed501417dc97/airbyte_cdk-6.41.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-21 13:00:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "airbytehq",
    "github_project": "airbyte-python-cdk",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "airbyte-cdk"
}
        
Elapsed time: 0.41875s