A framework for writing Airbyte Connectors.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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 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.
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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
Built Distribution
File details
Details for the file airbyte_cdk-0.0.0.dev0.tar.gz.
File metadata
- Download URL: airbyte_cdk-0.0.0.dev0.tar.gz
- Upload date:
- Size: 433.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 903ea2f3fbe097974dd96f737b43c623681bb9d24e3824cac95eed7a461015d1 |
|
| MD5 | d957e801617cfb5f3c2b98dbf1f48aa3 |
|
| BLAKE2b-256 | 61594873f582a69e67e7668a936ae31461c7e23c6fd955abe809f59a048f85d8 |
Provenance
The following attestation bundles were made for airbyte_cdk-0.0.0.dev0.tar.gz:
Publisher:
pypi_publish.yml on airbytehq/airbyte-python-cdk
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
airbyte_cdk-0.0.0.dev0.tar.gz - Subject digest:
903ea2f3fbe097974dd96f737b43c623681bb9d24e3824cac95eed7a461015d1 - Sigstore transparency entry: 196867399
- Sigstore integration time:
- Permalink:
airbytehq/airbyte-python-cdk@9369f268edc77c83122ead66ab882f1076ef6225 - Branch / Tag:
refs/heads/aldogonzalez8/poc-adjust-file-based-cdk-new-protocol - Owner: https://github.com/airbytehq
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
pypi_publish.yml@9369f268edc77c83122ead66ab882f1076ef6225 - Trigger Event:
workflow_dispatch
- Statement type:
File details
Details for the file airbyte_cdk-0.0.0.dev0-py3-none-any.whl.
File metadata
- Download URL: airbyte_cdk-0.0.0.dev0-py3-none-any.whl
- Upload date:
- Size: 615.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 84cde9a713cf1deb20795d69b23a8a90b2d1e7b45ae6a075d1aa1747fb2be148 |
|
| MD5 | 1a1b621f90a43a25816ff9586b0b8b87 |
|
| BLAKE2b-256 | 679950e6e26f244a276eda6a9c52d636f7e4331607f9e0b9036a5cab3dfd2af4 |
Provenance
The following attestation bundles were made for airbyte_cdk-0.0.0.dev0-py3-none-any.whl:
Publisher:
pypi_publish.yml on airbytehq/airbyte-python-cdk
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
airbyte_cdk-0.0.0.dev0-py3-none-any.whl - Subject digest:
84cde9a713cf1deb20795d69b23a8a90b2d1e7b45ae6a075d1aa1747fb2be148 - Sigstore transparency entry: 196867408
- Sigstore integration time:
- Permalink:
airbytehq/airbyte-python-cdk@9369f268edc77c83122ead66ab882f1076ef6225 - Branch / Tag:
refs/heads/aldogonzalez8/poc-adjust-file-based-cdk-new-protocol - Owner: https://github.com/airbytehq
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
pypi_publish.yml@9369f268edc77c83122ead66ab882f1076ef6225 - Trigger Event:
workflow_dispatch
- Statement type:
