-
Notifications
You must be signed in to change notification settings - Fork 4.5k
Add a walkthrough of building a custom Python connector #36743
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 5 commits
4d62617
aaddb91
c38e9dd
59df8c5
a2e5502
b1e5b40
d6d43d5
fd94818
6bb220e
2ba7efe
2c06fd4
5c6d0c4
c6acf73
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -50,7 +50,7 @@ cd airbyte-integrations/connector-templates/generator | |
Next, find all `TODO`s in the generated project directory. They're accompanied by 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](../tutorials/cdk-tutorial-python-http/getting-started.md) for a complete walkthrough of creating an HTTP connector using the Airbyte CDK. | ||
Additionally, you can follow [this tutorial](../tutorials/custom-python-connector/0-getting-started.md) for a complete walkthrough of creating an HTTP connector using the Airbyte CDK. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. update the path because the cdk-tutorial-python-http is deleted |
||
|
||
### Concepts & Documentation | ||
|
||
|
@@ -72,7 +72,7 @@ Airbyte recommends using the CDK template generator to develop with the CDK. The | |
|
||
For tips on useful Python knowledge, see the [Python Concepts](python-concepts.md) page. | ||
|
||
You can find a complete tutorial for implementing an HTTP source connector in [this tutorial](../tutorials/cdk-tutorial-python-http/getting-started.md) | ||
You can find a complete tutorial for implementing an HTTP source connector in [this tutorial](../tutorials/custom-python-connector/0-getting-started.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. update the path because the cdk-tutorial-python-http is deleted |
||
|
||
### Example Connectors | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -26,7 +26,7 @@ See the [catalog guide](https://docs.airbyte.com/understanding-airbyte/beginners | |
|
||
Let's define the stream schema in `source-exchange-rates-tutorial/source_exchange_rates_tutorial/schemas/rates.json` | ||
|
||
You can download the JSON file describing the output schema with all currencies [here](../../tutorials/cdk-tutorial-python-http/exchange_rates_schema.json) for convenience and place it in `schemas/`. | ||
You can download the JSON file describing the output schema with all currencies [here](./exchange_rates_schema.json) for convenience and place it in `schemas/`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. update the path because the cdk-tutorial-python-http is deleted |
||
|
||
```bash | ||
curl https://raw.githubusercontent.com/airbytehq/airbyte/master/docs/connector-development/tutorials/cdk-tutorial-python-http/exchange_rates_schema.json > source_exchange_rates_tutorial/schemas/rates.json | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -35,7 +35,7 @@ airbyte-ci connectors --use-remote-secrets=false --name source-exchange-rates-tu | |
|
||
## Next steps: | ||
|
||
Next, we'll add the connector to the [Airbyte platform](https://docs.airbyte.com/connector-development/tutorials/cdk-tutorial-python-http/use-connector-in-airbyte). | ||
Next, we'll add the connector to the [Airbyte platform](https://docs.airbyte.com/operator-guides/using-custom-connectors). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I realized there's a better guide to using custom connectors |
||
|
||
## Read more: | ||
|
||
|
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ | |
## CDK Speedrun \(HTTP API Source Creation Any Route\) | ||
|
||
This is a blazing fast guide to building an HTTP source connector. Think of it as the TL;DR version | ||
of [this tutorial.](cdk-tutorial-python-http/getting-started.md) | ||
of [this tutorial.](custom-python-connector/0-getting-started.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. update the path because the cdk-tutorial-python-http is deleted |
||
|
||
If you are a visual learner and want to see a video version of this guide going over each part in | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should urge people to use Connector Builder and low-code for most connectors. I would say, let's delete this guide as well and point it to the new one. Perhaps we can add a little note on the top of it to direct some users to lowcode? |
||
detail, check it out below. | ||
|
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
update the path because the cdk-tutorial-python-http is deleted
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it deleted in this PR? Make sure that you add redirects for all URLs that you delete — redirect to the new guide. That way we don't loose search traffic.