Skip to content

Commit

Permalink
Add docs section explaining how to build an airbyte connector from a …
Browse files Browse the repository at this point in the history
…singer tap (#1087)
  • Loading branch information
sherifnada authored Nov 25, 2020
1 parent a5f509b commit 7132152
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/contributing-to-airbyte/building-new-connector/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ Follow the instructions generated in the `CHECKLIST.md` file to bootstrap the co

The generated `README.md` will also contain instructions on how to iterate.

### Creating a Connector from a Singer Tap
[Singer.io](http://singer.io/) is an established open source framework with a vibrant community and many available connectors (known as taps & targets). Airbyte makes it simple & easy to build an Airbyte connector from a Singer tap. The basic idea is to wrap the Singer tap in a shim Python package which makes the Singer tap compatible with the Airbyte protocols, then publishing that in a Docker image consumable by Airbyte.

To create an Airbyte connector from a Singer tap, run the connector generator as described above and choose the Singer generator. The generated package will contain the details about exactly what needs to be done.

See the [Github Connector](https://github.com/airbytehq/airbyte/tree/master/airbyte-integrations/connectors/source-github-singer) for an example of an Airbyte Connector implemented on top of a Singer tap.

## Updating a connector

Once you've finished iterating on the changes to a connector as specified in its `README.md`, follow these instructions to tell Airbyte to use the latest version of your connector.
Expand Down

0 comments on commit 7132152

Please sign in to comment.