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.56.3.post10.dev15861103936.tar.gz (506.6 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-6.56.3.post10.dev15861103936.tar.gz.

File metadata

File hashes

Hashes for airbyte_cdk-6.56.3.post10.dev15861103936.tar.gz
Algorithm Hash digest
SHA256 09052ddcee0f15149381473e76a8bf05bd12fab4087c5de65e8cb2fb3bd9fcbc
MD5 efd1ac8ff66597ceedc0b2235eabda61
BLAKE2b-256 988f4dd4775ae5abf770d5dbc7a44c8ca5a46576e6a1e047e565b7f54025c81d

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.56.3.post10.dev15861103936.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.56.3.post10.dev15861103936-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_cdk-6.56.3.post10.dev15861103936-py3-none-any.whl
Algorithm Hash digest
SHA256 b4f4c474c6d975928109e6d1a92cd3a20ac8af033a878b89b56535239ec5cda6
MD5 5c7c734e8f1ae238e2918229e06c5ec5
BLAKE2b-256 fdb81e6c485ffdff8689d0289c4aa7b9cee80d46217ac0a417e1be265c9a5b49

See more details on using hashes here.

Provenance

The following attestation bundles were made for airbyte_cdk-6.56.3.post10.dev15861103936-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