uipath 2.0.0.dev3__tar.gz → 2.0.1.dev1__tar.gz

uipath-2.0.1.dev1/.cursorrules

@@ -0,0 +1,55 @@
+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.
+
+For core SDK function naming conventions:
+- Use `retrieve` when getting a single resource by key (e.g., in UserService use `retrieve` not `retrieve_user`)
+- Use `retrieve_by_[field]` when getting a resource by a field other than key
+- Use `list` for getting multiple resources (e.g., in UserService use `list` not `list_users`)
+
+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-2.0.1.dev1/.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-2.0.1.dev1/.gitattributes

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

uipath-2.0.1.dev1/.github/workflows/build.yml

@@ -0,0 +1,46 @@
+name: Reusable Build Workflow
+
+on:
+  workflow_call:
+    secrets:
+      token:
+        required: true
+
+jobs:
+  build:
+    name: Build and publish
+    runs-on: "ubuntu-24.04"
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Setup venv
+        run: |
+          uv venv
+          uv sync --all-extras
+
+      - name: Build
+        run: |
+          uv build
+
+      - name: Check if version in pyproject.toml was modified
+        id: check_version
+        run: |
+          if git diff --name-only ${{ github.sha }} ${{ github.event.before }} | grep -q 'pyproject.toml'; then
+            echo "modified=true" >> $GITHUB_OUTPUT
+          else
+            echo "modified=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: "Publish"
+        if: ${{ steps.check_version.outputs.modified }} == 'true'
+        run: |
+          uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.token }}

uipath-2.0.1.dev1/.github/workflows/cd.yml

@@ -0,0 +1,14 @@
+name: CD
+
+on:
+  workflow_run:
+    workflows: ["Core CI"]
+    types:
+      - completed
+
+jobs:
+  build:
+    if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'push' && github.event.workflow_run.head_branch == 'main' }}
+    uses: ./.github/workflows/build.yml
+    secrets:
+      token: ${{ secrets.PYPI_TOKEN }}

uipath-2.0.1.dev1/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: Core CI
+
+on:
+  workflow_dispatch: {}
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    uses: ./.github/workflows/lint.yml
+
+  test:
+    uses: ./.github/workflows/test.yml

uipath-2.0.1.dev1/.github/workflows/commitlint.yml

@@ -0,0 +1,12 @@
+name: Commit Lint
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  commit-lint:
+    uses: UiPath/.github/.github/workflows/commit-lint.yml@master
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

uipath-2.0.1.dev1/.github/workflows/lint.yml

@@ -0,0 +1,44 @@
+name: Reusable Lint Workflow
+
+on:
+  workflow_call:
+    inputs:
+      should_skip:
+        description: 'Whether to skip the linting step'
+        required: false
+        type: boolean
+        default: false
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: "ubuntu-24.04"
+    if: inputs.should_skip == false
+
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Setup venv
+        run: |
+          uv venv
+          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-2.0.1.dev1/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Reusable Test Workflow
+
+on:
+  workflow_call:
+    inputs:
+      should_skip:
+          description: 'Whether to skip the linting step'
+          required: false
+          type: boolean
+          default: false
+
+jobs:
+  test:
+    name: Test
+    runs-on: "ubuntu-24.04"
+    if: inputs.should_skip == false
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: "Setup venv"
+        run: |
+          uv venv
+          uv sync --all-extras
+
+      - name: "Run tests"
+        run: |
+          uv run pytest
+        env:
+          UIPATH_URL: ${{ secrets.UIPATH_URL }}
+          UIPATH_CLIENT_ID: ${{ secrets.UIPATH_CLIENT_ID }}
+          UIPATH_CLIENT_SECRET: ${{ secrets.UIPATH_CLIENT_SECRET }}
+          UIPATH_ORGANIZATION_ID: ${{ vars.UIPATH_ORGANIZATION_ID }}
+          UIPATH_TENANT_ID: ${{ vars.UIPATH_TENANT_ID }}
+

uipath-2.0.1.dev1/.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-2.0.1.dev1/.python-version

@@ -0,0 +1 @@
+3.10

uipath-2.0.1.dev1/.vscode/extensions.json

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

uipath-2.0.1.dev1/.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": [
+    "sdk"
+  ],
+  "python.testing.unittestEnabled": false,
+  "python.testing.pytestEnabled": true
+}

uipath-2.0.1.dev1/CONTRIBUTING.md

@@ -0,0 +1,69 @@
+# 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.9`
+3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/uipath-python`
+4. Install the sdk in editable mode `uv  add --editable ${PATH_TO_SDK}`
+
+:information_source: Instead of cloning the project into `.venv/lib/python3.9/site-packages/uipath`, this mode creates a file named `_uipath.pth` inside `.venv/lib/python3.9/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.)
+
+## API Style Guide
+
+### General Rule:
+- use key instead of ID
+
+### Standard Methods & Naming Conventions
+
+#### Retrieve a Single Resource
+- **Method Name:** `retrieve` instead of get
+- **Usage:** To obtain a specific resource instance using its unique identifier (using *key* instead of ID).
+- **Extended:**
+  - `retrieve_by_[field_name]` (for fields other than key)
+
+#### List Multiple Resources
+- **Method Name:** `list`
+- **Usage:** To fetch a collection of resources, optionally filtered by query parameters.
+- **Example:**
+  ```python
+  resources = Resource.list(filters={})
+  ```
+
+#### Create a Resource
+- **Method Name:** `create`
+- **Usage:** To add a new resource to the system.
+
+#### Update a Resource
+- **Method Name:** `update`
+- **Usage:** To modify an existing resource.

