Connector Development Kit
This section is for the Python CDK. See our community-maintained CDKs section if you want to write connectors in other languages.
The Airbyte Python CDK is a framework for rapidly developing production-grade Airbyte connectors. The CDK currently offers helpers specific for creating Airbyte source connectors for:
- HTTP APIs (REST APIs, GraphQL, etc..)
- Generic Python sources (anything not covered by the above)
This document is a general introduction to the CDK. Readers should have basic familiarity with the Airbyte Specification before proceeding.
If you have any issues with troubleshooting or want to learn more about the CDK from the Airbyte team, head to the Connector Development section of our Airbyte Forum to inquire further!
Getting Started
In most cases, you won't need to use the CDK directly, and should start building connectors in Connector Builder, an IDE that is powerd by Airbyte Python CDK. If you do need customization beyond what it offers, you can do so by using airbyte_cdk as aa dependency in your Python project.
Airbyte CDK reference documentation is published automatically with each new CDK release. The rest of this document explains the most basic concepts applicable to any Airbyte API connector.
Concepts & Documentation
Basic Concepts
If you want to learn more about the classes required to implement an Airbyte Source, head to our basic concepts doc.
Full Refresh Streams
If you have questions or are running into issues creating your first full refresh stream, head over to our full refresh stream doc. If you have questions about implementing a path or parse_response function, this doc is for you.
Incremental Streams
Having trouble figuring out how to write a stream_slices function or aren't sure what a cursor_field is? Head to our incremental stream doc.
Practical Tips
You can find a complete tutorial for implementing an HTTP source connector in this tutorial
Contributing
We're welcoming all contributions to Airbyte Python CDK! airbytehq/airbyte-python-cdk Github repository CONTRIBUTING.md is the best spot to see up to date guide on how to get started.