uipath 2.0.51__tar.gz → 2.0.53__tar.gz

{uipath-2.0.51 → uipath-2.0.53}/.github/workflows/build.yml

@@ -26,6 +26,17 @@ jobs:
           uv venv
           uv sync --all-extras
 
+      - name: Replace connection string placeholder
+        run: |
+          originalfile="src/uipath/telemetry/_constants.py"
+          tmpfile=$(mktemp)
+          trap 'rm -f "$tmpfile"' EXIT
+
+          rsync -a --no-whole-file --ignore-existing "$originalfile" "$tmpfile"
+          envsubst '$CONNECTION_STRING' < "$originalfile" > "$tmpfile" && mv "$tmpfile" "$originalfile"
+        env:
+          CONNECTION_STRING: ${{ secrets.APPINS_CONNECTION_STRING }}
+
       - name: Build
         run: |
           uv build

{uipath-2.0.51 → uipath-2.0.53}/.github/workflows/publish-dev.yml

@@ -25,6 +25,17 @@ jobs:
           uv venv
           uv sync --all-extras
 
+      - name: Replace connection string placeholder
+        run: |
+          originalfile="src/uipath/telemetry/_constants.py"
+          tmpfile=$(mktemp)
+          trap 'rm -f "$tmpfile"' EXIT
+
+          rsync -a --no-whole-file --ignore-existing "$originalfile" "$tmpfile"
+          envsubst '$CONNECTION_STRING' < "$originalfile" > "$tmpfile" && mv "$tmpfile" "$originalfile"
+        env:
+          CONNECTION_STRING: ${{ secrets.APPINS_CONNECTION_STRING }}
+
       - name: Set development version
         shell: pwsh
         env:
@@ -116,4 +127,4 @@ jobs:
         run: |
           uv publish
         env:
-          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.51
+Version: 2.0.53
 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
@@ -14,9 +14,10 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Build Tools
 Requires-Python: >=3.10
+Requires-Dist: azure-monitor-opentelemetry>=1.6.8
 Requires-Dist: click>=8.1.8
 Requires-Dist: httpx>=0.28.1
-Requires-Dist: opentelemetry-sdk>=1.32.1
+Requires-Dist: opentelemetry-sdk>=1.31.1
 Requires-Dist: pathlib>=1.0.1
 Requires-Dist: pydantic>=2.11.1
 Requires-Dist: python-dotenv>=1.0.1

{uipath-2.0.51 → uipath-2.0.53}/docs/core/getting_started.md

@@ -87,6 +87,14 @@ uipath version 2.0.29
 
 ////
 
+### Telemetry
+
+To help us improve the developer experience, the CLI collects basic usage data about commands invocation. For more details about UiPath’s privacy practices, please review the [privacy statement](https://www.uipath.com/legal/privacy-policy).
+
+#### Disabling telemetry data
+
+Telemetry is enabled by default, yet it is possible to opt-out by setting to `false` the `UIPATH_TELEMETRY_ENABLED` environment variable.
+
 ### Authentication
 
 To debug your script locally and publish your project, you need to authenticate with UiPath:

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

@@ -1,19 +1,20 @@
 [project]
 name = "uipath"
-version = "2.0.51"
+version = "2.0.53"
 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"
 dependencies = [
   "click>=8.1.8",
   "httpx>=0.28.1",
-  "opentelemetry-sdk>=1.32.1",
+  "opentelemetry-sdk>=1.31.1",
   "pydantic>=2.11.1",
   "python-dotenv>=1.0.1",
   "tenacity>=9.0.0",
   "tomli>=2.2.1",
   "pathlib>=1.0.1",
   "rich>=13.0.0",
+  "azure-monitor-opentelemetry>=1.6.8",
 ]
 classifiers = [
   "Development Status :: 3 - Alpha",

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

@@ -10,7 +10,7 @@ from dotenv import load_dotenv
 
 from ._oidc_utils import get_auth_config
 
-load_dotenv()
+load_dotenv(override=True)
 
 # Server port
 PORT = 6234

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

@@ -7,6 +7,7 @@ import webbrowser
 import click
 from dotenv import load_dotenv
 
+from ..telemetry import track
 from ._auth._auth_server import HTTPSServer
 from ._auth._oidc_utils import get_auth_config, get_auth_url
 from ._auth._portal_service import PortalService, select_tenant
@@ -14,7 +15,7 @@ from ._auth._utils import update_auth_file, update_env_file
 from ._utils._common import environment_options
 from ._utils._console import ConsoleLogger
 
-load_dotenv()
+load_dotenv(override=True)
 console = ConsoleLogger()
 
 
@@ -63,6 +64,7 @@ def set_port():
     required=False,
     help="Force new token",
 )
+@track
 def auth(domain, force: None | bool = False):
     """Authenticate with UiPath Cloud Platform."""
     with console.spinner("Authenticating with UiPath ..."):

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_deploy.py

@@ -1,6 +1,7 @@
 # type: ignore
 import click
 
+from ..telemetry import track
 from .cli_pack import pack
 from .cli_publish import publish
 
@@ -21,6 +22,7 @@ from .cli_publish import publish
     help="Whether to publish to the personal workspace",
 )
 @click.argument("root", type=str, default="./")
