Skip to content
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.

Sign up for GitHub

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

Add docs section explaining how to build an airbyte connector from a singer tap #1087

Merged
merged 2 commits into from
Nov 25, 2020
Merged

Add docs section explaining how to build an airbyte connector from a singer tap #1087

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
669cd72
Update README.md
sherifnada Nov 25, 2020
35f0944
Update README.md
sherifnada Nov 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/contributing-to-airbyte/building-new-connector/README.md
View file
Open in desktop
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