Skip to content

epoch8/datapipe-app

Repository files navigation

datapipe-app

datapipe-app implements two aspects to make every datapipe pipeline to work as an application:

  1. REST API + debug UI based of FastAPI
  2. datapipe CLI tool

Common usage

Common pattern to use datapipe-app is to create app.py with the following code:

from datapipe_app import DatapipeApp

from pipeline import ds, catalog, pipeline

app = DatapipeApp(ds, catalog, pipeline)

Where pipeline is a module that defines common elements: ds, catalog and pipeline.

REST API + UI

DatapipeApp inherits from FastApi app and can be started with datapipe CLI or directly with server like uvicorn.

datapipe --pipeline app:app api

UI

Datapipe App UI

REST API

API documentation can be found at /api/v1alpha1/docs sub URL.