https://github.com/harshithmullapudi/airbyte-sdk
airbyte-sdk is a package to manage Airbyte configurations through your code
https://github.com/harshithmullapudi/airbyte-sdk
airbyte api-client sdk
Last synced: about 1 year ago
JSON representation
airbyte-sdk is a package to manage Airbyte configurations through your code
- Host: GitHub
- URL: https://github.com/harshithmullapudi/airbyte-sdk
- Owner: harshithmullapudi
- License: apache-2.0
- Created: 2022-07-17T16:34:54.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-20T17:44:11.000Z (almost 4 years ago)
- Last Synced: 2025-03-23T00:24:35.983Z (about 1 year ago)
- Topics: airbyte, api-client, sdk
- Language: TypeScript
- Homepage: https://harshithmullapudi.github.io/airbyte-sdk/
- Size: 421 KB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# airbyte-sdk
## Disclaimer
The project is in **alpha** version.
Readers can refer to our [opened GitHub issues](https://github.com/harshithmullapudi/airbyte-sdk) to check the ongoing work on this project.
## What is `airbyte-sdk`?
airbyte-sdk is a package to manage Airbyte configurations through your code.
It can handle CRUD for sources, destinations, definitions and connections. It also has some commonly used functions to make the usage simpler.
## When should I use `airbyte-sdk`?
When you want to handle Airbyte configurations through some automation or through API. You can also make use of this while creating some scripts.
## Table of content
- [Install](#install)
- [Configuration](#configuration)
- [Classes and functions](#classes-functions)
- [Contributing](#contributing)
- [Example](#example)
## Install
Your project need to support node version 16 or above
Using npm:
```bash
$ npm install airbyte-sdk
```
Using yarn:
```bash
$ yarn add airbyte-sdk
```
## Configuration
You will have to provide the base url for the Airbyte instance.
```js
setAirbyteHost('http://localhost:8001/');
```
You can also set default headers as described below
```js
setAuthenticationHeaders(headers);
```
## Classes and functions
You can go through the following [URL](https://harshithmullapudi.github.io/airbyte-sdk/)
## Contributing
1. Go to https://github.com/harshithmullapudi/airbyte-sdk
2. Create an issue if the issue is not already created, attach a tag [Bug, Improvement]
3. Fork the repo, code and test thoroughly.
4. Open a PR on the repo from your fork.
## Examples
```js
var { setAirbyteHost, Source, WorkspaceModel } = require('airbyte-sdk');
async function main() {
setAirbyteHost('http://localhost:8000');
const workspaceModel = await WorkspaceModel.createWorkspaceInstanceFromId(
'29cfb153-40a9-478a-a37c-f519560459b2',
);
const source = new Source(workspaceModel);
const allSources = await source.getAllSources();
console.log(allSources);
}
main();
```