{uipath-2.0.0.dev3 → uipath-2.0.1.dev1}/PKG-INFO

@@ -1,18 +1,17 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.0.dev3
+Version: 2.0.1.dev1
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python
 Maintainer-email: Marius Cosareanu <marius.cosareanu@uipath.com>, Cristian Pufu <cristian.pufu@uipath.com>
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Build Tools
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: click>=8.1.8
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pydantic>=2.11.1

uipath-2.0.1.dev1/docs/assets/uipath-logo.svg

@@ -0,0 +1,11 @@
+<svg width="94" height="32" viewBox="0 0 94 32" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_4793_1278)">
+<path d="M0 0H32V32H0V0ZM28.6848 28.6848V3.3152H3.3152V28.6912H28.6912L28.6848 28.6848ZM6.1952 8.256V17.952C6.1952 22.3872 8.6272 24.9792 12.7424 24.9792C16.8576 24.9792 19.4176 22.336 19.4176 17.952V8.256H16.1024V17.952C16.1024 20.4608 15.0336 21.8496 12.8192 21.8496C10.6048 21.8496 9.504 20.3776 9.504 17.952V8.256H6.1888H6.1952ZM23.6928 10.2336C24.8704 10.2336 25.7216 9.4336 25.7216 8.256C25.7216 7.0784 24.864 6.2272 23.6928 6.2272C22.5216 6.2272 21.664 7.0528 21.664 8.256C21.664 9.4592 22.5216 10.2336 23.6928 10.2336ZM22.0352 11.808V24.8192H25.3504V11.808H22.0352ZM41.8304 19.4752C45.4336 19.4752 47.7888 17.3632 47.7888 13.8112C47.7888 10.2592 45.4912 8.256 41.8304 8.256H35.5264V24.8192H38.8416V19.4752H41.8304ZM41.4848 16.832H38.8416V10.9312H41.4848C43.3792 10.9312 44.4224 12 44.4224 13.8176C44.4224 15.7696 43.3792 16.8384 41.4848 16.8384V16.832ZM48.9088 18.3296C48.9088 22.2016 51.392 24.9792 54.9184 24.9792C57.0048 24.9792 58.3616 24.2304 59.136 22.976V24.8192H62.4512V11.808H59.136V13.8368C58.336 12.4992 56.9472 11.648 54.9184 11.648C51.3408 11.648 48.9088 14.4768 48.9088 18.3232V18.3296ZM59.136 18.3296C59.136 20.6016 57.7216 22.0672 55.6928 22.0672C53.4464 22.0672 52.2752 20.4928 52.2752 18.3296C52.2752 16.0064 53.5872 14.5344 55.6928 14.5344C57.7984 14.5344 59.136 16.0832 59.136 18.3296ZM70.8096 21.9904C69.5296 21.9904 69.1776 21.4272 69.1776 20.2816V14.6176H72.0896V11.8144H69.1776V8.2624H65.8624V11.8144H64.3136V14.6176H65.8624V20.256C65.8624 23.328 67.2256 24.8256 70.3744 24.8256H72.1088V21.9968H70.7968L70.8096 21.9904ZM77.2736 13.632V7.4624H73.9584V24.8256H77.2736V17.9328C77.2736 15.7184 78.4512 14.3808 80.3968 14.3808C82.3424 14.3808 83.36 15.6608 83.36 17.6384V24.8256H86.6752V17.2672C86.6752 13.8496 84.2688 11.6288 81.1968 11.6288C79.2192 11.6288 78.016 12.3776 77.2672 13.632H77.2736Z" fill="#FA4616"/>
+<path d="M89.8495 12.8316C87.8015 12.8316 86.3999 11.4044 86.3999 9.41403C86.3999 7.42363 87.8463 6.01562 89.8495 6.01562C91.8527 6.01562 93.2799 7.38523 93.2799 9.41403C93.2799 11.4428 91.8719 12.8316 89.8495 12.8316ZM89.8495 6.61723C88.1343 6.61723 87.0463 7.69243 87.0463 9.40763C87.0463 11.1228 88.1919 12.1788 89.8495 12.1788C91.5071 12.1788 92.6399 11.0652 92.6399 9.40763C92.6399 7.75003 91.5519 6.61723 89.8495 6.61723ZM90.6303 9.94523L91.3535 11.2956H90.4959L89.8111 10.054H89.2671V11.2956H88.4927V7.44923H89.9711C90.8095 7.44923 91.4303 7.94203 91.4303 8.73563C91.4303 9.32443 91.1167 9.74683 90.6303 9.94523ZM89.2671 9.43963H89.8751C90.3231 9.43963 90.6303 9.19003 90.6303 8.73563C90.6303 8.31963 90.3231 8.07003 89.8751 8.07003H89.2671V9.43963Z" fill="#FA4616"/>
+</g>
+<defs>
+<clipPath id="clip0_4793_1278">
+<rect width="93.28" height="32" fill="white"/>
+</clipPath>
+</defs>
+</svg>

