mirror of synced 2026-01-19 09:07:23 -05:00

Files

Ella Rohm-Ensing 8bb41282c5 CDK 0.15.0 and source-github 0.3.10 -- revert AvailabillityStrategy changes (#20523 )

* Revert "source-github: move known error handling to GithubAvailabilityStrategy (#19978)"

This reverts commit f97db17ccc.

* Revert "🐛 Python CDK: fix `StopIteration` error for `check_availability` (#20429)"

This reverts commit 4e9b014277.

* Revert "CDK: `AbstractSource.read()` skips syncing stream if its unavailable (add `AvailabilityStrategy` concept) (#19977)"

This reverts commit 55a32886a3.

* Restore changelog entries

* bump CDK version

* Bump Github version

* Re-add removed dependencies

* auto-bump connector version

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>

2022-12-15 14:24:24 -05:00

basic-concepts.md

CDK: Update conceptual docs. Update template docs. (#3352 )

2021-05-11 11:02:51 +08:00

full-refresh-stream.md

Rewrite and break out CDK Python overview to be more concise and digestible (#3291 )

2021-05-07 20:30:21 -07:00

http-streams.md

CDK 0.15.0 and source-github 0.3.10 -- revert AvailabillityStrategy changes (#20523 )

2022-12-15 14:24:24 -05:00

incremental-stream.md

CDK: add support for streams with state attribute (#9746 )

2022-02-17 00:20:33 +04:00

python-concepts.md

Rewrite and break out CDK Python overview to be more concise and digestible (#3291 )

2021-05-07 20:30:21 -07:00

README.md

CDK: fixed document links regarding airbyte specification (#18169 )

2022-10-19 09:50:01 -07:00

schemas.md

📚 add doc to describe how CDK handles schemas (#4537 )

2021-07-06 15:58:27 -07:00

stream_slices.md

Rewrite and break out CDK Python overview to be more concise and digestible (#3291 )

2021-05-07 20:30:21 -07:00

README.md

Connector Development Kit Concepts

This concepts section serves as a general introduction to the Python CDK. Readers will certainly benefit from a deeper understanding of the Airbyte Specification before proceeding, but we do a quick overview of it in our basic concepts guide below.

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

Airbyte recommends using the CDK template generator to develop with the CDK. The template generates created all the required scaffolding, with convenient TODOs, allowing developers to truly focus on implementing the API.

For tips on useful Python knowledge, see the Python Concepts page.

You can find a complete tutorial for implementing an HTTP source connector in this tutorial

Examples

Those interested in getting their hands dirty can check out implemented APIs:

Exchange Rates API (Incremental)
Stripe API (Incremental and Full-Refresh)
Slack API (Incremental and Full-Refresh)