diff --git a/README.md b/README.md index e3a7d25..7bd543e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ # UiPath Runtime [![PyPI downloads](https://img.shields.io/pypi/dm/uipath-runtime.svg)](https://pypi.org/project/uipath-runtime/) +[![PyPI - Version](https://img.shields.io/pypi/v/uipath-runtime)](https://pypi.org/project/uipath-runtime/) [![Python versions](https://img.shields.io/pypi/pyversions/uipath-runtime.svg)](https://pypi.org/project/uipath-runtime/) Runtime abstractions and contracts for the UiPath Python SDK. ## Overview -`uipath-runtime` provides the foundational interfaces and base contracts for building agent runtimes in the UiPath ecosystem. -It defines the protocols that all runtime implementations must follow and provides utilities for execution context, event streaming, tracing, and structured error handling. +`uipath-runtime` provides the foundational interfaces and base contracts for building agent runtimes in the UiPath ecosystem. It defines the protocols that all runtime implementations must follow and provides utilities for execution context, event streaming, tracing, structured error handling, durable execution, and human-in-the-loop interactions. This package is typically used as a dependency by higher-level SDKs such as: -- [`uipath`](https://pypi.org/project/uipath) -- [`uipath-langchain`](https://pypi.org/project/uipath-langchain) -- [`uipath-llamaindex`](https://pypi.org/project/uipath-llamaindex) -- [`uipath-mcp`](https://pypi.org/project/uipath-mcp) +- [`uipath`](https://github.com/uipath/uipath-python) [![PyPI](https://img.shields.io/pypi/v/uipath?label=pypi)](https://pypi.org/project/uipath/) [![Downloads](https://img.shields.io/pypi/dm/uipath?label=)](https://pypi.org/project/uipath/) [![GitHub](https://img.shields.io/github/stars/uipath/uipath-python?style=social)](https://github.com/uipath/uipath-python) +- [`uipath-langchain`](https://github.com/uipath/uipath-langchain-python) [![PyPI](https://img.shields.io/pypi/v/uipath-langchain?label=pypi)](https://pypi.org/project/uipath-langchain/) [![Downloads](https://img.shields.io/pypi/dm/uipath-langchain?label=)](https://pypi.org/project/uipath-langchain/) [![GitHub](https://img.shields.io/github/stars/uipath/uipath-langchain-python?style=social)](https://github.com/uipath/uipath-langchain-python) +- [`uipath-llamaindex`](https://github.com/uipath/uipath-llamaindex-python) [![PyPI](https://img.shields.io/pypi/v/uipath-llamaindex?label=pypi)](https://pypi.org/project/uipath-llamaindex/) [![Downloads](https://img.shields.io/pypi/dm/uipath-llamaindex?label=)](https://pypi.org/project/uipath-llamaindex/) [![GitHub](https://img.shields.io/github/stars/uipath/uipath-llamaindex-python?style=social)](https://github.com/uipath/uipath-llamaindex-python) +- [`uipath-mcp`](https://github.com/uipath/uipath-mcp-python) [![PyPI](https://img.shields.io/pypi/v/uipath-mcp?label=pypi)](https://pypi.org/project/uipath-mcp/) [![Downloads](https://img.shields.io/pypi/dm/uipath-mcp?label=)](https://pypi.org/project/uipath-mcp/) [![GitHub](https://img.shields.io/github/stars/uipath/uipath-mcp-python?style=social)](https://github.com/uipath/uipath-mcp-python) You would use this directly only if you're building custom runtime implementations. @@ -24,6 +24,10 @@ You would use this directly only if you're building custom runtime implementatio uv add uipath-runtime ``` +## Developer Tools + +For testing and debugging your runtimes, check out [`uipath-dev`](https://github.com/uipath/uipath-dev-python) - an interactive terminal application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts. + ## Runtime Protocols All runtimes implement the `UiPathRuntimeProtocol` (or one of its sub-protocols):