+@track
 def deploy(root, feed):
     """Pack and publish the project."""
     ctx = click.get_current_context()

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_init.py

@@ -7,6 +7,7 @@ from typing import Optional
 
 import click
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 from ._utils._input_args import generate_args
 from ._utils._parse_ast import generate_bindings_json
@@ -52,6 +53,7 @@ def get_user_script(directory: str, entrypoint: Optional[str] = None) -> Optiona
 
 @click.command()
 @click.argument("entrypoint", required=False, default=None)
+@track
 def init(entrypoint: str) -> None:
     """Create uipath.json with input/output schemas and bindings."""
     with console.spinner("Initializing UiPath project ..."):

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_invoke.py

@@ -14,12 +14,13 @@ try:
 except ImportError:
     import tomli as tomllib
 
+from ..telemetry import track
 from ._utils._common import get_env_vars
 from ._utils._folders import get_personal_workspace_info
 from ._utils._processes import get_release_info
 
 logger = logging.getLogger(__name__)
-load_dotenv()
+load_dotenv(override=True)
 console = ConsoleLogger()
 client = httpx.Client(follow_redirects=True, timeout=30.0)
 
@@ -50,6 +51,7 @@ def _read_project_details() -> [str, str]:
     type=click.Path(exists=True),
     help="File path for the .json input",
 )
+@track
 def invoke(
     entrypoint: Optional[str], input: Optional[str], file: Optional[str]
 ) -> None:

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_new.py

@@ -4,6 +4,7 @@ import shutil
 
 import click
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 from .middlewares import Middlewares
 
@@ -38,6 +39,7 @@ requires-python = ">=3.10"
 
 @click.command()
 @click.argument("name", type=str, default="")
+@track
 def new(name: str):
     """Generate a quick-start project."""
     directory = os.getcwd()

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_pack.py

@@ -12,6 +12,7 @@ try:
 except ImportError:
     import tomli as tomllib
 
+from ..telemetry import track
 from ._utils._console import ConsoleLogger
 
 console = ConsoleLogger()
@@ -366,6 +367,7 @@ def display_project_info(config):
 
 @click.command()
 @click.argument("root", type=str, default="./")
+@track
 def pack(root):
     """Pack the project."""
     version = get_project_version(root)

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_cli/cli_publish.py

@@ -6,6 +6,7 @@ import click
 import httpx
 from dotenv import load_dotenv
 
+from ..telemetry import track
 from ._utils._common import get_env_vars
 from ._utils._console import ConsoleLogger
 from ._utils._folders import get_personal_workspace_info
@@ -63,6 +64,7 @@ def get_available_feeds(
     flag_value="personal",
     help="Whether to publish to the personal workspace",
 )
+@track
 def publish(feed):
     """Publish the package."""
     current_path = os.getcwd()

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

