This release is a pre-release and may not be stable for production use.
prefect-airbyte
Welcome!
prefect-airbyte is a collections of prebuilt Prefect tasks that can be used to quickly construct Prefect flows.
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.
Installation
Install prefect-airbyte
pip install prefect-airbyte
Airbyte setup
See the airbyte documention on how to get your own instance.
Examples
Trigger a defined connection sync
from prefect import flow
from prefect_airbyte.connections import trigger_sync
@flow
def example_trigger_sync_flow():
# Run other tasks and subflows here
trigger_sync(
connection_id="your-connection-id-to-sync",
poll_interval_s=3,
status_updates=True
)
example_trigger_sync_flow()
❯ 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
import gzip
from prefect import flow, task
from prefect_airbyte.configuration import export_configuration
@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_host="localhost",
airbyte_server_port="8000",
airbyte_api_version="v1",
)
zip_and_write_somewhere(
somewhere=filepath,
airbyte_config=airbyte_config
)
if __name__ == "__main__":
example_export_configuration_flow('*://**/my_destination.gz')
Resources
If you encounter and bugs while using prefect-airbyte, feel free to open an issue in the prefect-airbyte repository.
If you have any questions or issues while using prefect-airbyte, you can find help in either the Prefect Discourse forum or the Prefect Slack community
Development
If you'd like to install a version of prefect-airbyte for development, first clone the repository and then perform an editable install with pip:
git clone https://github.com/PrefectHQ/prefect-airbyte.git
cd prefect-airbyte/
pip install -e ".[dev]"
Metadata
Release files for prefect-airbyte 0a3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| prefect-airbyte-0a3.tar.gz | 28.0 kB | Without provenance | Details for prefect-airbyte-0a3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| prefect_airbyte-0a3-py3-none-any.whl | Python 3 | none | any | Details for prefect_airbyte-0a3-py3-none-any.whl |
Total release size: 40.7 kB
Release files / prefect-airbyte-0a3.tar.gz
| Download URL | prefect-airbyte-0a3.tar.gz |
|---|---|
| Size | 28.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
91366bb6d5958c12ac9d9ca99f38dbe1fe05f632ced812613a377f84b5d4724e
|
|
BLAKE2b-256 checksum How to use checksums |
cae97621b70db6eb6f052ef67b6d083ea1d77d277b808cb06c533270cc9187fa
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Release files / prefect_airbyte-0a3-py3-none-any.whl
| Download URL | prefect_airbyte-0a3-py3-none-any.whl |
|---|---|
| Size | 12.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
33405c9b8adb1bde72da5212db53e9c80c78871fdc899e0bae114b0f477b8899
|
|
BLAKE2b-256 checksum How to use checksums |
04cdbdf2deef14665751059e2966192620ea1320d4a75759d893f2bfc36dee8c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Security for prefect-airbyte 0a3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.