# prefect-airbyte
<p align="center">
<a href="https://pypi.python.org/pypi/prefect-airbyte/" alt="PyPI version">
<img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-airbyte?color=0052FF&labelColor=090422"></a>
<a href="https://github.com/PrefectHQ/prefect-airbyte/" alt="Stars">
<img src="https://img.shields.io/github/stars/PrefectHQ/prefect-airbyte?color=0052FF&labelColor=090422" /></a>
<a href="https://pepy.tech/badge/prefect-airbyte/" alt="Downloads">
<img src="https://img.shields.io/pypi/dm/prefect-airbyte?color=0052FF&labelColor=090422" /></a>
<a href="https://github.com/PrefectHQ/prefect-airbyte/pulse" alt="Activity">
<img src="https://img.shields.io/github/commit-activity/m/PrefectHQ/prefect-airbyte?color=0052FF&labelColor=090422" /></a>
<br>
<a href="https://prefect-community.slack.com" alt="Slack">
<img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /></a>
<a href="https://discourse.prefect.io/" alt="Discourse">
<img src="https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse" /></a>
</p>
## 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://<someIP>:<somePort> 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/PrefectHQ/prefect-airbyte",
"name": "prefect-airbyte",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "prefect",
"author": "Prefect Technologies, Inc.",
"author_email": "help@prefect.io",
"download_url": "https://files.pythonhosted.org/packages/e3/40/464e47b85f78d0a57ba7f7c5b45823801ce9d4527f2c6cd2c50d098958d3/prefect-airbyte-0.3.2.tar.gz",
"platform": null,
"description": "# prefect-airbyte\n\n<p align=\"center\">\n <a href=\"https://pypi.python.org/pypi/prefect-airbyte/\" alt=\"PyPI version\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/prefect-airbyte?color=0052FF&labelColor=090422\"></a>\n <a href=\"https://github.com/PrefectHQ/prefect-airbyte/\" alt=\"Stars\">\n <img src=\"https://img.shields.io/github/stars/PrefectHQ/prefect-airbyte?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://pepy.tech/badge/prefect-airbyte/\" alt=\"Downloads\">\n <img src=\"https://img.shields.io/pypi/dm/prefect-airbyte?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://github.com/PrefectHQ/prefect-airbyte/pulse\" alt=\"Activity\">\n <img src=\"https://img.shields.io/github/commit-activity/m/PrefectHQ/prefect-airbyte?color=0052FF&labelColor=090422\" /></a>\n <br>\n <a href=\"https://prefect-community.slack.com\" alt=\"Slack\">\n <img src=\"https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack\" /></a>\n <a href=\"https://discourse.prefect.io/\" alt=\"Discourse\">\n <img src=\"https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse\" /></a>\n</p>\n\n## Welcome!\n\n`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/).\n\n## Getting Started\n\n### Python setup\n\nRequires an installation of Python 3.7+\n\nWe recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.\n\nThese 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/).\n\n### Airbyte setup\nSee [the airbyte documention](https://docs.airbyte.com/deploying-airbyte) on how to get your own instance.\n\n### Installation\n\nInstall `prefect-airbyte`\n\n```bash\npip install prefect-airbyte\n```\n\nA list of available blocks in `prefect-airbyte` and their setup instructions can be found [here](https://PrefectHQ.github.io/prefect-airbyte/#blocks-catalog).\n\n### Examples\n#### Create an `AirbyteServer` block and save it\n```python\nfrom prefect_airbyte.server import AirbyteServer\n\n# running airbyte locally at http://localhost:8000 with default auth\nlocal_airbyte_server = AirbyteServer()\n\n# running airbyte remotely at http://<someIP>:<somePort> as user `Marvin`\nremote_airbyte_server = AirbyteServer(\n username=\"Marvin\",\n password=\"DontPanic42\",\n server_host=\"42.42.42.42\",\n server_port=\"4242\"\n)\n\nlocal_airbyte_server.save(\"my-local-airbyte-server\")\n\nremote_airbyte_server.save(\"my-remote-airbyte-server\")\n\n```\n\n\n#### Trigger a defined connection sync\n```python\nfrom prefect import flow\nfrom prefect_airbyte.server import AirbyteServer\nfrom prefect_airbyte.connections import AirbyteConnection\nfrom prefect_airbyte.flows import run_connection_sync\n\nserver = AirbyteServer(server_host=\"localhost\", server_port=8000)\n\nconnection = AirbyteConnection(\n airbyte_server=server,\n connection_id=\"e1b2078f-882a-4f50-9942-cfe34b2d825b\",\n status_updates=True,\n)\n\n@flow\ndef airbyte_syncs():\n # do some setup\n\n sync_result = run_connection_sync(\n airbyte_connection=connection,\n )\n\n # do some other things, like trigger DBT based on number of records synced\n print(f'Number of Records Synced: {sync_result.records_synced}')\n```\n\n```console\n\n\u276f python airbyte_syncs.py\n03:46:03 | prefect.engine - Created flow run 'thick-seahorse' for flow 'example_trigger_sync_flow'\n03:46:03 | Flow run 'thick-seahorse' - Using task runner 'ConcurrentTaskRunner'\n03:46:03 | Flow run 'thick-seahorse' - Created task run 'trigger_sync-35f0e9c2-0' for task 'trigger_sync'\n03:46:03 | prefect - trigger airbyte connection: e1b2078f-882a-4f50-9942-cfe34b2d825b, poll interval 3 seconds\n03:46:03 | prefect - pending\n03:46:06 | prefect - running\n03:46:09 | prefect - running\n03:46:12 | prefect - running\n03:46:16 | prefect - running\n03:46:19 | prefect - running\n03:46:22 | prefect - Job 26 succeeded.\n03:46:22 | Task run 'trigger_sync-35f0e9c2-0' - Finished in state Completed(None)\n03:46:22 | Flow run 'thick-seahorse' - Finished in state Completed('All states completed.')\n```\n\n\n#### Export an Airbyte instance's configuration\n\n**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.\n\n```python\nimport gzip\n\nfrom prefect import flow, task\nfrom prefect_airbyte.configuration import export_configuration\nfrom prefect_airbyte.server import AirbyteServer\n\n@task\ndef zip_and_write_somewhere(\n airbyte_config: bytearray,\n somewhere: str,\n):\n with gzip.open(somewhere, 'wb') as f:\n f.write(airbyte_config)\n\n@flow\ndef example_export_configuration_flow(filepath: str):\n\n # Run other tasks and subflows here\n\n airbyte_config = export_configuration(\n airbyte_server=AirbyteServer.load(\"my-airbyte-server-block\")\n )\n\n zip_and_write_somewhere(\n somewhere=filepath,\n airbyte_config=airbyte_config\n )\n\nif __name__ == \"__main__\":\n example_export_configuration_flow('*://**/my_destination.gz')\n```\n#### Use `with_options` to customize options on any existing task or flow\n\n```python\nfrom prefect import flow\nfrom prefect_airbyte.connections import AirbyteConnection\nfrom prefect_airbyte.flows import run_connection_sync\n\ncustom_run_connection_sync = run_connection_sync.with_options(\n name=\"Custom Airbyte Sync Flow\",\n retries=2,\n retry_delay_seconds=10,\n)\n \n @flow\n def some_airbyte_flow():\n custom_run_connection_sync(\n airbyte_connection=AirbyteConnection.load(\"my-airbyte-connection-block\")\n )\n \n some_airbyte_flow()\n```\n\nFor more tips on how to use tasks and flows in a Collection, check out [Using Collections](https://orion-docs.prefect.io/collections/usage/)!\n\n\n## Resources\n\nIf 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.\n\nIf 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)\n\nFeel free to star or watch [`prefect-airbyte`](https://github.com/PrefectHQ/prefect-airbyte) for updates too!\n\n## Contribute\n\nIf 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).\n \n### Contribution Steps:\n1. [Fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#forking-a-repository)\n2. [Clone the forked repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository)\n3. Install the repository and its dependencies:\n```\npip install -e \".[dev]\"\n```\n4. Make desired changes.\n5. Add tests.\n6. Insert an entry to [CHANGELOG.md](https://github.com/PrefectHQ/prefect-airbyte/blob/main/CHANGELOG.md)\n7. Install `pre-commit` to perform quality checks prior to commit:\n```\n pre-commit install\n ```\n8. `git commit`, `git push`, and create a pull request.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "prefect-airbyte contains tasks for interacting with Airbyte instances",
"version": "0.3.2",
"project_urls": {
"Homepage": "https://github.com/PrefectHQ/prefect-airbyte"
},
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ee7cf412eed92a19453d2b3fb287801024d1770aa9c09efebea22d893d4e3e8a",
"md5": "982a984f0e4823e567a75e836a7f9fc6",
"sha256": "58d0140f0dbce6a508ed54d115d5d8df825456cf5886c4e50fface76ce4aa602"
},
"downloads": -1,
"filename": "prefect_airbyte-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "982a984f0e4823e567a75e836a7f9fc6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 19733,
"upload_time": "2023-11-29T19:54:32",
"upload_time_iso_8601": "2023-11-29T19:54:32.382964Z",
"url": "https://files.pythonhosted.org/packages/ee/7c/f412eed92a19453d2b3fb287801024d1770aa9c09efebea22d893d4e3e8a/prefect_airbyte-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e340464e47b85f78d0a57ba7f7c5b45823801ce9d4527f2c6cd2c50d098958d3",
"md5": "2b1561bee4f5fe0582ffde87381b8481",
"sha256": "dac130a05ba9dee3c31060c78212b2d3b731189baff6b7c1a2f7c1aa7cfba1fd"
},
"downloads": -1,
"filename": "prefect-airbyte-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "2b1561bee4f5fe0582ffde87381b8481",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 38167,
"upload_time": "2023-11-29T19:54:33",
"upload_time_iso_8601": "2023-11-29T19:54:33.959626Z",
"url": "https://files.pythonhosted.org/packages/e3/40/464e47b85f78d0a57ba7f7c5b45823801ce9d4527f2c6cd2c50d098958d3/prefect-airbyte-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 19:54:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PrefectHQ",
"github_project": "prefect-airbyte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "prefect-airbyte"
}
JSON
