uipath-dev 0.0.1__tar.gz

uipath_dev-0.0.1/.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

uipath_dev-0.0.1/.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

uipath_dev-0.0.1/.gitattributes

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

uipath_dev-0.0.1/.github/workflows/cd.yml

@@ -0,0 +1,76 @@
+name: CD
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - pyproject.toml
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+
+  test:
+    uses: ./.github/workflows/test.yml
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    needs:
+      - lint
+      - test
+
+    if: ${{ github.repository == 'UiPath/uipath-dev-python' }}
+    permissions:
+      contents: read
+      actions: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Build
+        run: uv build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+
+    needs:
+      - build
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

uipath_dev-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - pyproject.toml
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  commit-lint:
+    if: ${{ github.event_name == 'pull_request' }}
+    uses: ./.github/workflows/commitlint.yml
+
+  lint:
+    uses: ./.github/workflows/lint.yml
+
+  test:
+    uses: ./.github/workflows/test.yml

uipath_dev-0.0.1/.github/workflows/commitlint.yml

@@ -0,0 +1,47 @@
+name: Commit Lint
+
+on:
+  workflow_call
+
+jobs:
+  commitlint:
+    name: Commit Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 22
+
+      - name: Install Git
+        run: |
+          if ! command -v git &> /dev/null; then
+              echo "Git is not installed. Installing..."
+              sudo apt-get update
+              sudo apt-get install -y git
+          else
+              echo "Git is already installed."
+          fi
+
+      - name: Install commitlint
+        run: |
+          npm install conventional-changelog-conventionalcommits
+          npm install commitlint@latest
+          npm install @commitlint/config-conventional
+
+      - name: Configure
+        run: |
+          echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
+
+      - name: Validate PR commits with commitlint
+        run: |
+          git fetch origin pull/${{ github.event.pull_request.number }}/head:pr_branch
+          npx commitlint --from ${{ github.event.pull_request.base.sha }} --to pr_branch --verbose

uipath_dev-0.0.1/.github/workflows/lint.yml

@@ -0,0 +1,39 @@
+name: Lint
+
+on:
+  workflow_call
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Check static types
+        run: uv run mypy --config-file pyproject.toml .
+
+      - name: Check linting
+        run: uv run ruff check .
+
+      - name: Check formatting
+        run: uv run ruff format --check .
+
+

uipath_dev-0.0.1/.github/workflows/publish-dev.yml

@@ -0,0 +1,129 @@
+name: Publish Dev Build
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+
+jobs:
+  publish-dev:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+
+    # Only run if PR has the build:dev label
+    if: contains(github.event.pull_request.labels.*.name, 'build:dev')
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Set development version
+        shell: pwsh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          $pyprojcontent = Get-Content pyproject.toml -Raw
+
+          $PROJECT_NAME    = ($pyprojcontent | Select-String -Pattern '(?m)^\[(project|tool\.poetry)\][^\[]*?name\s*=\s*"([^"]*)"' -AllMatches).Matches[0].Groups[2].Value
+          $CURRENT_VERSION = ($pyprojcontent | Select-String -Pattern '(?m)^\[(project|tool\.poetry)\][^\[]*?version\s*=\s*"([^"]*)"' -AllMatches).Matches[0].Groups[2].Value
+
+
+          # Get PR number and run number with proper padding
+          $PR_NUM = [int]"${{ github.event.pull_request.number }}"
+          $PADDED_PR  = "{0:D5}" -f [int]"${{ github.event.pull_request.number }}"
+          $PADDED_RUN = "{0:D4}" -f [int]"${{ github.run_number }}"
+          $PADDED_NEXT_PR = "{0:D5}" -f ($PR_NUM + 1)
+
+          # Create version range strings for PR
+          $MIN_VERSION = "$CURRENT_VERSION.dev1$PADDED_PR" + "0000"
+          $MAX_VERSION = "$CURRENT_VERSION.dev1$PADDED_NEXT_PR" + "0000"
+
+          # Create unique dev version with PR number and run ID
+          $DEV_VERSION = "$CURRENT_VERSION.dev1$PADDED_PR$PADDED_RUN"
+
+          # Update version in pyproject.toml
+          (Get-Content pyproject.toml) -replace "version = `"$CURRENT_VERSION`"", "version = `"$DEV_VERSION`"" | Set-Content pyproject.toml
+
+          Write-Output "Package version set to $DEV_VERSION"
+
+          $dependencyMessage = @"
+          ## Development Package
+
+          - Add this package as a dependency in your pyproject.toml:
+
+          ``````toml
+          [project]
+          dependencies = [
+            # Exact version:
+            "$PROJECT_NAME==$DEV_VERSION",
+
+            # Any version from PR
+            "$PROJECT_NAME>=$MIN_VERSION,<$MAX_VERSION"
+          ]
+
+          [[tool.uv.index]]
+          name = "testpypi"
+          url = "https://test.pypi.org/simple/"
+          publish-url = "https://test.pypi.org/legacy/"
+          explicit = true
+
+          [tool.uv.sources]
+          $PROJECT_NAME = { index = "testpypi" }
+          ``````
+          "@
+
+          # Get the owner and repo from the GitHub repository
+          $owner = "${{ github.repository_owner }}"
+          $repo = "${{ github.repository }}".Split('/')[1]
+          $prNumber = $PR_NUM
+
+          # Get the current PR description
+          $prUri = "https://api.github.com/repos/$owner/$repo/pulls/$prNumber"
+          $headers = @{
+            Authorization = "token $env:GITHUB_TOKEN"
+            Accept = "application/vnd.github.v3+json"
+          }
+
+          $pr = Invoke-RestMethod -Uri $prUri -Method Get -Headers $headers
+          $currentBody = $pr.body
+
+          # Check if there's already a development package section
+          if ($currentBody -match '## Development Package') {
+            # Replace the existing section with the new dependency message
+            $newBody = $currentBody -replace '## Development Package(\r?\n|.)*?(?=##|$)', $dependencyMessage
+          } else {
+            # Append the dependency message to the end of the description
+            $newBody = if ($currentBody) { "$currentBody`n`n$dependencyMessage" } else { $dependencyMessage }
+          }
+
+          # Update the PR description
+          $updateBody = @{
+            body = $newBody
+          } | ConvertTo-Json
+
+          Invoke-RestMethod -Uri $prUri -Method Patch -Headers $headers -Body $updateBody -ContentType "application/json"
+
+          Write-Output "Updated PR description with development package information"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish
+        run: uv publish --index testpypi
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.TESTPYPI_TOKEN }}
+

