`orbitra.flows.client.client`

Functions

get_flows_client(environment: str = 'prod') -> OrbitraFlowsClient

Get an authenticated OrbitraFlowsClient for the Orbitra Flows (Prefect) API. Args:

Returns:

A wrapper around SyncPrefectClient for interacting with Orbitra Flows. Methods:

api_url(self) -> str

Get the API URL of the Orbitra Flows server.

run_deployment_by_name(self, deployment_name: str, parameters: Optional[dict] = None) -> str

Run a Prefect deployment by name. Args:

deployment_name: The name of the deployment to run in the format <FLOW_NAME>/<DEPLOYMENT_NAME>.
parameters: Parameters to pass to the flow run. Defaults to None.

Returns: