uipath 2.0.73__tar.gz → 2.0.74__tar.gz

{uipath-2.0.73 → uipath-2.0.74}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.73
+Version: 2.0.74
 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
@@ -24,6 +24,7 @@ Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: rich>=13.0.0
 Requires-Dist: tenacity>=9.0.0
 Requires-Dist: tomli>=2.2.1
+Requires-Dist: truststore>=0.10.1
 Provides-Extra: langchain
 Requires-Dist: uipath-langchain<0.1.0,>=0.0.88; extra == 'langchain'
 Description-Content-Type: text/markdown

uipath-2.0.74/docs/FAQ.md

@@ -0,0 +1,289 @@
+# 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).
+
+### Q: Why am I getting timeouts or "[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed" errors?
+
+The UiPath CLI automatically works with your corporate network setup, including proxy servers and security tools like ZScaler, by leveraging your system's native SSL certificate store.
+
+#### Proxy Configuration
+
+Configure these environment variables to route CLI traffic through your corporate proxy:
+
+//// tab | Linux/macOS Bash
+
+<!-- termynal -->
+```bash
+> export HTTP_PROXY=http://proxy.company.com:8080
+> export HTTPS_PROXY=https://proxy.company.com:8080
+> export NO_PROXY=localhost,127.0.0.1
+> uipath auth
+⠋ Authenticating with UiPath ...
+✓  Authentication successful.
+```
+
+////
+
+//// tab | Windows PowerShell
+
+<!-- termynal -->
+```powershell
+> $env:HTTP_PROXY="http://proxy.company.com:8080"
+> $env:HTTPS_PROXY="https://proxy.company.com:8080"
+> $env:NO_PROXY="localhost,127.0.0.1"
+> uipath auth
+⠋ Authenticating with UiPath ...
+✓  Authentication successful.
+```
+
+////
+
+//// tab | Windows CMD
+
+<!-- termynal -->
+```cmd
+> set HTTP_PROXY=http://proxy.company.com:8080
+> set HTTPS_PROXY=https://proxy.company.com:8080
+> set NO_PROXY=localhost,127.0.0.1
+> uipath auth
+⠋ Authenticating with UiPath ...
+✓  Authentication successful.
+```
+
+////
+
+#### Proxy Authentication
+
+//// tab | Linux/macOS Bash
+
+<!-- termynal -->
+```bash
+> export HTTP_PROXY=http://username:password@proxy.company.com:8080
+> export HTTPS_PROXY=https://username:password@proxy.company.com:8080
+> export NO_PROXY=localhost,127.0.0.1
+> uipath publish
+⠋ Fetching available package feeds...
+✓  Package published successfully!
+```
+
+////
+
+//// tab | Windows PowerShell
+
+<!-- termynal -->
+```powershell
+> $env:HTTP_PROXY="http://username:password@proxy.company.com:8080"
+> $env:HTTPS_PROXY="https://username:password@proxy.company.com:8080"
+> $env:NO_PROXY="localhost,127.0.0.1"
+> uipath publish
+⠋ Fetching available package feeds...
+✓  Package published successfully!
+```
+
+////
+
+//// tab | Windows CMD
+
+<!-- termynal -->
+```cmd
+> set HTTP_PROXY=http://username:password@proxy.company.com:8080
+> set HTTPS_PROXY=https://username:password@proxy.company.com:8080
+> set NO_PROXY=localhost,127.0.0.1
+> uipath publish
+⠋ Fetching available package feeds...
+✓  Package published successfully!
+```
+
+////
+
+/// tip
+**For IT Administrators**: Add these environment variables to your Group Policy or system configuration:
+
+```bash
+HTTP_PROXY=http://your-proxy.company.com:8080
+HTTPS_PROXY=https://your-proxy.company.com:8080
+NO_PROXY=localhost,127.0.0.1,*.company.com
+```
+///
+
+/// warning
+The CLI uses a local HTTP server for the authentication callback. You must **exclude localhost** from your proxy using `NO_PROXY=localhost,127.0.0.1` or authentication will fail.
+///
+
+##### Troubleshooting
+<!-- termynal -->
+```bash
+> # Test proxy connectivity
+> curl -v --proxy $HTTP_PROXY https://cloud.uipath.com
+*   Trying 192.168.1.100:8080...
+* Connected to proxy.company.com (192.168.1.100) port 8080
+✓ Connection successful
+
+> # Test localhost exclusion
+> curl --proxy $HTTP_PROXY http://localhost:8080
+* Bypassing proxy for localhost
+✓ Direct connection to localhost successful
+```
+
+#### SSL Certificates
+
+The UiPath CLI automatically uses your system's certificate store (Windows Certificate Store, macOS Keychain, Linux ca-certificates). Corporate certificates installed via Group Policy or IT tools will be automatically recognized.
+
+##### Troubleshooting SSL Issues
+
+If you encounter SSL certificate errors:
+
+1. **Disable SSL verification** (for testing only):
+
+   //// tab | Linux/macOS Bash
+
+   <!-- termynal -->
+   ```bash
+   > export UIPATH_DISABLE_SSL_VERIFY=true
+   > uipath auth
+   ⠋ Authenticating with UiPath ...
+   ✓  Authentication successful.
+   ```
+
+   ////
+
+   //// tab | Windows PowerShell
+
+   <!-- termynal -->
+   ```powershell
+   > $env:UIPATH_DISABLE_SSL_VERIFY="true"
+   > uipath auth
+   ⠋ Authenticating with UiPath ...
+   ✓  Authentication successful.
+   ```
+
+   ////
+
+   //// tab | Windows CMD
+
+   <!-- termynal -->
+   ```cmd
+   > set UIPATH_DISABLE_SSL_VERIFY=true
+   > uipath auth
+   ⠋ Authenticating with UiPath ...
+   ✓  Authentication successful.
+   ```
+
+   ////
+
+2. **Use custom certificate bundle** (if needed):
+
+   //// tab | Linux/macOS Bash
+
+   <!-- termynal -->
+   ```bash
+   > export SSL_CERT_FILE=/path/to/company-ca-bundle.pem
+   > export REQUESTS_CA_BUNDLE=/path/to/company-ca-bundle.pem
+   > uipath publish
+   ⠋ Publishing most recent package...
+   ✓  Package published successfully!
+   ```
+
+   ////
+
+   //// tab | Windows PowerShell
+
+   <!-- termynal -->
+   ```powershell
+   > $env:SSL_CERT_FILE="C:\certs\company-ca-bundle.pem"
+   > $env:REQUESTS_CA_BUNDLE="C:\certs\company-ca-bundle.pem"
+   > uipath publish
+   ⠋ Publishing most recent package...
+   ✓  Package published successfully!
+   ```
+
+   ////
+
+   //// tab | Windows CMD
+
+   <!-- termynal -->
+   ```cmd
+   > set SSL_CERT_FILE=C:\certs\company-ca-bundle.pem
+   > set REQUESTS_CA_BUNDLE=C:\certs\company-ca-bundle.pem
+   > uipath publish
+   ⠋ Publishing most recent package...
+   ✓  Package published successfully!
+   ```
+
+   ////
+
+
+---
+
+*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.73 → uipath-2.0.74}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.73"
+version = "2.0.74"
 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"
@@ -15,6 +15,7 @@ dependencies = [
   "pathlib>=1.0.1",
   "rich>=13.0.0",
   "azure-monitor-opentelemetry>=1.6.8",
+  "truststore>=0.10.1"
 ]
 classifiers = [
   "Development Status :: 3 - Alpha",
@@ -48,6 +49,9 @@ dev = [
   "ruff>=0.9.4",
   "rust-just>=1.39.0",
   "pytest>=7.4.0",
+  "pytest-asyncio>=1.0.0",
+  "pytest-httpx>=0.35.0",
+  "pytest-trio>=0.8.0",
   "pytest-cov>=4.1.0",
   "pytest-mock>=3.11.1",
   "pre-commit>=4.1.0",
@@ -57,12 +61,9 @@ dev = [
   "termynal>=0.13.0",
   "mkdocs-simple-hooks>=0.1.5",
   "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",
 ]
 
@@ -122,6 +123,7 @@ testpaths = ["tests"]
 python_files = "test_*.py"
 addopts = "-ra -q --cov"
 asyncio_default_fixture_loop_scope = "function"
+asyncio_mode = "auto"
 
 [tool.coverage.report]
 show_missing = true

{uipath-2.0.73 → uipath-2.0.74}/src/uipath/_cli/_auth/_client_credentials.py

@@ -3,6 +3,7 @@ from urllib.parse import urlparse
 
 import httpx
 
+from ..._utils._ssl_context import get_httpx_client_kwargs
 from .._utils._console import ConsoleLogger
 from ._models import TokenData
 from ._utils import parse_access_token, update_env_file
@@ -91,13 +92,11 @@ class ClientCredentialsService:
         }
 
         try:
-            with httpx.Client(timeout=30.0) as client:
+            with httpx.Client(**get_httpx_client_kwargs()) as client:
                 response = client.post(token_url, data=data)
-
                 match response.status_code:
                     case 200:
                         token_data = response.json()
-                        # Convert to our TokenData format
                         return {
                             "access_token": token_data["access_token"],
                             "token_type": token_data.get("token_type", "Bearer"),

{uipath-2.0.73 → uipath-2.0.74}/src/uipath/_cli/_auth/_portal_service.py

@@ -5,6 +5,7 @@ from typing import Optional
 import click
 import httpx
 
+from ..._utils._ssl_context import get_httpx_client_kwargs
 from .._utils._console import ConsoleLogger
 from ._models import TenantsAndOrganizationInfoResponse, TokenData
 from ._oidc_utils import get_auth_config
@@ -16,7 +17,6 @@ from ._utils import (
 )
 
 console = ConsoleLogger()
-client = httpx.Client(follow_redirects=True, timeout=30.0)
 
 
 class PortalService:
@@ -27,6 +27,8 @@ class PortalService:
     domain: Optional[str] = None
     selected_tenant: Optional[str] = None
 
+    _client: Optional[httpx.Client] = None
+
     _tenants_and_organizations: Optional[TenantsAndOrganizationInfoResponse] = None
 
     def __init__(
@@ -39,13 +41,32 @@ class PortalService:
         self.access_token = access_token
         self.prt_id = prt_id
 
+        self._client = httpx.Client(**get_httpx_client_kwargs())
+
+    def close(self):
+        """Explicitly close the HTTP client."""
+        if self._client:
+            self._client.close()
+            self._client = None
+
+    def __enter__(self):
+        """Enter the runtime context related to this object."""
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        """Exit the runtime context and close the HTTP client."""
+        self.close()
+
     def update_token_data(self, token_data: TokenData):
         self.access_token = token_data["access_token"]
         self.prt_id = get_parsed_token_data(token_data).get("prt_id")
 
     def get_tenants_and_organizations(self) -> TenantsAndOrganizationInfoResponse:
+        if self._client is None:
+            raise RuntimeError("HTTP client is not initialized")
+
         url = f"https://{self.domain}.uipath.com/{self.prt_id}/portal_/api/filtering/leftnav/tenantsAndOrganizationInfo"
-        response = client.get(
+        response = self._client.get(
             url, headers={"Authorization": f"Bearer {self.access_token}"}
         )
         if response.status_code < 400:
@@ -72,6 +93,9 @@ class PortalService:
         return f"https://{self.domain}.uipath.com/{account_name}/{self.selected_tenant}/orchestrator_"
 
     def post_refresh_token_request(self, refresh_token: str) -> TokenData:
+        if self._client is None:
+            raise RuntimeError("HTTP client is not initialized")
+
         url = f"https://{self.domain}.uipath.com/identity_/connect/token"
         client_id = get_auth_config().get("client_id")
 
@@ -83,7 +107,7 @@ class PortalService:
 
         headers = {"Content-Type": "application/x-www-form-urlencoded"}
 
-        response = client.post(url, data=data, headers=headers)
+        response = self._client.post(url, data=data, headers=headers)
         if response.status_code < 400:
             return response.json()
         elif response.status_code == 401:
@@ -137,6 +161,9 @@ class PortalService:
         update_env_file(updated_env_contents)
 
     def post_auth(self, base_url: str) -> None:
+        if self._client is None:
+            raise RuntimeError("HTTP client is not initialized")
+
         or_base_url = (
             f"{base_url}/orchestrator_"
             if base_url
@@ -148,7 +175,7 @@ class PortalService:
 
         try:
             [try_enable_first_run_response, acquire_license_response] = [
-                client.post(
+                self._client.post(
                     url,
                     headers={"Authorization": f"Bearer {self.access_token}"},
                 )

uipath-2.0.74/src/uipath/_cli/_utils/_folders.py

@@ -0,0 +1,35 @@
+from typing import Optional, Tuple
+
+import httpx
+
+from ..._utils._ssl_context import get_httpx_client_kwargs
+from ._console import ConsoleLogger
+
+console = ConsoleLogger()
+
+
+def get_personal_workspace_info(
+    base_url: str, token: str
+) -> Tuple[Optional[str], Optional[str]]:
+    user_url = f"{base_url}/orchestrator_/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUserExtended?$expand=PersonalWorkspace"
+
+    with httpx.Client(**get_httpx_client_kwargs()) as client:
+        user_response = client.get(
+            user_url, headers={"Authorization": f"Bearer {token}"}
+        )
+
+        if user_response.status_code != 200:
+            console.error(
+                "Error: Failed to fetch user info. Please try reauthenticating."
+            )
+            return None, None
+
+        user_data = user_response.json()
+        feed_id = user_data.get("PersonalWorskpaceFeedId")
+        personal_workspace = user_data.get("PersonalWorkspace")
+
+        if not personal_workspace or not feed_id or "Id" not in personal_workspace:
+            return None, None
+
+        folder_id = personal_workspace.get("Id")
+        return feed_id, folder_id

uipath-2.0.74/src/uipath/_cli/_utils/_processes.py

@@ -0,0 +1,54 @@
+import json
+import urllib.parse
+from typing import Any
+
+import httpx
+
+from ..._utils._ssl_context import get_httpx_client_kwargs
+from ._console import ConsoleLogger
+
+console = ConsoleLogger()
+odata_top_filter = 25
+
+
+def get_release_info(
+    base_url: str,
+    token: str,
+    package_name: str,
+    package_version: str,
+    folder_id: str,
+) -> None | tuple[Any, Any] | tuple[None, None]:
+    headers = {
+        "Authorization": f"Bearer {token}",
+        "x-uipath-organizationunitid": str(folder_id),
+    }
+
+    release_url = f"{base_url}/orchestrator_/odata/Releases/UiPath.Server.Configuration.OData.ListReleases?$select=Id,Key,ProcessVersion&$top={odata_top_filter}&$filter=ProcessKey%20eq%20%27{urllib.parse.quote(package_name)}%27"
+
+    with httpx.Client(**get_httpx_client_kwargs()) as client:
+        response = client.get(release_url, headers=headers)
+
+        if response.status_code == 200:
+            try:
+                data = json.loads(response.text)
+                process = next(
+                    process
+                    for process in data["value"]
+                    if process["ProcessVersion"] == package_version
+                )
+                release_id = process["Id"]
+                release_key = process["Key"]
+                return release_id, release_key
+            except KeyError:
+                console.warning("Warning: Failed to deserialize release data")
+                return None, None
+            except StopIteration:
+                console.error(
+                    f"Error: No process with name '{package_name}' found in your workspace. Please publish the process first."
+                )
+                return None, None
+        else:
+            console.warning(
+                f"Warning: Failed to fetch release info {response.status_code}"
+            )
+            return None, None

{uipath-2.0.73 → uipath-2.0.74}/src/uipath/_cli/cli_auth.py

@@ -92,6 +92,11 @@ def auth(
 
     Interactive mode (default): Opens browser for OAuth authentication.
     Unattended mode: Use --client-id, --client-secret and --base-url for client credentials flow.
+
+    Network options:
+    - Set HTTP_PROXY/HTTPS_PROXY/NO_PROXY environment variables for proxy configuration
+    - Set REQUESTS_CA_BUNDLE to specify a custom CA bundle for SSL verification
+    - Set UIPATH_DISABLE_SSL_VERIFY to disable SSL verification (not recommended)
     """
     # Check if client credentials are provided for unattended authentication
     if client_id and client_secret:
@@ -102,7 +107,6 @@ def auth(
             return
 
         with console.spinner("Authenticating with client credentials ..."):
-            # Create service instance
             credentials_service = ClientCredentialsService(domain)
 
             # If base_url is provided, extract domain from it to override the CLI domain parameter
@@ -127,56 +131,57 @@ def auth(
 
     # Interactive authentication flow (existing logic)
     with console.spinner("Authenticating with UiPath ..."):
-        portal_service = PortalService(domain)
-
-        if not force:
-            if (
-                os.getenv("UIPATH_URL")
-                and os.getenv("UIPATH_TENANT_ID")
-                and os.getenv("UIPATH_ORGANIZATION_ID")
-            ):
+        with PortalService(domain) as portal_service:
+            if not force:
+                if (
+                    os.getenv("UIPATH_URL")
+                    and os.getenv("UIPATH_TENANT_ID")
+                    and os.getenv("UIPATH_ORGANIZATION_ID")
+                ):
+                    try:
+                        portal_service.ensure_valid_token()
+                        console.success(
+                            "Authentication successful.",
+                        )
+                        return
+                    except Exception:
+                        console.info(
+                            "Authentication token is invalid. Please reauthenticate.",
+                        )
+
+            auth_url, code_verifier, state = get_auth_url(domain)
+
+            webbrowser.open(auth_url, 1)
+            auth_config = get_auth_config()
+
+            console.link(
+                "If a browser window did not open, please open the following URL in your browser:",
+                auth_url,
+            )
+
+            server = HTTPServer(port=auth_config["port"])
+            token_data = server.start(state, code_verifier, domain)
+
+            if token_data:
+                portal_service.update_token_data(token_data)
+                update_auth_file(token_data)
+                access_token = token_data["access_token"]
+                update_env_file({"UIPATH_ACCESS_TOKEN": access_token})
+
+                tenants_and_organizations = (
+                    portal_service.get_tenants_and_organizations()
+                )
+                base_url = select_tenant(domain, tenants_and_organizations)
                 try:
-                    portal_service.ensure_valid_token()
+                    portal_service.post_auth(base_url)
                     console.success(
                         "Authentication successful.",
                     )
-                    return
                 except Exception:
-                    console.info(
-                        "Authentication token is invalid. Please reauthenticate.",
+                    console.error(
+                        "Could not prepare the environment. Please try again.",
                     )
-
-        auth_url, code_verifier, state = get_auth_url(domain)
-
-        webbrowser.open(auth_url, 1)
-        auth_config = get_auth_config()
-
-        console.link(
-            "If a browser window did not open, please open the following URL in your browser:",
-            auth_url,
-        )
-
-        server = HTTPServer(port=auth_config["port"])
-        token_data = server.start(state, code_verifier, domain)
-
-        if token_data:
-            portal_service.update_token_data(token_data)
-            update_auth_file(token_data)
-            access_token = token_data["access_token"]
-            update_env_file({"UIPATH_ACCESS_TOKEN": access_token})
-
-            tenants_and_organizations = portal_service.get_tenants_and_organizations()
-            base_url = select_tenant(domain, tenants_and_organizations)
-            try:
-                portal_service.post_auth(base_url)
-                console.success(
-                    "Authentication successful.",
-                )
-            except Exception:
+            else:
                 console.error(
-                    "Could not prepare the environment. Please try again.",
+                    "Authentication failed. Please try again.",
                 )
-        else:
-            console.error(
-                "Authentication failed. Please try again.",
-            )