uipathlib 0.1.1

UiPath Cloud client package powered by Rust and PyO3.

uipathlib

UiPath Cloud client package for Python powered by Rust.

• Installation
• Usage
• Version
• Licence

Installation

pip install uipathlib

Usage

import uipathlib

client = uipathlib.UiPath(
    url_base="https://cloud.uipath.com/my_company/Production/orchestrator_",
    client_id="<client-id>",
    refresh_token="<client-secret-or-refresh-token>",
    scope="OR.Folders.Read OR.Jobs OR.Queues OR.Execution.Read OR.Robots.Read OR.Settings.Read",
)

# Check authentication state
print(client.is_auth())

# List queues
response = client.list_queues(fid="<folder-id>")
if response.status_code == 200:
    print(response.content)

# List queue items with OData filter
response = client.list_queue_items(
    fid="<folder-id>",
    filter="QueueDefinitionId eq 123456",
)
if response.status_code == 200:
    print(response.content)

# Start job
response = client.start_job(
    fid="<folder-id>",
    process_key="<release-key>",
    robot_id=None,
)
print(response.status_code)

For technical and contributor documentation, see DEV.md.

Version

Recommended way to read installed package version:

from importlib.metadata import version

print(version("uipathlib"))

Convenience attribute:

import uipathlib

print(uipathlib.__version__)

Licence

BSD-3-Clause Licence (see LICENSE)