Merge pull request #1 from UiPath/fix/initial

cristipufu · web-flow · commit 1fb671c7569f · 2025-05-19T22:03:59.000+03:00
add basic structure
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,14 @@
+; https://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf
+charset = utf-8
+
+[*.{json,toml,yml}]
+indent_size = 2
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,7 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.9.6
+  hooks:
+    - id: ruff
+      args: [ --fix ]
+    - id: ruff-format
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.10
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,42 @@
+# Contributing to UiPath SDK
+
+## Local Development Setup
+
+### Prerequisites
+
+1. **Install Python 3.13**:
+    - Download and install Python 3.13 from the official [Python website](https://www.python.org/downloads/)
+    - Verify the installation by running:
+        ```sh
+        python3.13 --version
+        ```
+
+    Alternative: [mise](https://mise.jdx.dev/lang/python.html)
+
+2. **Install [uv](https://docs.astral.sh/uv/)**:
+    ```sh
+    pip install uv
+    ```
+
+3. **Create a virtual environment in the current working directory**:
+    ```sh
+    uv venv
+    ```
+
+4. **Install dependencies**:
+    ```sh
+    uv sync --all-extras
+    ```
+
+See `just --list` for linting, formatting and build commands.
+
+
+### Use SDK Locally
+1. Create a folder on your own device `mkdir project; cd project`
+2. Initialize the python project `uv` `uv init . --python 3.10`
+3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/uipath-mcp-python/uipath-mcp`
+4. Install the sdk in editable mode `uv add --editable ${PATH_TO_SDK}`
+
+:information_source: Instead of cloning the project into `.venv/lib/python3.10/site-packages/uipath-mcp`, this mode creates a file named `_uipath-mcp.pth` inside `.venv/lib/python3.10/site-packages`. This file contains the value of `PATH_TO_SDK`, which is added to `sys.path`—the list of directories where python searches for packages. (Run `python -c 'import sys; print(sys.path)'` to see the entries.)
+
+
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,80 @@
+[project]
+name = "uipath-llama"
+version = "0.0.1"
+description = "UiPath Llama SDK"
+readme = { file = "README.md", content-type = "text/markdown" }
+requires-python = ">=3.10"
+dependencies = [
+    "uipath>=2.0.56",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Build Tools",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+maintainers = [
+    { name = "Marius Cosareanu", email = "marius.cosareanu@uipath.com" },
+    { name = "Cristian Pufu", email = "cristian.pufu@uipath.com" }
+]
+
+[project.entry-points."uipath.middlewares"]
+register = "uipath_llama.middlewares:register_middleware"
+
+[project.urls]
+Homepage = "https://uipath.com"
+Repository = "https://github.com/UiPath/uipath-llama-python"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "mypy>=1.14.1",
+    "ruff>=0.9.4",
+    "pytest>=7.4.0",
+    "pytest-cov>=4.1.0",
+    "pytest-mock>=3.11.1",
+    "pre-commit>=4.1.0",
+    "numpy>=1.24.0",
+]
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"*" = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+plugins = [
+  "pydantic.mypy"
+]
+
+follow_imports = "silent"
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+addopts = "-ra -q"
+
+
diff --git a/src/uipath_llama/__init__.py b/src/uipath_llama/__init__.py
@@ -0,0 +1,3 @@
+from .middlewares import register_middleware
+
+__all__ = ["register_middleware"]
diff --git a/src/uipath_llama/_cli/__init__.py b/src/uipath_llama/_cli/__init__.py
@@ -0,0 +1 @@
+__all__: list[str] = []
diff --git a/src/uipath_llama/_cli/_runtime/_context.py b/src/uipath_llama/_cli/_runtime/_context.py
@@ -0,0 +1,11 @@
+from typing import Optional
+
+from uipath._cli._runtime._contracts import UiPathRuntimeContext
+
+from .._utils._config import LlamaConfig
+
+
+class UiPathLlamaRuntimeContext(UiPathRuntimeContext):
+    """Context information passed throughout the runtime execution."""
+
+    config: Optional[LlamaConfig] = None
diff --git a/src/uipath_llama/_cli/_runtime/_exception.py b/src/uipath_llama/_cli/_runtime/_exception.py
@@ -0,0 +1,17 @@
+from typing import Optional
+
+from uipath._cli._runtime._contracts import UiPathErrorCategory, UiPathRuntimeError
+
+
+class UiPathLlamaRuntimeError(UiPathRuntimeError):
+    """Custom exception for Llama runtime errors with structured error information."""
+
+    def __init__(
+        self,
+        code: str,
+        title: str,
+        detail: str,
+        category: UiPathErrorCategory = UiPathErrorCategory.UNKNOWN,
+        status: Optional[int] = None,
+    ):
+        super().__init__(code, title, detail, category, status, prefix="Llama")
diff --git a/src/uipath_llama/_cli/_runtime/_runtime.py b/src/uipath_llama/_cli/_runtime/_runtime.py
@@ -0,0 +1,62 @@
+import logging
+from typing import Optional
+
+from uipath import UiPath
+from uipath._cli._runtime._contracts import (
+    UiPathBaseRuntime,
+    UiPathErrorCategory,
+    UiPathRuntimeResult,
+)
+from uipath.tracing import wait_for_tracers
+
+from ._context import UiPathLlamaRuntimeContext
+from ._exception import UiPathLlamaRuntimeError
+
+logger = logging.getLogger(__name__)
+
+
+class UiPathLlamaRuntime(UiPathBaseRuntime):
+    """
+    A runtime class for hosting UiPath Llama agents.
+    """
+
+    def __init__(self, context: UiPathLlamaRuntimeContext):
+        super().__init__(context)
+        self.context: UiPathLlamaRuntimeContext = context
+        self._uipath = UiPath()
+
+    async def execute(self) -> Optional[UiPathRuntimeResult]:
+        """
+        Start the Llama agent runtime.
+
+        Returns:
+            Dictionary with execution results
+
+        Raises:
+            UiPathLlamaRuntimeError: If execution fails
+        """
+        await self.validate()
+
+        try:
+            a = 2
+
+        except Exception as e:
+            if isinstance(e, UiPathLlamaRuntimeError):
+                raise
+            detail = f"Error: {str(e)}"
+            raise UiPathLlamaRuntimeError(
+                "EXECUTION_ERROR",
+                "Llama Runtime execution failed",
+                detail,
+                UiPathErrorCategory.USER,
+            ) from e
+        finally:
+            wait_for_tracers()
+
+    async def validate(self) -> None:
+        """Validate runtime inputs and load Llama agent configuration."""
+        pass
+
+    async def cleanup(self) -> None:
+        """Clean up all resources."""
+        pass
diff --git a/src/uipath_llama/_cli/_utils/_config.py b/src/uipath_llama/_cli/_utils/_config.py
@@ -0,0 +1,40 @@
+import json
+import logging
+import os
+from typing import Any, Dict
+
+logger = logging.getLogger(__name__)
+
+
+class LlamaConfig:
+    def __init__(self, config_path: str = "llama.json"):
+        self.config_path = config_path
+
+        if self.exists:
+            self._load_config()
+
+    @property
+    def exists(self) -> bool:
+        """Check if llama.json exists"""
+        return os.path.exists(self.config_path)
+
+    def _load_config(self) -> None:
+        """Load and process Llama agent configuration."""
+        try:
+            with open(self.config_path, "r") as f:
+                self._raw_config = json.load(f)
+
+        except json.JSONDecodeError as e:
+            logger.error(f"Invalid JSON in {self.config_path}: {str(e)}")
+            raise
+        except Exception as e:
+            logger.error(f"Failed to load llama.json: {str(e)}")
+            raise
+
+    def load_config(self) -> Dict[str, Any]:
+        """Load and validate Llama agents configuration."""
+        if not self.exists:
+            raise FileNotFoundError(f"Config file not found: {self.config_path}")
+
+        self._load_config()
+        return self._raw_config
diff --git a/src/uipath_llama/_cli/cli_init.py b/src/uipath_llama/_cli/cli_init.py
@@ -0,0 +1,46 @@
+import asyncio
+import json
+
+from uipath._cli.middlewares import MiddlewareResult
+
+from ._utils._config import LlamaConfig
+
+
+async def llama_init_middleware_async(entrypoint: str) -> MiddlewareResult:
+    """Middleware to check for llama.json and create uipath.json with schemas"""
+    config = LlamaConfig()
+    if not config.exists:
+        return MiddlewareResult(
+            should_continue=True
+        )  # Continue with normal flow if no llama.json
+
+    try:
+        config.load_config()
+
+        entrypoints = []
+
+        uipath_data = {
+            "entryPoints": entrypoints
+        }
+
+        config_path = "uipath.json"
+
+        with open(config_path, "w") as f:
+            json.dump(uipath_data, f, indent=4)
+
+        return MiddlewareResult(
+            should_continue=False,
+            info_message=f"Configuration file {config_path} created successfully.",
+        )
+
+    except Exception as e:
+        return MiddlewareResult(
+            should_continue=False,
+            error_message=f"Error processing Llama agent configuration: {str(e)}",
+            should_include_stacktrace=True,
+        )
+
+
+def mcp_init_middleware(entrypoint: str) -> MiddlewareResult:
+    """Middleware to check for llama.json and create uipath.json with schemas"""
+    return asyncio.run(llama_init_middleware_async(entrypoint))
diff --git a/src/uipath_llama/_cli/cli_run.py b/src/uipath_llama/_cli/cli_run.py
diff --git a/src/uipath_llama/middlewares.py b/src/uipath_llama/middlewares.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+from .middlewares import register_middleware`
	`2`	`+`
	`3`	`+__all__ = ["register_middleware"]`