oloren 0.0.19

A simple python library for creating Oloren Orchestrator extensions.

Oloren Orchestrator - Python Extension Library

Installation

pip install oloren

A requirement is that you use Python version > 3.7 as the code uses dataclasses which were introduced in that version.

If for some reason you want to use it with Python 3.6 you can install the backport of dataclasses for Python 3.6 with:

pip install dataclasses

Getting Started

Check out this minimal example to get started:

import oloren as olo
import pandas as pd


@olo.register(description="Basic math operations on two numbers.")
def operation(operation=olo.Choice(["Add", "Subtract", "Multiply", "Divide"]), a=olo.Num(), b=olo.Num()):
    if operation == "Add":
        return a + b
    elif operation == "Subtract":
        return a - b
    elif operation == "Multiply":
        return a * b
    elif operation == "Divide":
        return a / b


@olo.register(description="Convert CSV file to JSON")
def dataframe_to_json(csv_file=olo.File()):
    return pd.read_csv(csv_file).to_json()


@olo.register(num_outputs=2)
def twooutputs(s=olo.String(), num=olo.Num()):
    return s, num


if __name__ == "__main__":
    olo.run("starterextension")

The key requirements are that each argument of your function has a default value that is set to one of the special Oloren types. These types subclass their relevant returned data types (e.g. string, int, float) so your autocomplete will work as normal.

Documentation

https://oloren-ai.github.io/python-extension-lib/index.html