uipath-2.0.1.dev1/docs/assets.md

@@ -0,0 +1 @@
+::: uipath._services.assets_service

uipath-2.0.1.dev1/docs/buckets.md

@@ -0,0 +1 @@
+::: uipath._services.buckets_service

uipath-2.0.1.dev1/docs/connections.md

@@ -0,0 +1 @@
+::: uipath._services.connections_service

uipath-2.0.1.dev1/docs/context_grounding.md

@@ -0,0 +1 @@
+::: uipath._services.context_grounding_service

uipath-2.0.1.dev1/docs/index.md

@@ -0,0 +1,3 @@
+# Welcome to UiPath SDK
+
+::: uipath

uipath-2.0.1.dev1/docs/jobs.md

@@ -0,0 +1 @@
+::: uipath._services.jobs_service

uipath-2.0.1.dev1/docs/processes.md

@@ -0,0 +1 @@
+::: uipath._services.processes_service

uipath-2.0.1.dev1/docs/queues.md

@@ -0,0 +1 @@
+::: uipath._services.queues_service

uipath-2.0.1.dev1/justfile

@@ -0,0 +1,15 @@
+set quiet
+
+default: lint format
+
+lint:
+    ruff check .
+
+format:
+    ruff format --check .
+
+build:
+    uv build
+
+install:
+    uv sync --all-extras

uipath-2.0.1.dev1/mkdocs.yml

@@ -0,0 +1,61 @@
+site_name: UiPath SDK
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: custom
+      accent: custom
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: custom
+      accent: custom
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - content.code.annotate
+    - content.code.copy
+    - content.footnote.tooltips
+    - content.tabs.link
+    - content.tooltips
+    - navigation.footer
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+  logo: assets/uipath-logo.svg
+
+nav:
+  - Home: index.md
+  - Assets: assets.md
+  - Buckets: buckets.md
+  - Connections: connections.md
+  - Context Grounding: context_grounding.md
+  - Jobs: jobs.md
+  - Queues: queues.md
+  - Processes: processes.md
+
+plugins:
+  - search
+  - mkdocstrings
+
+markdown_extensions:
+  - attr_list
+  - md_in_html
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.tabbed:
+      alternate_style: true

{uipath-2.0.0.dev3 → uipath-2.0.1.dev1}/pyproject.toml

@@ -1,9 +1,9 @@
 [project]
 name = "uipath"
-version = "2.0.0.dev3"
+version = "2.0.1.dev1"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 dependencies = [
   "click>=8.1.8",
   "httpx>=0.28.1",
@@ -19,7 +19,6 @@ classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
   "Topic :: Software Development :: Build Tools",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
@@ -40,12 +39,6 @@ uipath = "uipath._cli:cli"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
-[tool.hatch.build.targets.wheel]
-packages = ["src/uipath"]
-
-[tool.hatch.build.targets.sdist]
-packages = ["src/uipath"]
-
 [dependency-groups]
 dev = [
   "bandit>=1.8.2",

{uipath-2.0.0.dev3 → uipath-2.0.1.dev1/src}/uipath/_cli/middlewares.py

@@ -86,7 +86,7 @@ class Middlewares:
                 else:
                     middlewares = list(entry_points.get("uipath.middlewares", []))
             except Exception:
-                middlewares = list(importlib.metadata.entry_points())
+                middlewares = list(importlib.metadata.entry_points())  # type: ignore
                 middlewares = [
                     ep for ep in middlewares if ep.group == "uipath.middlewares"
                 ]

{uipath-2.0.0.dev3 → uipath-2.0.1.dev1/src}/uipath/_services/buckets_service.py

@@ -45,7 +45,7 @@ class BucketsService(FolderContext, BaseService):
         headers = {
             key: value
             for key, value in zip(
-                result["Headers"]["Keys"], result["Headers"]["Values"]
+                result["Headers"]["Keys"], result["Headers"]["Values"], strict=False
             )
         }
 
@@ -98,7 +98,7 @@ class BucketsService(FolderContext, BaseService):
         headers = {
             key: value
             for key, value in zip(
-                result["Headers"]["Keys"], result["Headers"]["Values"]
+                result["Headers"]["Keys"], result["Headers"]["Values"], strict=False
             )
         }
 
@@ -149,7 +149,7 @@ class BucketsService(FolderContext, BaseService):
         headers = {
             key: value
             for key, value in zip(
-                result["Headers"]["Keys"], result["Headers"]["Values"]
+                result["Headers"]["Keys"], result["Headers"]["Values"], strict=False
             )
         }
 

uipath-2.0.1.dev1/tests/__init__.py

@@ -0,0 +1,4 @@
+"""
+Test suite for UiPath SDK.
+Contains test cases for all CLI commands and utilities.
+"""