Connector Development Kit (Python)

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..)
Singer Taps
Generic Python sources (anything not covered by the above)

The CDK provides an improved developer experience by providing basic implementation structure and abstracting away low-level glue boilerplate.

This document is a general introduction to the CDK. Readers should have basic familiarity with the Airbyte Specification before proceeding.

{% hint style="info" %} The CDK currently does not support creating destinations, but it will very soon. {% endhint %}

Getting Started

Generate an empty connector using the code generator. First clone the Airbyte repository then from the repository root run

cd airbyte-integrations/connector-templates/generator
./generate.sh

then follow the interactive prompt. Next, find all TODOs in the generated project directory -- they're accompanied by lots of comments explaining what you'll need to do in order to implement your connector. Upon completing all TODOs properly, you should have a functioning connector.

Additionally, you can follow this tutorial for a complete walkthrough of creating an HTTP connector using the Airbyte CDK.

Concepts & Documentation

See the concepts docs for a tour through what the API offers.

Example Connectors

HTTP Connectors:

Singer connectors:

Simple Python connectors using the barebones Source abstraction:

Contributing

First time setup

We assume python points to python >=3.7.

Setup a virtual env:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]" # [dev] installs development-only dependencies

Iteration

Iterate on the code locally
Run tests via pytest -s unit_tests
Perform static type checks using mypy airbyte_cdk. MyPy configuration is in .mypy.ini.
The type_check_and_test.sh script bundles both type checking and testing in one convenient command. Feel free to use it!

Testing

All tests are located in the unit_tests directory. Run pytest --cov=airbyte_cdk unit_tests/ to run them. This also presents a test coverage report.

Publishing a new version to PyPi

Bump the package version in setup.py
Open a PR
An Airbyte member must comment /publish-cdk --dry-run=<true or false>. Dry runs publish to test.pypi.org.

Coming Soon

Full OAuth 2.0 support (including refresh token issuing flow via UI or CLI)
Airbyte Java HTTP CDK
CDK for Async HTTP endpoints (request-poll-wait style endpoints)
CDK for other protocols
General CDK for Destinations
Don't see a feature you need? Create an issue and let us know how we can help!

4.2 KiB Raw Blame History