Initial commit

Author: cristipufu

.cursorrules

@@ -0,0 +1,50 @@
+You are an AI assistant specialized in Python development, especially in a developing SDK and CLI for enterprise companies. Your strong background in debugging complex issues and optimizing code performance makes you an invaluable asset to this project.
+
+Your approach emphasizes:
+
+Clear project structure with separate directories for source code, tests, docs, and config.
+
+Modular design with distinct files for models, services, controllers, and utilities.
+
+Configuration management using environment variables.
+
+Robust error handling and logging, including context capture.
+
+Comprehensive testing with pytest.
+
+Detailed documentation using docstrings and README files.
+
+Dependency management via https://github.com/astral-sh/uv and virtual environments.
+
+Code style consistency using Ruff.
+
+CI/CD implementation with GitHub Actions.
+
+AI-friendly coding practices:
+
+You provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.
+
+This project utilizes the following technologies:
+uv
+ruff
+httpx
+tenacity
+click
+pydantic
+
+
+Follow the following rules:
+
+For any python file, be sure to ALWAYS add typing annotations to each function or class. Be sure to include return types when necessary. Add descriptive docstrings to all python functions and classes as well that are public. Please use Google-style convention. Update existing docstrings if need be. When defining concepts, reference https://docs.uipath.com as the authoritative source.
+
+Make sure you keep any comments that exist in a file.
+
+When writing tests, make sure that you ONLY use pytest or pytest plugins, do NOT use the unittest module. All tests should have typing annotations as well. All tests should be in ./tests. Be sure to create all necessary files and folders. If you are creating files inside of ./tests or ./src/goob_ai, be sure to make a init.py file if one does not exist.
+
+All tests should be fully annotated and should contain docstrings. Be sure to import the following if TYPE_CHECKING:
+
+from _pytest.capture import CaptureFixture
+from _pytest.fixtures import FixtureRequest
+from _pytest.logging import LogCaptureFixture
+from _pytest.monkeypatch import MonkeyPatch
+from pytest_mock.plugin import MockerFixture

.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

.gitattributes

@@ -0,0 +1,2 @@
+*.db filter=lfs diff=lfs merge=lfs -text
+**/cached_embeddings/** filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,30 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+.coverage
+.coverage/
+.coverage/*
+
+# Virtual environments
+.venv
+**/.env
+**/uipath.db
+**/.uipath
+**/**.nupkg
+**/__uipath/
+
+**/playground.py
+**/.idea
+
+**/docs/plugins/*
+**/docs/plugins/.*
+**/docs/langchain/*
+**/docs/llamaindex/*
+
+.cache/*
+.cache

.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

.python-version

@@ -0,0 +1 @@
+3.11

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+  "recommendations": [
+    "EditorConfig.editorconfig", // default
+    "ms-python.python", // intellisense
+    "charliermarsh.ruff" //  linting & formatting
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,14 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Python Debugger: Attach",
+      "type": "debugpy",
+      "request": "attach",
+      "connect": {
+        "host": "localhost",
+        "port": 5678
+      }
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,28 @@
+{
+  "window.title": "${rootName}${separator}${activeEditorMedium}",
+  "files.exclude": {
+    "**/*.pyc": true,
+    "**/__pycache__": true,
+    ".pytest_cache": true,
+    ".mypy_cache": true,
+    ".ruff_cache": true,
+    ".venv": true
+  },
+  // Formatting
+  "editor.formatOnSave": true,
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    }
+  },
+  "workbench.colorCustomizations": {
+    "titleBar.activeBackground": "#0099cc",
+    "titleBar.inactiveBackground": "#0099cc"
+  },
+  "python.testing.pytestArgs": [
+    "tests"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing to UiPath Runtime SDK
+
+## Local Development Setup
+
+### Prerequisites
+
+1. **Install Python ≥ 3.11**:
+    - Download and install Python 3.11 from the official [Python website](https://www.python.org/downloads/)
+    - Verify the installation by running:
+        ```sh
+        python3.11 --version
+        ```
+
+    Alternative: [mise](https://mise.jdx.dev/lang/python.html)
+
+2. **Install [uv](https://docs.astral.sh/uv/)**:
+    Follow the official installation instructions for your operating system.
+
+3. **Create a virtual environment in the current working directory**:
+    ```sh
+    uv venv
+    ```
+
+4. **Activate the virtual environment**:
+    - Linux/Mac
+    ```sh
+    source .venv/bin/activate
+    ```
+    - Windows Powershell
+    ```sh
+    .venv\Scripts\Activate.ps1
+    ```
+    - Windows Bash
+    ```sh
+    source .venv/Scripts/activate
+    ```
+
+5. **Install dependencies**:
+    ```sh
+    uv sync --all-extras --no-cache
+    ```
+
+For additional commands related to linting, formatting, and building, run `just --list`.
+
+### Using the SDK Locally
+
+1. Create a project directory:
+    ```sh
+    mkdir project
+    cd project
+    ```
+
+2. Initialize the Python project:
+    ```sh
+    uv init . --python 3.11
+    ```
+
+3. Set the SDK path:
+    ```sh
+    PATH_TO_SDK=/Users/YOUR_USERNAME/uipath-runtime-python
+    ```
+
+4. Install the SDK in editable mode:
+    ```sh
+    uv add --editable ${PATH_TO_SDK}
+    ```
+
+> **Note:** Instead of cloning the project into `.venv/lib/python3.11/site-packages/uipath-runtime`, this mode creates a file named `_uipath-runtime.pth` inside `.venv/lib/python3.11/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. To view the entries, run `python -c 'import sys; print(sys.path)'`.