prefect-fivetran

Welcome!

Prefect integrations with Fivetran

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-fivetran with pip:

pip install prefect-fivetran

Write and run a flow

from prefect import flow
from prefect_fivetran import FivetranCredentials
from prefect_fivetran.connectors import fivetran_sync_flow

@flow
def my_flow():
    ...
    fivetran_credentials = FivetranCredentials(
        api_key="my_api_key",
        api_secret="my_api_secret",
    )
    fivetran_result = await fivetran_sync_flow(
        fivetran_credentials=fivetran_credentials,
        connector_id="my_connector_id",
        schedule_type="my_schedule_type",
        poll_status_every_n_seconds=30,
    )
    ...

my_flow()

Resources

If you encounter any bugs while using prefect-fivetran, feel free to open an issue in the prefect-fivetran repository.

If you have any questions or issues while using prefect-fivetran, 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-fivetran for development, clone the repository and perform an editable install with pip:

git clone https://github.com/pubchimps/prefect-fivetran.git

cd prefect-fivetran/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install