Skip to content

Commit

Permalink
Add a walkthrough of building a custom Python connector (#36743)
Browse files Browse the repository at this point in the history
Co-authored-by: Natik Gadzhi <natik@respawn.io>
  • Loading branch information
girarda and natikgadzhi committed Apr 9, 2024
1 parent 884face commit 87f051c
Show file tree
Hide file tree
Showing 30 changed files with 1,481 additions and 1,317 deletions.
2 changes: 1 addition & 1 deletion docs/connector-development/README.md
Expand Up @@ -58,7 +58,7 @@ and choose the relevant template by using the arrow keys. This will generate a n
Search the generated directory for "TODO"s and follow them to implement your connector. For more detailed walkthroughs and instructions, follow the relevant tutorial:

- [Speedrun: Building a HTTP source with the CDK](tutorials/cdk-speedrun.md)
- [Building a HTTP source with the CDK](tutorials/cdk-tutorial-python-http/getting-started.md)
- [Building a HTTP source with the CDK](tutorials/custom-python-connector/0-getting-started.md)
- [Building a Java destination](tutorials/building-a-java-destination.md)

As you implement your connector, make sure to review the [Best Practices for Connector Development](best-practices.md) guide.
Expand Down
4 changes: 2 additions & 2 deletions docs/connector-development/cdk-python/README.md
Expand Up @@ -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.

### Concepts & Documentation

Expand All @@ -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)

### Example Connectors

Expand Down
Expand Up @@ -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/`.

```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
Expand Down
Expand Up @@ -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).

## Read more:

Expand Down
385 changes: 0 additions & 385 deletions docs/connector-development/tutorials/building-a-python-source.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/connector-development/tutorials/cdk-speedrun.md
Expand Up @@ -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)

If you are a visual learner and want to see a video version of this guide going over each part in
detail, check it out below.
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

0 comments on commit 87f051c

Please sign in to comment.