https://github.com/prefecthq/prefect-airbyte

airbyte prefect

Last synced: 8 months ago
JSON representation

Host: GitHub
URL: https://github.com/prefecthq/prefect-airbyte
Owner: PrefectHQ
License: apache-2.0
Created: 2022-04-01T18:11:57.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-12-03T20:01:24.000Z (over 1 year ago)
Last Synced: 2025-01-23T00:30:20.954Z (over 1 year ago)
Topics: airbyte, prefect
Language: Python
Homepage: https://PrefectHQ.github.io/prefect-airbyte/
Size: 1.84 MB
Stars: 41
Watchers: 14
Forks: 8
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          > [!IMPORTANT] This repo is no longer actively maintained by @PrefectHQ

> You can find integrations actively maintained by @PrefectHQ [here](https://docs.prefect.io/integrations/integrations)

# prefect-airbyte



    

        

    

        

    

        

    

        

    


    

        

    

        



## Welcome!

`prefect-airbyte` is a collection of prebuilt Prefect tasks and flows that can be used to quickly construct Prefect flows to interact with [Airbyte](https://airbyte.io/).

## Getting Started

### Python setup

Requires an installation of Python 3.7+

We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.

These tasks are designed to work with Prefect 2.0. For more information about how to use Prefect, please refer to the [Prefect documentation](https://orion-docs.prefect.io/).

### Airbyte setup

See [the airbyte documention](https://docs.airbyte.com/deploying-airbyte) on how to get your own instance.

### Installation

Install `prefect-airbyte`

```bash

pip install prefect-airbyte

```

A list of available blocks in `prefect-airbyte` and their setup instructions can be found [here](https://PrefectHQ.github.io/prefect-airbyte/#blocks-catalog).

### Examples

#### Create an `AirbyteServer` block and save it

```python

from prefect_airbyte.server import AirbyteServer

# running airbyte locally at http://localhost:8000 with default auth

local_airbyte_server = AirbyteServer()

# running airbyte remotely at http://: as user `Marvin`

remote_airbyte_server = AirbyteServer(

    username="Marvin",

    password="DontPanic42",

    server_host="42.42.42.42",

    server_port="4242"

)

local_airbyte_server.save("my-local-airbyte-server")

remote_airbyte_server.save("my-remote-airbyte-server")

```

#### Trigger a defined connection sync

```python

from prefect import flow

from prefect_airbyte.server import AirbyteServer

from prefect_airbyte.connections import AirbyteConnection

from prefect_airbyte.flows import run_connection_sync

server = AirbyteServer(server_host="localhost", server_port=8000)

connection = AirbyteConnection(

    airbyte_server=server,

    connection_id="e1b2078f-882a-4f50-9942-cfe34b2d825b",

    status_updates=True,

)

@flow

def airbyte_syncs():

    # do some setup

    sync_result = run_connection_sync(

        airbyte_connection=connection,

    )

    # do some other things, like trigger DBT based on number of records synced

    print(f'Number of Records Synced: {sync_result.records_synced}')

```

```console

❯ python airbyte_syncs.py

03:46:03 | prefect.engine - Created flow run 'thick-seahorse' for flow 'example_trigger_sync_flow'

03:46:03 | Flow run 'thick-seahorse' - Using task runner 'ConcurrentTaskRunner'

03:46:03 | Flow run 'thick-seahorse' - Created task run 'trigger_sync-35f0e9c2-0' for task 'trigger_sync'

03:46:03 | prefect - trigger airbyte connection: e1b2078f-882a-4f50-9942-cfe34b2d825b, poll interval 3 seconds

03:46:03 | prefect - pending

03:46:06 | prefect - running

03:46:09 | prefect - running

03:46:12 | prefect - running

03:46:16 | prefect - running

03:46:19 | prefect - running

03:46:22 | prefect - Job 26 succeeded.

03:46:22 | Task run 'trigger_sync-35f0e9c2-0' - Finished in state Completed(None)

03:46:22 | Flow run 'thick-seahorse' - Finished in state Completed('All states completed.')

```

#### Export an Airbyte instance's configuration

**NOTE**: The API endpoint corresponding to this task is no longer supported by open-source Airbyte versions as of v0.40.7. Check out the [Octavia CLI docs](https://github.com/airbytehq/airbyte/tree/master/octavia-cli) for more info.

```python

import gzip

from prefect import flow, task

from prefect_airbyte.configuration import export_configuration

from prefect_airbyte.server import AirbyteServer

@task

def zip_and_write_somewhere(

      airbyte_config: bytearray,

      somewhere: str,

):

    with gzip.open(somewhere, 'wb') as f:

        f.write(airbyte_config)

@flow

def example_export_configuration_flow(filepath: str):

    # Run other tasks and subflows here

    airbyte_config = export_configuration(

        airbyte_server=AirbyteServer.load("my-airbyte-server-block")

    )

    zip_and_write_somewhere(

        somewhere=filepath,

        airbyte_config=airbyte_config

    )

if __name__ == "__main__":

    example_export_configuration_flow('*://**/my_destination.gz')

```

#### Use `with_options` to customize options on any existing task or flow

```python

from prefect import flow

from prefect_airbyte.connections import AirbyteConnection

from prefect_airbyte.flows import run_connection_sync

custom_run_connection_sync = run_connection_sync.with_options(

    name="Custom Airbyte Sync Flow",

    retries=2,

    retry_delay_seconds=10,

)

 

 @flow

 def some_airbyte_flow():

    custom_run_connection_sync(

        airbyte_connection=AirbyteConnection.load("my-airbyte-connection-block")

    )

 

 some_airbyte_flow()

```

For more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://orion-docs.prefect.io/collections/usage/)!

## Resources

If you encounter and bugs while using `prefect-airbyte`, feel free to open an issue in the [prefect-airbyte](https://github.com/PrefectHQ/prefect-airbyte) repository.

If you have any questions or issues while using `prefect-airbyte`, you can find help in either the [Prefect Discourse forum](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack)

Feel free to star or watch [`prefect-airbyte`](https://github.com/PrefectHQ/prefect-airbyte) for updates too!

## Contribute

If you'd like to help contribute to fix an issue or add a feature to `prefect-airbyte`, please [propose changes through a pull request from a fork of the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork).

 

### Contribution Steps:

1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)

2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)

3. Install the repository and its dependencies:

```

pip install -e ".[dev]"

```

4. Make desired changes.

5. Add tests.

6. Insert an entry to [CHANGELOG.md](https://github.com/PrefectHQ/prefect-airbyte/blob/main/CHANGELOG.md)

7. Install `pre-commit` to perform quality checks prior to commit:

```

 pre-commit install

 ```

8. `git commit`, `git push`, and create a pull request.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/prefecthq/prefect-airbyte

Awesome Lists containing this project

README