@@ -9,6 +9,10 @@ from uuid import uuid4
 import click
 from dotenv import load_dotenv
 
+from .._utils.constants import (
+    ENV_JOB_ID,
+)
+from ..telemetry import track
 from ._runtime._contracts import (
     UiPathRuntimeContext,
     UiPathRuntimeError,
@@ -19,7 +23,7 @@ from ._utils._console import ConsoleLogger
 from .middlewares import MiddlewareResult, Middlewares
 
 console = ConsoleLogger()
-load_dotenv()
+load_dotenv(override=True)
 
 
 def python_run_middleware(
@@ -108,6 +112,7 @@ Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path
     type=click.Path(exists=True),
     help="File path for the .json input",
 )
+@track(when=lambda *_a, **_kw: env.get(ENV_JOB_ID) is None)
 def run(
     entrypoint: Optional[str], input: Optional[str], resume: bool, file: Optional[str]
 ) -> None:

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_execution_context.py

@@ -5,7 +5,7 @@ from dotenv import load_dotenv
 
 from ._utils.constants import ENV_JOB_ID, ENV_JOB_KEY, ENV_ROBOT_KEY
 
-load_dotenv()
+load_dotenv(override=True)
 
 
 class ExecutionContext:

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_folder_context.py

@@ -10,7 +10,7 @@ from ._utils.constants import (
     HEADER_FOLDER_PATH,
 )
 
-load_dotenv()
+load_dotenv(override=True)
 
 
 class FolderContext:

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_uipath.py

@@ -26,7 +26,7 @@ from ._utils.constants import (
 )
 from .models.errors import BaseUrlMissingError, SecretMissingError
 
-load_dotenv()
+load_dotenv(override=True)
 
 
 class UiPath:

{uipath-2.0.51 → uipath-2.0.53}/src/uipath/_utils/constants.py

@@ -8,6 +8,8 @@ ENV_JOB_KEY = "UIPATH_JOB_KEY"
 ENV_JOB_ID = "UIPATH_JOB_ID"
 ENV_ROBOT_KEY = "UIPATH_ROBOT_KEY"
 ENV_TENANT_ID = "UIPATH_TENANT_ID"
+ENV_ORGANIZATION_ID = "UIPATH_ORGANIZATION_ID"
+ENV_TELEMETRY_ENABLED = "UIPATH_TELEMETRY_ENABLED"
 
 # Headers
 HEADER_FOLDER_KEY = "x-uipath-folderkey"

uipath-2.0.53/src/uipath/telemetry/__init__.py

@@ -0,0 +1,3 @@
+from ._track import track  # noqa: D104
+
+__all__ = ["track"]

uipath-2.0.53/src/uipath/telemetry/_constants.py

@@ -0,0 +1,16 @@
+_CONNECTION_STRING = ""
+
+_APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE = "APPLICATION_INSIGHTS_EVENT_MARKER_ATTRIBUTE"
+_OTEL_RESOURCE_ATTRIBUTES = "OTEL_RESOURCE_ATTRIBUTES"
+_SDK_VERSION = "SdkVersion"
+
+_CODE_FILEPATH = "code.filepath"
+_CODE_FUNCTION = "code.function"
+_CODE_LINENO = "code.lineno"
+
+_CLOUD_ORG_ID = "CloudOrganizationId"
+_CLOUD_TENANT_ID = "CloudTenantId"
+_CLOUD_URL = "CloudUrl"
+_APP_NAME = "ApplicationName"
+
+_UNKNOWN = ""

uipath-2.0.53/src/uipath/telemetry/_track.py

@@ -0,0 +1,130 @@
+import os
+from functools import wraps
+from importlib.metadata import version
+from logging import INFO, LogRecord, getLogger
+from typing import Any, Callable, Dict, Optional, Union
+
+from azure.monitor.opentelemetry import configure_azure_monitor
+from opentelemetry.sdk._logs import LoggingHandler
+from opentelemetry.util.types import Attributes
+
+from .._utils.constants import (
+    ENV_BASE_URL,
+    ENV_ORGANIZATION_ID,
+    ENV_TELEMETRY_ENABLED,
+    ENV_TENANT_ID,
+)
+from ._constants import (
+    _APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE,
+    _APP_NAME,
+    _CLOUD_ORG_ID,
+    _CLOUD_TENANT_ID,
+    _CLOUD_URL,
+    _CODE_FILEPATH,
+    _CODE_FUNCTION,
+    _CODE_LINENO,
+    _CONNECTION_STRING,
+    _OTEL_RESOURCE_ATTRIBUTES,
+    _SDK_VERSION,
+    _UNKNOWN,
+)
+
+_logger = getLogger(__name__)
+_logger.propagate = False
+
+
+class _AzureMonitorOpenTelemetryEventHandler(LoggingHandler):
+    @staticmethod
+    def _get_attributes(record: LogRecord) -> Attributes:
+        attributes = dict(LoggingHandler._get_attributes(record) or {})
+        attributes[_APP_INSIGHTS_EVENT_MARKER_ATTRIBUTE] = True
+        attributes[_CLOUD_TENANT_ID] = os.getenv(ENV_TENANT_ID, _UNKNOWN)
+        attributes[_CLOUD_ORG_ID] = os.getenv(ENV_ORGANIZATION_ID, _UNKNOWN)
+        attributes[_CLOUD_URL] = os.getenv(ENV_BASE_URL, _UNKNOWN)
+        attributes[_APP_NAME] = "UiPath.Sdk"
+        attributes[_SDK_VERSION] = version("uipath")
+
+        if _CODE_FILEPATH in attributes:
+            del attributes[_CODE_FILEPATH]
+        if _CODE_FUNCTION in attributes:
+            del attributes[_CODE_FUNCTION]
+        if _CODE_LINENO in attributes:
+            del attributes[_CODE_LINENO]
+
+        return attributes
+
+
+class _TelemetryClient:
+    """A class to handle telemetry."""
+
+    _initialized = False
+    _enabled = os.getenv(ENV_TELEMETRY_ENABLED, "true").lower() == "true"
+
+    @staticmethod
+    def _initialize():
+        """Initialize the telemetry client."""
+        if _TelemetryClient._initialized or not _TelemetryClient._enabled:
+            return
+
+        try:
+            os.environ[_OTEL_RESOURCE_ATTRIBUTES] = (
+                "service.name=uipath-sdk,service.instance.id=" + version("uipath")
+            )
+            os.environ["OTEL_TRACES_EXPORTER"] = "none"
+
+            configure_azure_monitor(
+                connection_string=_CONNECTION_STRING,
+                disable_offline_storage=True,
+            )
+
+            _logger.addHandler(_AzureMonitorOpenTelemetryEventHandler())
+            _logger.setLevel(INFO)
+
+            _TelemetryClient._initialized = True
+        except Exception:
+            pass
+
+    @staticmethod
+    def _track_method(name: str, attrs: Optional[Dict[str, Any]] = None):
+        """Track function invocations."""
+        if not _TelemetryClient._enabled:
+            return
+
+        _TelemetryClient._initialize()
+
+        _logger.info(f"Sdk.{name.capitalize()}", extra=attrs)
+
+
+def track(
+    name_or_func: Optional[Union[str, Callable[..., Any]]] = None,
+    *,
+    when: Optional[Union[bool, Callable[..., bool]]] = True,
+    extra: Optional[Dict[str, Any]] = None,
+):
+    """Decorator that will trace function invocations.
+
+    Args:
+        name_or_func: The name of the event to track or the function itself.
+        extra: Extra attributes to add to the telemetry event.
+    """
+
+    def decorator(func: Callable[..., Any]):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            event_name = (
+                name_or_func if isinstance(name_or_func, str) else func.__name__
+            )
+
+            should_track = when(*args, **kwargs) if callable(when) else when
+
+            if should_track:
+                _TelemetryClient._track_method(event_name, extra)
+
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    if callable(name_or_func):
+        return decorator(name_or_func)
+
+    return decorator