Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

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.

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-7.27.0.post8.dev32372036252.tar.gz (610.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file airbyte_cdk-7.27.0.post8.dev32372036252.tar.gz.

File metadata

File hashes

Hashes for airbyte_cdk-7.27.0.post8.dev32372036252.tar.gz
Algorithm Hash digest
SHA256 bdd048a23e65fd6b46815abee46c69aef344739cbff4aaa0b07f1e65e7e843a3
MD5 1ee000c12e5b98dca1699160bbfeedca
BLAKE2b-256 10429554382477ee330470705c4973e20c71bbb2bd2ac37a454c2dc88a180397

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-7.27.0.post8.dev32372036252.tar.gz:

Publisher: 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-7.27.0.post8.dev32372036252-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_cdk-7.27.0.post8.dev32372036252-py3-none-any.whl
Algorithm Hash digest
SHA256 acebeda2b1902850dde18473c786ae2aa77f30bad820050d72be5c11ee71f1fd
MD5 f5cb25cf0a99436e4d3156d67c2488b7
BLAKE2b-256 aee83ba575fe21b411b6056b98afe3ec7704189cc7b0fe8bc1a369bfacc97067

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-7.27.0.post8.dev32372036252-py3-none-any.whl:

Publisher: 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.

Release history Release notifications | RSS feed

Supported by

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