uipath_dev-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,37 @@
+name: Test
+
+on:
+  workflow_call
+
+jobs:
+  test:
+    name: Test
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+        os: [ubuntu-latest, windows-latest]
+
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras
+
+      - name: Run tests
+        run: uv run pytest
+
+    continue-on-error: true
+

uipath_dev-0.0.1/.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

uipath_dev-0.0.1/.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

uipath_dev-0.0.1/.python-version

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

uipath_dev-0.0.1/.vscode/extensions.json

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

uipath_dev-0.0.1/.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
+      }
+    }
+  ]
+}

uipath_dev-0.0.1/.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
+}

uipath_dev-0.0.1/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-dev-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-dev`, this mode creates a file named `_uipath-dev.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)'`.

uipath_dev-0.0.1/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2025 UiPath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

uipath_dev-0.0.1/PKG-INFO

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: uipath-dev
+Version: 0.0.1
+Summary: UiPath Dev Terminal
+Project-URL: Homepage, https://uipath.com
+Project-URL: Repository, https://github.com/UiPath/uipath-dev-python
+Project-URL: Documentation, https://uipath.github.io/uipath-python/
+Maintainer-email: Cristian Pufu <cristian.pufu@uipath.com>
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.11
+Requires-Dist: pyperclip>=1.11.0
+Requires-Dist: textual>=6.5.0
+Requires-Dist: uipath-runtime>=0.0.4
+Description-Content-Type: text/markdown
+
+# UiPath Developer Console
+
+The **UiPath Developer Console** is an interactive terminal application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts.
+
+## Overview
+
+The Developer Console provides a local environment for developers who are building or experimenting with Python-based UiPath runtimes.
+It integrates with the [`uipath-runtime`](https://pypi.org/project/uipath-runtime/) SDK to execute agents and visualize their behavior in real time using the [`textual`](https://github.com/Textualize/textual) framework.
+
+This tool is designed for:
+- Developers building **UiPath agents** or **custom runtime integrations**
+- Python engineers testing **standalone automation scripts** before deployment
+- Contributors exploring **runtime orchestration** and **execution traces**
+
+## Features
+
+- Run and inspect Python runtimes interactively
+- View structured logs, output, and OpenTelemetry traces
+- Export and review execution history
+
+## Installation
+
+```bash
+uv add uipath-dev
+```
+
+## Development
+
+Launch the Developer Console with mocked data:
+
+```bash
+uv run uipath-dev
+```
+
+To run tests:
+
+```bash
+pytest
+```