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.48.7.dev0.tar.gz (484.4 kB view details)

Uploaded Source

Built Distribution

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

airbyte_cdk-6.48.7.dev0-py3-none-any.whl (688.9 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_cdk-6.48.7.dev0.tar.gz.

File metadata

  • Download URL: airbyte_cdk-6.48.7.dev0.tar.gz
  • Upload date:
  • Size: 484.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for airbyte_cdk-6.48.7.dev0.tar.gz
Algorithm Hash digest
SHA256 ed3331f8485c4fc2322d503e535b460db3e9e2b79d1a41a9d8a9ca3d580cce10
MD5 42a9c80f9679db6b2ec731b05fc11aa3
BLAKE2b-256 4599144baaf9435d56ed3992b07be849de51e4fb9d0202aae2bf124d95b664ca

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.48.7.dev0.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.48.7.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_cdk-6.48.7.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 8dfdcf220ac2284af64001a3d7fb2285044ecf24a785b6b6de664625c051a249
MD5 bedb2a5a7f432504b56d4783a3595a13
BLAKE2b-256 684c6e3e90a8885ef8dc936ac0d011626e90043abeb9120bfd741b8b4e3c3175

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.48.7.dev0-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page