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 aSourceDeclarativeManifest, take a look atsource-declarative-manifestconnector implementation instead.airbyte_cdk/cli/source_declarative_manifest. This module defines thesource-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 likedestination-pineconeare using that code.airbyte_cdk/modelsexposeairbyte_protocol.modelsas a part ofairbyte_cdkpackage.airbyte_cdk/sources/concurrent_sourceis 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/declarativeis 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_basedis 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.
1 maintainer
Metadata
1 maintainer
Release files for airbyte-cdk 6.17.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| airbyte_cdk-6.17.0.tar.gz | 367.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| airbyte_cdk-6.17.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 914.7 kB
Release files / airbyte_cdk-6.17.0.tar.gz
| Download URL | airbyte_cdk-6.17.0.tar.gz |
|---|---|
| Size | 367.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d341ded793e87c5ee420d84ac308913601ed920c78819b9cf94ee31c78a2bc3d
|
|
BLAKE2b-256 checksum How to use checksums |
7ec78380765c536a6d5ecae14059aadafc28069ae487633767b4858df7f11eaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 9, 2025.
Transparency logRelease files / airbyte_cdk-6.17.0-py3-none-any.whl
| Download URL | airbyte_cdk-6.17.0-py3-none-any.whl |
|---|---|
| Size | 547.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
733cf7678750c6c56981387496e024e40e6d7dc9958713db03fc6fb8f444fb66
|
|
BLAKE2b-256 checksum How to use checksums |
0646ddbb7c407944ad3444d613f32bac89cbcea00e72b15de8726201c625c28a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 9, 2025.
Transparency log
