|
| 1 | +# UiPath Runtime Python SDK |
| 2 | + |
| 3 | +This repository contains the runtime abstractions and interfaces for building agent |
| 4 | +integrations in the UiPath ecosystem. |
| 5 | + |
| 6 | +## Building a New Integration |
| 7 | + |
| 8 | +If you are here to build a new integration for a Python agentic framework, read and |
| 9 | +follow **INTEGRATION_GENOME.md** — it is a complete blueprint that guides you through |
| 10 | +every step of building a UiPath runtime integration. |
| 11 | + |
| 12 | +Start by reading the genome's Phase 0 (Framework Discovery) and asking the user the |
| 13 | +discovery questions. Then proceed through each phase sequentially, following the quality |
| 14 | +gates. |
| 15 | + |
| 16 | +## Project Structure |
| 17 | + |
| 18 | +- `src/uipath/runtime/` — Core protocols and contracts |
| 19 | +- `src/uipath/runtime/base.py` — `UiPathRuntimeProtocol`, `UiPathExecutionRuntime` |
| 20 | +- `src/uipath/runtime/factory.py` — `UiPathRuntimeFactoryProtocol` |
| 21 | +- `src/uipath/runtime/registry.py` — `UiPathRuntimeFactoryRegistry` |
| 22 | +- `src/uipath/runtime/events/` — Event types (`UiPathRuntimeStateEvent`, `UiPathRuntimeMessageEvent`) |
| 23 | +- `src/uipath/runtime/resumable/` — HITL support (`UiPathResumableRuntime`) |
| 24 | +- `src/uipath/runtime/debug/` — Debugger support (`UiPathDebugRuntime`, breakpoints) |
| 25 | +- `src/uipath/runtime/chat/` — Chat bridge support (`UiPathChatRuntime`) |
| 26 | +- `src/uipath/runtime/schema.py` — Schema models (`UiPathRuntimeGraph`, nodes, edges) |
| 27 | +- `src/uipath/runtime/errors/` — Error contracts and categories |
| 28 | +- `INTEGRATION_GENOME.md` — Complete guide for building new integrations |
| 29 | + |
| 30 | +## Development |
| 31 | + |
| 32 | +```bash |
| 33 | +uv sync --all-extras |
| 34 | +uv run ruff check . |
| 35 | +uv run ruff check --fix . |
| 36 | +uv run pytest |
| 37 | +``` |
| 38 | + |
| 39 | +## Reference Integrations |
| 40 | + |
| 41 | +- `uipath-langchain-python` — LangGraph integration (FULL tier) |
| 42 | +- `uipath-integrations-python` — OpenAI Agents, LlamaIndex, Google ADK, Agent Framework |
0 commit comments