orvanta 1.698.0

A client library for accessing Orvanta server wrapping the Orvanta client API

orvanta

The core client for the Orvanta platform.

Usage

Basic Usage

The orvanta package has several methods at the top-level for the most frequent operations you will need.

The following are some common examples:

import time

import orvanta


def main():
    # Get the value of a variable
    orvanta.get_variable("u/user/variable_path")
    
    # Run a script synchronously and get the result
    orvanta.run_script("f/pathto/script", args={"arg1": "value1"})
    
    # Get the value of a resource
    orvanta.get_resource("u/user/resource_path")
    
    # Set the script's state
    orvanta.set_state({"ts": time.time()})
    
    # Get the script's state
    orvanta.get_state()

Advanced Usage

The orvanta package also exposes the Orvanta class, which is the core client for the Orvanta platform.

import time

from orvanta import Orvanta

def main():
    client = Orvanta(
        # token=...  <- this is optional. otherwise the client will look for the OV_TOKEN env var
    )

    # Get the current version of the client
    client.version

    # Get the current user
    client.user
    
    # Convenience get and post methods exist for https://orvanta.cloud/openapi.html#/
    # these are thin wrappers around the httpx library's get and post methods
    # list worker groups
    client.get("/configs/list_worker_groups")
    # create a group
    client.post(
        f"/w/{client.workspace}/groups/create",
        json={
            "name": "my-group",
            "summary": "my group summary",
        }
    )
    
    # Get and set the state of the script
    now = time.time()
    client.state = {"ts": now}
    assert client.state == {"ts": now}
    
    # Run a job asynchronously
    job_id = client.run_script_async(path="path/to/script")
    # Get its status
    client.get_job_status(job_id)
    # Get its result
    client.get_result(job_id)