mirror of synced 2026-01-10 00:03:08 -05:00

Files

LiRen Tu 2906ec287a CI: Add action to check broken doc links (#5254 )

* Add action to check broken doc links

* Ignore localhost

* Update config

* Fix broken links

* Use quiet mode

* Ignore PR link

* Fix more broken links

* Fix more broken links

* Fix more broken links

* Verify pattern

* Fix more broken links

* Separate full and pr check

* Update pattern

* Test invalid link

* Remove invalid link

2021-08-07 14:28:02 -07:00

base_python

Stop formatting python with spotless (#3388 )

2021-05-13 17:46:34 -07:00

docs

CI: Add action to check broken doc links (#5254 )

2021-08-07 14:28:02 -07:00

unit_tests

Stop formatting python with spotless (#3388 )

2021-05-13 17:46:34 -07:00

.dockerignore

Integrations Reorganization: Bases (#673 )

2020-10-21 11:23:49 -07:00

build.gradle

Only run pytest if test files are found in the test directories (#5012 )

2021-07-27 08:33:51 -07:00

Dockerfile

Improve Python Build. (#4540 )

2021-07-05 16:25:33 +08:00

main_dev.py

Stop formatting python with spotless (#3388 )

2021-05-13 17:46:34 -07:00

README.md

CI: Add action to check broken doc links (#5254 )

2021-08-07 14:28:02 -07:00

requirements.txt

split airbyte protocol generated structs out of base_python (#721 )

2020-10-28 10:03:15 -07:00

setup.py

Improve Python Build. (#4540 )

2021-07-05 16:25:33 +08:00

README.md

Airbyte Python Connector Development Framework (CDK)

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 (the interface for how sources and destinations interact) before proceeding.

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 overview docs for a tour through what the API offers.

Example Connectors

HTTP Connectors:

Singer connectors:

Simple Python connectors using the barebones Source abstraction: