uipath 2.0.53__tar.gz → 2.0.55__tar.gz

{uipath-2.0.53 → uipath-2.0.55}/.github/workflows/test.yml

@@ -24,11 +24,19 @@ jobs:
 
       - name: Run tests
         run: |
-          uv run pytest
+          uv run pytest --cov-report xml:./coverage/coverage.xml
         env:
           UIPATH_URL: ${{ secrets.UIPATH_URL }}
+          UIPATH_BASE_URL: ${{ secrets.UIPATH_BASE_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 }}
 
+      - name: Get Cover
+        uses: orgoro/coverage@v3.2
+        with:
+          coverageFile: ./coverage/coverage.xml
+          token: ${{ secrets.GITHUB_TOKEN }}
+        if: ${{ github.event_name == 'pull_request_target' }}
+

{uipath-2.0.53 → uipath-2.0.55}/.gitignore

@@ -6,6 +6,10 @@ dist/
 wheels/
 *.egg-info
 
+.coverage
+.coverage/
+.coverage/*
+
 # Virtual environments
 .venv
 **/.env

{uipath-2.0.53 → uipath-2.0.55}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.53
+Version: 2.0.55
 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

uipath-2.0.55/docs/FAQ.md

@@ -0,0 +1,77 @@
+# Frequently Asked Questions (FAQ)
+
+### Q: Why am I getting a "Failed to prepare environment" error when deploying my python agent to UiPath Cloud Platform?
+
+#### Error Message
+
+```json
+{
+    "Code": "Serverless.PythonCodedAgent.PrepareEnvironmentError",
+    "Title": "Failed to prepare environment",
+    "Detail": "An error occurred while installing the package dependencies. Please try again. If the error persists, please contact support.",
+    "Category": "System",
+    "Status": null
+}
+```
+
+#### Visual Example
+
+<picture data-light="../assets/env-preparation-failed-light.png" data-dark="../assets/env-preparation-failed-dark.png">
+  <source
+    media="(prefers-color-scheme: dark)"
+    srcset="../assets/env-preparation-failed-dark.png"
+  />
+  <img
+    src="../assets/env-preparation-failed-light.png"
+  />
+</picture>
+
+*Example of the error as it appears in UiPath Cloud Platform*
+
+#### Description
+
+This error might occur when deploying coded-agents to UiPath Cloud Platform, even though the same project might work correctly in your local environment. The issue is often related to how Python packages are discovered and distributed during the cloud deployment process.
+
+#### Common Causes
+
+1. Multiple top-level packages or modules in your project structure
+2. Improper configuration or formatting in the pyproject.toml or requirements.txt files
+
+#### Solution
+
+##### 1. Check Your Project Structure
+
+- Ensure your Python files are organized under a non top-level directory (e.g., using the `src` layout)
+- Follow the recommended project structure:
+
+  ```plaintext
+  project_root/
+  ├── src/
+  │   └── your_package/
+  │       ├── __init__.py
+  │       └── your_modules.py
+  ├── pyproject.toml
+  └── setup.cfg/setup.py
+  ```
+
+##### 2. Configure Package Discovery
+
+If you need to maintain your current project structure, you can configure custom package discovery in your `pyproject.toml`:
+
+```toml
+[tool.setuptools]
+py-modules = []
+packages = ["your_package"]
+```
+
+##### 3. Verify Dependencies
+
+- Ensure all required dependencies are properly listed in your `requirements.txt` or `pyproject.toml`
+
+#### Reference
+
+For more detailed information about package discovery and configuration, refer to the [official setuptools documentation](https://setuptools.pypa.io/en/latest/userguide/package_discovery.html).
+
+---
+
+*Note: This FAQ will be updated as new information becomes available. If you continue experiencing issues after following these solutions, please contact UiPath support.*

uipath-2.0.55/docs/core/attachments.md

@@ -0,0 +1,86 @@
+# Attachments Service
+
+The `AttachmentsService` provides methods to upload, download, and delete attachments in UiPath Orchestrator. Attachments are files that can be associated with jobs, processes, or other entities, and are managed via the Orchestrator API.
+
+> **Reference:** [UiPath Orchestrator Attachments API](https://docs.uipath.com/orchestrator/reference/api-attachments)
+
+## Features
+- Upload files or in-memory content as attachments
+- Download attachments to local files
+- Delete attachments
+- Both synchronous and asynchronous methods
+
+## Usage
+
+### Instantiating the Service
+
+The `AttachmentsService` is available as a property on the main `UiPath` client:
+
+```python
+from uipath import UiPath
+
+client = UiPath()
+attachments = client.attachments
+```
+
+### Uploading an Attachment
+
+You can upload a file from disk or from memory:
+
+```python
+# Upload from file
+attachment_key = client.attachments.upload(
+    name="document.pdf",
+    source_path="/path/to/document.pdf",
+)
+
+# Upload from memory
+attachment_key = client.attachments.upload(
+    name="notes.txt",
+    content="Some text content",
+)
+```
+
+#### Async Example
+```python
+attachment_key = await client.attachments.upload_async(
+    name="notes.txt",
+    content="Some text content",
+)
+```
+
+### Downloading an Attachment
+
+```python
+attachment_name = client.attachments.download(
+    key=attachment_key,
+    destination_path="/path/to/save/document.pdf",
+)
+```
+
+#### Async Example
+```python
+attachment_name = await client.attachments.download_async(
+    key=attachment_key,
+    destination_path="/path/to/save/document.pdf",
+)
+```
+
+### Deleting an Attachment
+
+```python
+client.attachments.delete(key=attachment_key)
+```
+
+#### Async Example
+```python
+await client.attachments.delete_async(key=attachment_key)
+```
+
+## Error Handling
+
+All methods raise exceptions on failure. See the SDK error handling documentation for details.
+
+## See Also
+- [UiPath Orchestrator Attachments API](https://docs.uipath.com/orchestrator/reference/api-attachments)
+- [Jobs Service](./jobs.md) for listing attachments associated with jobs. 

uipath-2.0.55/docs/core/environment_variables.md

@@ -0,0 +1,115 @@
+# Environment Variables
+
+Environment variables are configuration values stored at the operating system level that can be accessed by applications and scripts. They provide a flexible way to configure application behavior without hardcoding values in your source code.
+
+Environment variables are loaded in the following order (highest to lowest priority):
+
+1. `.env` file in the current directory
+2. System environment variables
+3. Default values in code
+
+Example:
+```bash
+# .env file
+UIPATH_FOLDER_PATH=/default/path
+
+# System environment
+export UIPATH_FOLDER_PATH=/system/path
+```
+/// warning
+When deploying your agent to production, ensure that all required environment variables (such as API keys and custom configurations) are properly configured in your process settings. This step is crucial for the successful operation of your published package.
+///
+
+## Design
+
+Create a `.env` file in your project's root directory to manage environment variables locally. When using the `uipath auth` or `uipath new my-agent` commands, this file is automatically created.
+
+The `uipath auth` command automatically populates this file with essential variables:
+
+- `UIPATH_URL`: Your UiPath Orchestrator instance URL
+- `UIPATH_ACCESS_TOKEN`: Authentication token for API access
+
+### Folder Configuration
+Most UiPath services operate within a specific folder context. Configure your folder context using either:
+
+- `UIPATH_FOLDER_PATH`: The full path to your target folder
+- `UIPATH_FOLDER_KEY`: The unique identifier for your target folder
+
+To obtain the folder path, right-click on the folder in UiPath Orchestrator and select "Copy folder path" from the context menu.
+
+<picture data-light="../assets/copy_path_light.png" data-dark="../assets/copy_path_dark.png">
+  <source
+    media="(prefers-color-scheme: dark)"
+    srcset="
+      ../assets/copy_path_dark.png
+    "
+  />
+  <img
+    src="../assets/copy_path_light.png"
+  />
+</picture>
+
+### Telemetry
+To help us improve the developer experience, the CLI collects basic usage data about command invocations. For more details about UiPath's privacy practices, please review the [privacy statement](https://www.uipath.com/legal/privacy-policy).
+
+Telemetry is enabled by default. You can opt out by setting the `UIPATH_TELEMETRY_ENABLED` environment variable to `false` in your `.env` file:
+
+```bash
+UIPATH_TELEMETRY_ENABLED=false
+```
+
+## Runtime
+
+When executing processes or starting jobs, you can configure environment variables through the UiPath Orchestrator interface. For sensitive information like API keys and secrets, we strongly recommend using secret assets instead of environment variables. Secret assets provide enhanced security and better management capabilities.
+
+### Secret Assets
+To use a secret asset in your environment variables, reference it using the following format:
+
+```bash
+NAME=%ASSETS/your-secret-asset-name%
+```
+
+<picture data-light="../assets/cloud_env_var_light.gif" data-dark="../assets/cloud_env_var_dark.gif">
+  <source
+    media="(prefers-color-scheme: dark)"
+    srcset="
+      ../assets/cloud_env_var_dark.gif
+    "
+  />
+  <img
+    src="../assets/cloud_env_var_light.gif"
+  />
+</picture>
+
+### Sensitive Variables
+If you must use environment variables for sensitive information (not recommended), variables containing `API_KEY` or `SECRET` in their names will have their values masked as `****` in the interface for security purposes.
+
+<picture data-light="../assets/cloud_env_var_secret_light.png" data-dark="../assets/cloud_env_var_secret_dark.png">
+  <source
+    media="(prefers-color-scheme: dark)"
+    srcset="
+      ../assets/cloud_env_var_secret_dark.png
+    "
+  />
+  <img
+    src="../assets/cloud_env_var_secret_light.png"
+  />
+</picture>
+
+### Log Level
+The `LOG_LEVEL` environment variable controls the verbosity of logging in the Orchestrator UI's Log tab during runtime execution. This setting determines which log messages are displayed in the interface.
+
+| Level | Description |
+|-------|-------------|
+| TRACE | Most detailed logging level, shows all possible information |
+| DEBUG | Detailed information for debugging purposes |
+| INFORMATION | General operational information |
+| WARNING | Warning messages for potentially harmful situations |
+| ERROR | Error events that might still allow the application to continue |
+| CRITICAL | Critical events that may lead to application failure |
+| NONE | No logging |
+
+The default value is `INFORMATION`
+
+### Builtin Variables
+The runtime environment automatically includes certain variables (such as `UIPATH_FOLDER_KEY`, `UIPATH_ROBOT_KEY`), eliminating the need for manual configuration.

uipath-2.0.55/docs/core/traced.md

@@ -0,0 +1,121 @@
+# Tracing
+
+The `traced()` decorator enables automatic tracing of function calls, inputs, and outputs. It is designed to help you monitor, debug, and audit your code by capturing detailed information about function executions, including arguments, return values, and exceptions.
+
+You can view the traces of an Orchestrator job by going to the Jobs page, click a job, a side panel will open, and they will be available under the `Trace` tab. These can also be seen in UiPath Maestro when your agent is part of a larger process orchestration.
+
+## Usage
+
+Apply the `@traced()` decorator to any function (sync, async, generator, or async generator) to automatically record its execution as a trace span.
+
+```python hl_lines="3 7"
+from uipath.tracing._traced import traced
+
+@traced()
+def my_function(x, y):
+    return x + y
+
+@traced(name="custom_span", run_type="my_type")
+async def my_async_function(a, b):
+    return a * b
+```
+
+## Parameters
+
+| Parameter         | Type                                | Description                                                                                       |
+|------------------|-------------------------------------|---------------------------------------------------------------------------------------------------|
+| name             | Optional[str]                       | Custom name for the trace span. Defaults to the function name.                                    |
+| run_type         | Optional[str]                       | Category for the run (e.g., "uipath"). Useful for filtering traces.                              |
+| span_type        | Optional[str]                       | Custom type for the span. Defaults to function type (sync/async/generator).                       |
+| input_processor  | Optional[Callable[[dict], dict]]    | Function to process/transform inputs before recording. Receives a dict of arguments.              |
+| output_processor | Optional[Callable[[Any], Any]]      | Function to process/transform outputs before recording. Receives the function's return value.      |
+| hide_input       | bool                                | If True, input data is redacted in the trace for privacy/security.                                |
+| hide_output      | bool                                | If True, output data is redacted in the trace for privacy/security.                               |
+
+## Input and Output Processors
+
+Processors allow you to mask, redact, or transform sensitive data before it is recorded in the trace. For example:
+
+```python hl_lines="13"
+def mask_inputs(inputs):
+    inputs = inputs.copy()
+    if 'password' in inputs:
+        inputs['password'] = '***REDACTED***'
+    return inputs
+
+def anonymize_output(output):
+    if isinstance(output, dict) and 'email' in output:
+        output = output.copy()
+        output['email'] = 'anonymous@example.com'
+    return output
+
+@traced(input_processor=mask_inputs, output_processor=anonymize_output)
+def login(user, password):
+    # ...
+    return {"email": user + "@example.com"}
+```
+
+## Privacy Controls
+
+- Set `hide_input=True` to prevent input data from being logged.
+- Set `hide_output=True` to prevent output data from being logged.
+
+```python hl_lines="1"
+@traced(hide_input=True, hide_output=True)
+def sensitive_operation(secret):
+    ...
+```
+
+## Supported Function Types
+
+- Regular functions (sync/async)
+- Generator functions (sync/async)
+
+## Example with plain python agents
+
+When used with plain python agents please call `wait_for_tracers()` at the end of the script to ensure all traces are sent, if this is not called the agent could end without sending all the traces.
+
+```python hl_lines="3 8"
+
+from uipath.tracing import traced, wait_for_tracers
+
+@traced(name="process_payment", run_type="payment", hide_input=True)
+def process_payment(card_number, amount):
+    # Sensitive input will not be logged
+    return {"status": "success", "amount": amount}
+
+@traced()
+def main():
+    process_payment()
+
+def main_wait_traces():
+    try:
+        main()
+    finally:
+        # this needs to be called after the last `traced` function is done
+        # to ensure the trace associated with main is saved
+        wait_for_tracers()
+
+if __name__ == "__main__":
+    main_wait_traces()
+```
+
+
+## Example with langchain agents
+
+When using `uipath-langchain` there is no need to call wait_for_tracers our framework will ensure that is called.
+
+```python hl_lines="1"
+@traced()
+def my_custom_traced_function(input: str) -> str:
+    return { "x": "some-output" }
+```
+
+You can also use `@traceable()` attribute from langchain, but we recommend using `@traced()` attribute instead.
+
+```python hl_lines="1"
+@traceable()
+# @traced()  ---> do not use both at the same time or it will duplicate spans.
+def my_custom_traced_function(input: str) -> str:
+    return { "x": "some-output" }
+```

uipath-2.0.55/docs/overrides/partials/actions.html

@@ -0,0 +1,6 @@
+{% set title = ("[" + (page.title or config.site_name) + "] Your title here") | urlencode %}
+{% set body = ("Page link:: " + config.site_url + page.url + "\n\n ## My Issue/Suggestion") | urlencode %}
+<a href="https://github.com/UiPath/uipath-python/issues/new?title={{ title }}&body={{ body }}"
+    class="md-content__button skip-link-icon report-issue-link">
+    Report an issue
+</a>

{uipath-2.0.53 → uipath-2.0.55}/docs/stylesheets/extra.css

@@ -18,6 +18,10 @@
         color: #182027 !important;
     }
 
+    .report-issue-link {
+        color: #182027 !important;
+    }
+
     .md-nav__item--section {
         &:after {
             background-color: #182027 !important;
@@ -51,6 +55,10 @@
         color: #ffffff !important;
     }
 
+    .report-issue-link {
+        color: #ffffff !important;
+    }
+
     .md-nav__item--section {
         &:after {
             background-color: #ffffff !important;
@@ -77,7 +85,7 @@
     opacity: 1 !important;
 }
 
-a[href^="https://"]:not(.md-source) {
+a[href^="https://"]:not(.md-source):not(.skip-link-icon) {
     &::after {
         content: "↗";
         font-size: 1em;
@@ -139,4 +147,9 @@ a[href^="https://"]:not(.md-source) {
             width: 25%;
         }
     }
+}
+
+.report-issue-link {
+    text-decoration: underline;
+    text-decoration-style: wavy;
 }

{uipath-2.0.53 → uipath-2.0.55}/mkdocs.yml

@@ -59,7 +59,9 @@ nav:
       - Sample Agents: https://github.com/UiPath/uipath-langchain-python/tree/main/samples
   - UiPath SDK:
       - Getting Started: core/getting_started.md
+      - Environment Variables: core/environment_variables.md
       - CLI Reference: cli/index.md
+      - Tracing: core/traced.md
       - Services:
         - Actions: core/actions.md
         - Assets: core/assets.md
@@ -70,6 +72,7 @@ nav:
         - Queues: core/queues.md
         - Processes: core/processes.md
   - How To Contribute: CONTRIBUTING.md
+  - FAQ: FAQ.md
   - Release Policy: release_policy.md
 
 plugins:
@@ -134,4 +137,4 @@ markdown_extensions:
       alternate_style: true
   - toc:
       title: On this page
-      permalink: true
+      permalink: true

{uipath-2.0.53 → uipath-2.0.55}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.53"
+version = "2.0.55"
 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.10"
@@ -59,6 +59,11 @@ dev = [
   "mkdocs-click>=0.9.0",
   "pytest-asyncio>=0.26.0",
   "mkdocs-open-in-new-tab>=1.0.8",
+  "toml>=0.10.2",
+  "inflection>=0.5.1",
+  "pytest-httpx>=0.35.0",
+  "pytest-trio>=0.8.0",
+  "types-toml>=0.10.8",
 ]
 
 [project.optional-dependencies]
@@ -115,5 +120,11 @@ warn_required_dynamic_aliases = true
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 python_files = "test_*.py"
-addopts = "-ra -q"
+addopts = "-ra -q --cov"
+asyncio_default_fixture_loop_scope = "function"
 
+[tool.coverage.report]
+show_missing = true
+
+[tool.coverage.run]
+source = ["src"]

{uipath-2.0.53 → uipath-2.0.55}/src/uipath/_cli/_auth/_auth_server.py

@@ -2,7 +2,6 @@ import http.server
 import json
 import os
 import socketserver
-import ssl
 import time
 
 import click
@@ -109,19 +108,15 @@ def make_request_handler_class(state, code_verifier, token_callback, domain):
     return SimpleHTTPSRequestHandler
 
 
-class HTTPSServer:
-    def __init__(self, port=6234, cert_file="localhost.crt", key_file="localhost.key"):
-        """Initialize HTTPS server with configurable parameters.
+class HTTPServer:
+    def __init__(self, port=6234):
+        """Initialize HTTP server with configurable parameters.
 
         Args:
             port (int, optional): Port number to run the server on. Defaults to 6234.
-            cert_file (str, optional): SSL certificate file. Defaults to "localhost.crt".
-            key_file (str, optional): SSL key file. Defaults to "localhost.key".
         """
         self.current_path = os.path.dirname(os.path.abspath(__file__))
         self.port = port
-        self.cert_file = os.path.join(self.current_path, "localhost.crt")
-        self.key_file = os.path.join(self.current_path, "localhost.key")
         self.httpd = None
         self.token_data = None
         self.should_shutdown = False
@@ -136,7 +131,7 @@ class HTTPSServer:
         self.should_shutdown = True
 
     def create_server(self, state, code_verifier, domain):
-        """Create and configure the HTTPS server.
+        """Create and configure the HTTP server.
 
         Args:
             state (str): The OAuth state parameter.
@@ -144,20 +139,14 @@ class HTTPSServer:
             domain (str): The domain for authentication.
 
         Returns:
-            socketserver.TCPServer: The configured HTTPS server.
+            socketserver.TCPServer: The configured HTTP server.
         """
-        # Create SSL context
-        context = ssl.SSLContext(ssl.PROTOCOL_TLS_SERVER)
-        context.load_cert_chain(self.cert_file, self.key_file)
-
         # Create server with address reuse
         socketserver.TCPServer.allow_reuse_address = True
         handler = make_request_handler_class(
             state, code_verifier, self.token_received_callback, domain
         )
         self.httpd = socketserver.TCPServer(("", self.port), handler)
-        self.httpd.socket = context.wrap_socket(self.httpd.socket, server_side=True)
-
         return self.httpd
 
     def start(self, state, code_verifier, domain):

{uipath-2.0.53 → uipath-2.0.55}/src/uipath/_cli/_auth/auth_config.json

@@ -1,6 +1,6 @@
 {
   "client_id": "36dea5b8-e8bb-423d-8e7b-c808df8f1c00",
-  "redirect_uri": "https://localhost:__PY_REPLACE_PORT__/oidc/login",
+  "redirect_uri": "http://localhost:__PY_REPLACE_PORT__/oidc/login",
   "scope": "offline_access OrchestratorApiUserAccess ConnectionService DataService DocumentUnderstanding EnterpriseContextService Directory JamJamApi LLMGateway LLMOps OMS RCS.FolderAuthorization",
   "port": 8104
-}
+}

{uipath-2.0.53 → uipath-2.0.55}/src/uipath/_cli/cli_auth.py

@@ -8,7 +8,7 @@ import click
 from dotenv import load_dotenv
 
 from ..telemetry import track
-from ._auth._auth_server import HTTPSServer
+from ._auth._auth_server import HTTPServer
 from ._auth._oidc_utils import get_auth_config, get_auth_url
 from ._auth._portal_service import PortalService, select_tenant
 from ._auth._utils import update_auth_file, update_env_file
@@ -97,7 +97,7 @@ def auth(domain, force: None | bool = False):
             auth_url,
         )
 
-        server = HTTPSServer(port=auth_config["port"])
+        server = HTTPServer(port=auth_config["port"])
         token_data = server.start(state, code_verifier, domain)
 
         if token_data:

{uipath-2.0.53 → uipath-2.0.55}/src/uipath/_cli/cli_run.py

@@ -42,14 +42,14 @@ def python_run_middleware(
     if not entrypoint:
         return MiddlewareResult(
             should_continue=False,
-            info_message="""Error: No entrypoint specified. Please provide a path to a Python script.
+            error_message="""No entrypoint specified. Please provide a path to a Python script.
 Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path>]`""",
         )
 
     if not os.path.exists(entrypoint):
         return MiddlewareResult(
             should_continue=False,
-            error_message=f"""Error: Script not found at path {entrypoint}.
+            error_message=f"""Script not found at path {entrypoint}.
 Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path>]`""",
         )