Script Quickstart

​

Python Script

• Code: for Python scripts, it must have at least a main function.
• Settings: settings & metadata about the Script such as its path, summary, description, jsonschema of its inputs (inferred from its signature).

#import getOperate
import nltk
from nltk.sentiment import SentimentIntensityAnalyzer
nltk.download("vader_lexicon")

def main(text: str = "Wow, NLTK is really powerful!"):
    return SentimentIntensityAnalyzer().polarity_scores(text)

​

Settings

• Path is the Script’s unique identifier that consist of the script’s owner, and the script’s name. The owner can be either a user, or a group (folder).
• Summary (optional) is a short, human-readable summary of the Script. It will be displayed as a title across getOperate. If omitted, the UI will use the path by default.
• Language of the script.
• Description is where you can give instructions through the auto-generated UI to users on how to run your Script. It supports markdown.
• Script kind: Action (by default), Trigger, Approval or Error Handler. This acts as a tag to filter appropriate scripts from the flow editor.

• Concurrency limits enable defining concurrency limits for scripts and inline scripts within flows to prevent exceeding the API Limit of the targeted API.
• Worker group tag to assign scripts to specific worker groups (such as nodes with GPU accelaration).
• Cache to cache the results for each possible inputs for a given time.
• Dedicated Workers to run the script on, to run the script at native speed. Only available on enterprise edition and for the Bun language.

​

Code

import os
import getOperate

# You can import any PyPi package. 

# you can use typed resources by doing a type alias to dict
#postgresql = dict

def main(
    no_default: str,
    #db: postgresql,
    name="Nicolas Bourbaki",
    age=42,
    obj: dict = {"even": "dicts"},
    l: list = ["or", "lists!"],
    file_: bytes = bytes(0),
):

    print(f"Hello World and a warm welcome especially to {name}")
    print("and its acolytes..", age, obj, l, len(file_))

    # retrieve variables, resources, states using the getOperate client
    try:
        secret = getOperate.get_variable("f/examples/secret")
    except:
        secret = "No secret yet at f/examples/secret !"
    print(f"The variable at `f/examples/secret`: {secret}")

    # Get last state of this script execution by the same trigger/user
    last_state = getOperate.get_state()
    new_state = {"foo": 42} if last_state is None else last_state
    new_state["foo"] += 1
    getOperate.set_state(new_state)

    # fetch context variables
    user = os.environ.get("GO_USERNAME")

    # return value is converted to JSON
    return {"splitted": name.split(), "user": user, "state": new_state}

• The main arguments are used for generating
  • the input spec of the Script
  • the frontend that you see when running the Script as a standalone app.
• Type annotations are used to generate the UI form, and help pre-validate inputs. While not mandatory, they are highly recommended. You can customize the UI in later steps (but not change the input type!).

def main(name: str):
  print("Hello world. Oh, it's you {}? Greetings!".format(name))
  return name

​

Instant Preview & Testing

main(name: str = "you")

​

Customize UI

​

Run!

​

What’s next?

• Pass variables and secrets to a script.
• Connect to resources.
• Trigger that script in many ways.
• Compose scripts in Flows or Apps.
• You can share your scripts with the community on getOperate Hub. Once submitted, they will be verified by moderators before becoming available to everyone right within getOperate.