Add a CDK speedrun tutorial doc #3403
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
May 13, 2021 15:48
avaidyanatha
added
the
area/documentation
sherifnada
approved these changes
May 14, 2021
| @@ -0,0 +1,220 @@ | |||
| # CDK Speedrun (Any% Route) | |||
|
|
|||
There was a problem hiding this comment.
Suggested change
| This is a blazing fast guide to building an HTTP source connector. Think of it as the TL;DR version of [../../cdk-tutorial-python-http.md](url) |
|
|
||
| ## Define your Stream | ||
|
|
||
| In your `source.py` file, add this `PythonHttpExampleStream` class. This stream represents an endpoint you want to hit. |
There was a problem hiding this comment.
This is not the name of the class
Suggested change
| In your `source.py` file, add this `PythonHttpExampleStream` class. This stream represents an endpoint you want to hit. | |
| In your `source.py` file, add this `ExchangeRates` class. This stream represents an endpoint you want to hit. |
There was a problem hiding this comment.
There's a couple of references to this throughout so you might wanna double check. I just did a speedrun review
added 2 commits
May 14, 2021 10:17
htrueman
added a commit
that referenced
this pull request
May 18, 2021
* Requirements updated to CDK. airbyte-protocol and base-python requirements removed. * Bugfix: BufferedStreamConsumer. (#3387) * Format. * Bump versions. * main_dev.py renamed to main.py README.md updated * Source Stripe: Add Acceptance Tests to Stripe Connector (#3367) * Add Acceptance Tests to Stripe Connector * move configured_catalog.json to sample_files * bump version Co-authored-by: ykurochkin <y.kurochkin@zazmic.com> * Legacy lib references removed * FB Marketing source - lookback window logic not functioning correctly * FB Marketing source #1390 - returning buffered record while incremental sync * FB Marketing source #1390 - improving checking while syncing buffered record * FB Marketing source #1390 - adding loop_back to IncrementalStreamAPI * FB Marketing source #1390 - bump version * FB Marketing source #1390 - add CHANGELOG.md * Stop formatting python with spotless (#3388) * add test that migration output schema same as source schema (#3356) * Add updated architecture diagram to high level docs. (#3399) * Add updated architecture doc to high level docs. * Address review comments Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local> * Correct GA readme error. (#3407) * make shopify more resilient to timeouts (#3409) * Update migration schema to include recent changes to the StandardSync object. (#3414) * Update all of Pydantic to 1.6.2 per Dependabot. (#3408) * Update all to 1.6.2. * Publish new airbyte-cdk version. * Use repr instead of str for exceptions. * Use rc. * Edit test. * Bump for SAT. * Format. * Docker ignore update. Fix setup.py * fixing ONLY problematic fields in freshdesk JSON schemas (#3376) * bump airbyte-webapp version (#2266) * add configuration for bumping webapp versionn * set to current version * Bump version: 0.16.0-alpha → 0.16.1-alpha * Revert "Bump version: 0.16.0-alpha → 0.16.1-alpha" Thiss reverts commit fdbf6dc. * also update package lock so we don't run into files changed errors * use 0.19.0-alpha * add npm webapp version * Add a CDK speedrun tutorial doc (#3403) * Add CDK Speedrun document. * Finish speedrun doc. * Address review comments * Add to SUMMARY.md Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local> * Add Rust as a connector specific dependency to source-file (#3426) * Add Rust as a connector specific dependency to source-file * Add more details about installation. * Markdown lines are weird. Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local> * API update to latest airbyte-cdk version * Add section Deploy Local on Windows (#3425) * add deploy on windows steps * correct minor * change suggestions by @avaidyanatha * GitBook: [master] 161 pages and 75 assets modified * Display icons (#3140) * Display icons * Improve icons views * MS SQL Server Destination implementation Fixes issue #613. Normalization is not yet enabled. This will have to be added at a later point. * Workflow to handle operations (custom transformation) (#3379) * Keep normalization backward compatible with old settings from destination * Bumpversion normalization image * add npm install before all npm run generates' (#3442) * restart containers if they fail automatically (#3423) * Update link for contribution scheduling (#3443) * Address issue with icon in onboarding (#3437) * rename toy connector tutorial to "Build a connector the hard way" (#3421) * Upload test reports (from integration test slash commands) as GitHub artifacts (#3416) * Archive test reports in github workflow * Archive Test reports only when failures * Fixing SqlServerOperations.java (#3454) Fixing some issues with `SqlServerOperations`, which was out of sync with recent changes to `SqlOperations`. * Add redirect to cdk tutorial page (#3456) * add redirect to cdk tutorial page * change path to cdk README.md Co-authored-by: Davin Chia <davinchia@gmail.com> Co-authored-by: Yevhenii <34103125+yevhenii-ldv@users.noreply.github.com> Co-authored-by: ykurochkin <y.kurochkin@zazmic.com> Co-authored-by: vitaliizazmic <75620293+vitaliizazmic@users.noreply.github.com> Co-authored-by: Charles <giardina.charles@gmail.com> Co-authored-by: Abhi Vaidyanatha <abhi@airbyte.io> Co-authored-by: Abhi Vaidyanatha <abhivaidyanatha@Abhis-MacBook-Pro.local> Co-authored-by: Jared Rhizor <jared@dataline.io> Co-authored-by: vovavovavovavova <39351371+vovavovavovavova@users.noreply.github.com> Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com> Co-authored-by: Marcos Marx <marcos@airbyte.io> Co-authored-by: Artem Astapenko <3767150+Jamakase@users.noreply.github.com> Co-authored-by: masonwheeler <masonwheeler@yahoo.com> Co-authored-by: Christophe Duong <christophe.duong@gmail.com> Co-authored-by: Sherif A. Nada <snadalive@gmail.com> Co-authored-by: Michel Tricot <michel@dataline.io>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Main Inspiration
We got a comment that our CDK tutorial and docs were really heavy. To write a quality connector, it is more or less required to read through a lot of the docs, but I thought I'd take a first shot at throwing an extremely barebones version of the tutorial out. This can help us iterate on a nice medium that is more consumable for a prospective connector author.
Main Changes
Notes