sinbadflow 0.3

A simple pipeline creation and execution tool

Simple pipeline creation and execution tool

Sinbadflow is a simple pipeline creation and execution tool. It was created having Databricks notebooks workflow in mind, however with flexible implementation options the tool can be customized to fit any task. Named after famous cartoon "Sinbad: Legend of the Seven Seas" the library provides ability to create and run agents with specific triggers and conditional functions in parallel or single mode. With the simple, yet intuitive, code based syntax we can create elaborative pipelines to help with any data engineering, data science or software development task.

Instalation

To install use:

pip install sinbadflow

Usage

Sinbadflow supports single or parallel run with different execution triggers. To build a pipeline use >> symbol between two agents. Example Databricks notebooks pipeline (one-by-one execution):

from sinbadflow.agents import DatabricksAgent as dbr
from sinbadflow import Trigger

pipeline = dbr('/path/to/notebook1') >> dbr('path/to/another/notebook')

Parallel run pipeline (agents in list are executed in parallel mode):

pipeline = dbr() >> [dbr('/parallel_run_notebook'), dbr('/another_parallel_notebook')]

The flow can be controlled by using triggers. Sinbadflow supports these triggers:

• Trigger.DEFAULT - default trigger, the agent is always executed.
• Trigger.OK_PREV - agent will be executed if previous agent finished successfully.
• Trigger.OK_ALL - agent will be executed if so far no fails are recorded in the pipeline.
• Trigger.FAIL_PREV - agent will be executed if previous agent run failed.
• Trigger.FAIL_ALL - agent will be executed if all previous runs failed.

An example workflow would look like this:

pipeline = (dbr('/execute') >> [dbr('/handle_ok', Trigger.OK_PREV), dbr('/handle_fail', Trigger.FAIL_PREV)]
             >> dbr('/save_all', Trigger.OK_ALL) >> dbr('/log_all_failed', Trigger.FAIL_ALL))

To run the pipeline:

from sinbadflow import Sinbadflow

sf = Sinbadflow()

sf.run(pipeline)

The pipeline will be executed and results will be logged with selected method (print/logging supported). Sinbadflow will always run the full pipeline, there is no implementation for early stoppage if the pipeline fails. There should be at least two agents in the pipeline in order for it to work. If you want to run only one agent you can always create an empty agent in front of it, which will be skipped:

one_element_pipeline = dbr() >> dbr('single_notebook_to_run')

Conditional functions

For more flexible workflow control Sinbadflow also supports conditional functions check. This serves as more elaborative triggers for the agents.

from sinbadflow.agents import DatabricksAgent as dbr
from datetime import date

def is_monday():
    return date.today().weekday() == 0

pipeline = dbr('/notebook1', conditional_func=is_monday) >> dbr('/notebook2', conditional_func=is_monday)

In the example above notebooks will be skipped if today is not Monday because of conditional_fuc function. Sinbadflow also provides ability to apply conditional function to the whole pipeline using apply_conditional_func method.

from sinbadflow.utils import apply_conditional_func

pipeline = dbr('/notebook1') >> dbr('/notebook2') >> dbr('/notebook3')

pipeline = apply_conditional_func(pipeline, is_monday)

Custom Agents

Sinbadflow provides ability to create your own agents. In order to do that, your agent must inherit from BaseAgent class, pass the data and trigger parameters to parent class (also **kwargs if you are planning to use conditional functions) and implement run() method. An example DummyAgent:

from sinbadflow.agents import BaseAgent
from sinbadflow import Trigger
from sinbadflow import Sinbadflow


class DummyAgent(BaseAgent):
    def __init__(self, data, trigger=Trigger.DEFAULT, **kwargs):
        super(DummyAgent, self).__init__(data, trigger, **kwargs)

    def run(self):
        print(f'    ------Running my DummyAgent with data: {self.data}')

def condition():
    return False

pipeline = DummyAgent('secret_data') >> [DummyAgent(
    'simple_data', conditional_func=condition), DummyAgent('important_data', Trigger.OK_ALL)]

sf = Sinbadflow()
sf.run(pipeline)

Additional help

Use built in help() method for additional information about the classes and methods. Do not hesitate to contact me with any question. Pull requests are encouraged!

Contributors

Special thank you for everyone who contributed to the project:

Robertas Sys, Emilija Lamanauskaite