Skip to main content

A framework for writing Airbyte Connectors.

Project description

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. It should be enough for 90% connectors out there. For more flexible and complex connectors, use the low-code CDK and SourceDeclarativeManifest.

For more information on building connectors, please see the Connector Development guide on 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 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.

Release Management

Please see the Release Management guide for information on how to perform releases and pre-releases.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_cdk-6.45.1.post43.dev14455111666.tar.gz (446.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file airbyte_cdk-6.45.1.post43.dev14455111666.tar.gz.

File metadata

File hashes

Hashes for airbyte_cdk-6.45.1.post43.dev14455111666.tar.gz
Algorithm Hash digest
SHA256 a45b7243430d477fad72f8e2af5d42735b2acb1ccb2df493b509b759ce917740
MD5 2987b48f83e42f63bc180656514c7f2d
BLAKE2b-256 aaa01e747d200d6f434bdf72a7fec44f8d81a7f2fe1c39140cd33e318675e896

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.45.1.post43.dev14455111666.tar.gz:

Publisher: pypi_publish.yml on airbytehq/airbyte-python-cdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file airbyte_cdk-6.45.1.post43.dev14455111666-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_cdk-6.45.1.post43.dev14455111666-py3-none-any.whl
Algorithm Hash digest
SHA256 657b89a9fac4b25125e0742b84b222e7f8fbc8688d657a2d2f6720141f842d8e
MD5 db0a21528170cbea5c0ff38be0fbb2bd
BLAKE2b-256 b2f5ff839e69b74547e64e95126e174deb326cb53eb108fc65dfba727f2210aa

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.45.1.post43.dev14455111666-py3-none-any.whl:

Publisher: pypi_publish.yml on airbytehq/airbyte-python-cdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page