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.dev5.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.dev5-py3-none-any.whl (689.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_cdk-6.48.7.dev5.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.dev5.tar.gz
Algorithm Hash digest
SHA256 d0ef003b0efac874c539359fa4b536e3af1a4759ab4d24e8a62a61e84fae542b
MD5 e72674f84328b216bc1c9116ff52a419
BLAKE2b-256 a02101f2b3ea6f40f0f750293a4ba126cde338dc0c10f01af5611c3532343cf2

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for airbyte_cdk-6.48.7.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 da7cab1600f1e5b3484b922270357ed1ec727423f736d3de6f43a4257e6ef87f
MD5 2112f3fafd8c610f1a8a66bc05afc60c
BLAKE2b-256 3f1aed08eee6a1a1a0c5a6934273f8b8fe880000bb01356f2d38897963a27195

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.48.7.dev5-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