alessandrolollo / prefect-cubejs

Prefect collection of tasks to interact with Cube.js.

prefect-cubejs

Welcome!

Prefect collection of tasks to interact with Cube.js

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

pip install prefect-cubejs

Write and run a flow

from prefect import flow
from prefect_cubejs.tasks import (
    run_query
)


@flow
def example_flow():
    run_query(
        subdomain="<your Cube Cloud subdomain>",
        api_secret="<your Cube.js API secret>",
        query="<a Cube.js JSON formatted query>"
    )

example_flow()

Resources

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

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

git clone https://github.com/AlessandroLollo/prefect-cubejs.git

cd prefect-cubejs/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install

prefect-cubejs's Issues

Move sensitive information to a new CubeJS block

prefect-cubejs/prefect_cubejs/tasks.py

Line 15 in f685b7b

def run_query(

Maybe some optional keyword arguments can be required positional

https://github.com/AlessandroLollo/prefect-cubejs/blob/main/prefect_cubejs/tasks.py#L16-L18

Unlike Prefect 1.0, since there are no defaults trickling down from class initiation, I think
subdomain: Optional[str] = None,
can be
subdomain: str,