uipath 2.0.20__tar.gz → 2.0.22__tar.gz

uipath-2.0.22/.github/workflows/publish-dev.yml

@@ -0,0 +1,109 @@
+name: Publish Dev Build
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, labeled]
+    secrets:
+      PYPI_TOKEN:
+        required: true
+      TESTPYPI_TOKEN:
+        required: true
+
+
+jobs:
+  publish-dev:
+    runs-on: ubuntu-latest
+    
+    # Only run if PR has the build:dev label
+    if: contains(github.event.pull_request.labels.*.name, 'build:dev')
+    
+    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: 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
+          $NIGHTLY_NAME = "$PROJECT_NAME-nightly"
+
+
+          # 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
+          
+          # Update project name in pyproject.toml
+          (Get-Content pyproject.toml) -replace "name = `"$PROJECT_NAME`"", "name = `"$NIGHTLY_NAME`"" | Set-Content pyproject.toml
+
+          
+          Write-Output "Package version set to $DEV_VERSION"
+
+          $dependencyMessage = @"
+          - Add this package as a dependency in your pyproject.toml:
+
+          ``````toml
+          [project]
+          dependencies = [
+            # Exact version:
+            "$NIGHTLY_NAME==$DEV_VERSION",
+            
+            # Any version from PR
+            "$NIGHTLY_NAME>=$MIN_VERSION,<$MAX_VERSION"
+          ]
+          ``````
+          "@
+          Write-Output $dependencyMessage
+
+          # Post comment to GitHub PR
+          $owner = "${{ github.repository_owner }}"
+          $repo = "${{ github.repository }}".Split('/')[1]
+          $issueNumber = $PR_NUM
+
+          $body = @{
+            body = $dependencyMessage
+          } | ConvertTo-Json
+
+          # Create the comment using GitHub REST API
+          $uri = "https://api.github.com/repos/$owner/$repo/issues/$issueNumber/comments"
+          $headers = @{
+            Authorization = "token $env:GITHUB_TOKEN"
+            Accept = "application/vnd.github.v3+json"
+          }
+
+          Invoke-RestMethod -Uri $uri -Method Post -Body $body -Headers $headers -ContentType "application/json"
+      
+      - name: Build package
+        run: uv build
+
+      - name: Publish
+        run: |
+          uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

{uipath-2.0.20 → uipath-2.0.22}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.20
+Version: 2.0.22
 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
@@ -21,6 +21,7 @@ Requires-Dist: pydantic>=2.11.1
 Requires-Dist: pytest-asyncio>=0.25.3
 Requires-Dist: python-dotenv>=1.0.1
 Requires-Dist: requests>=2.32.3
+Requires-Dist: rich>=13.0.0
 Requires-Dist: tenacity>=9.0.0
 Requires-Dist: tomli>=2.2.1
 Requires-Dist: types-requests>=2.32.0.20250306

{uipath-2.0.20 → uipath-2.0.22}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.20"
+version = "2.0.22"
 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"
@@ -16,6 +16,7 @@ dependencies = [
   "tomli>=2.2.1",
   "types-requests>=2.32.0.20250306",
   "pathlib>=1.0.1",
+  "rich>=13.0.0",
 ]
 classifiers = [
   "Development Status :: 3 - Alpha",
@@ -60,6 +61,9 @@ dev = [
 [project.optional-dependencies]
 langchain = ["uipath-langchain>=0.0.88,<0.1.0"]
 
+[tool.hatch.build.targets.wheel]
+packages = ["src/uipath"]
+
 [tool.ruff]
 line-length = 88
 indent-width = 4

{uipath-2.0.20 → uipath-2.0.22}/src/uipath/_cli/__init__.py

@@ -6,15 +6,25 @@ import click
 from .cli_auth import auth as auth  # type: ignore
 from .cli_deploy import deploy as deploy  # type: ignore
 from .cli_init import init as init  # type: ignore
+from .cli_invoke import invoke as invoke  # type: ignore
 from .cli_new import new as new  # type: ignore
 from .cli_pack import pack as pack  # type: ignore
 from .cli_publish import publish as publish  # type: ignore
 from .cli_run import run as run  # type: ignore
 
 
+def _get_safe_version() -> str:
+    """Get the version of the uipath package."""
+    try:
+        version = importlib.metadata.version("uipath")
+        return version
+    except importlib.metadata.PackageNotFoundError:
+        return "unknown"
+
+
 @click.group(invoke_without_command=True)
 @click.version_option(
-    importlib.metadata.version("uipath"),
+    _get_safe_version(),
     prog_name="uipath",
     message="%(prog)s version %(version)s",
 )
@@ -52,3 +62,4 @@ cli.add_command(publish)
 cli.add_command(run)
 cli.add_command(deploy)
 cli.add_command(auth)
+cli.add_command(invoke)

{uipath-2.0.20 → uipath-2.0.22}/src/uipath/_cli/_auth/_auth_server.py

@@ -5,6 +5,7 @@ import socketserver
 import ssl
 import time
 
+import click
 from dotenv import load_dotenv
 
 from ._oidc_utils import get_auth_config
@@ -38,7 +39,7 @@ def make_request_handler_class(state, code_verifier, token_callback, domain):
                 content_length = int(self.headers["Content-Length"])
                 post_data = self.rfile.read(content_length)
                 token_data = json.loads(post_data.decode("utf-8"))
-                print("Received authentication information")
+                click.echo("Received authentication information")
 
                 self.send_response(200)
                 self.end_headers()
@@ -179,7 +180,7 @@ class HTTPSServer:
                 while not self.should_shutdown:
                     self.httpd.handle_request()
         except KeyboardInterrupt:
-            print("Process interrupted by user")
+            click.echo("Process interrupted by user")
         finally:
             self.stop()
 

uipath-2.0.22/src/uipath/_cli/_utils/_common.py

@@ -0,0 +1,45 @@
+import os
+from typing import Optional
+
+import click
+
+from ..spinner import Spinner
+
+
+def environment_options(function):
+    function = click.option(
+        "--alpha",
+        "domain",
+        flag_value="alpha",
+        help="Use alpha environment",
+    )(function)
+    function = click.option(
+        "--staging",
+        "domain",
+        flag_value="staging",
+        help="Use staging environment",
+    )(function)
+    function = click.option(
+        "--cloud",
+        "domain",
+        flag_value="cloud",
+        default=True,
+        help="Use production environment",
+    )(function)
+    return function
+
+
+def get_env_vars(spinner: Optional[Spinner] = None) -> list[str | None]:
+    base_url = os.environ.get("UIPATH_URL")
+    token = os.environ.get("UIPATH_ACCESS_TOKEN")
+
+    if not all([base_url, token]):
+        if spinner:
+            spinner.stop()
+        click.echo(
+            "❌ Missing required environment variables. Please check your .env file contains:"
+        )
+        click.echo("UIPATH_URL, UIPATH_ACCESS_TOKEN")
+        click.get_current_context().exit(1)
+
+    return [base_url, token]

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

@@ -0,0 +1,29 @@
+from typing import Optional, Tuple
+
+import click
+import requests
+
+from ..spinner import Spinner
+
+
+def get_personal_workspace_info(
+    base_url: str, token: str, spinner: Optional[Spinner] = None
+) -> Tuple[str, str]:
+    user_url = f"{base_url}/orchestrator_/odata/Users/UiPath.Server.Configuration.OData.GetCurrentUserExtended?$expand=PersonalWorkspace"
+    user_response = requests.get(user_url, headers={"Authorization": f"Bearer {token}"})
+
+    if user_response.status_code != 200:
+        if spinner:
+            spinner.stop()
+        click.echo("❌ Failed to get user info. Please try reauthenticating.")
+        click.get_current_context().exit(1)
+
+    user_data = user_response.json()
+    feed_id = user_data.get("PersonalWorskpaceFeedId")
+    folder_id = user_data["PersonalWorkspace"].get("Id")
+    if not (feed_id and folder_id):
+        if spinner:
+            spinner.stop()
+        click.echo("❌ No personal workspace found for user")
+        click.get_current_context().exit(1)
+    return feed_id, folder_id

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

@@ -0,0 +1,49 @@
+import json
+import urllib.parse
+from typing import Any, Optional
+
+import click
+import requests
+
+from ..spinner import Spinner
+
+
+def get_release_info(
+    base_url: str,
+    token: str,
+    package_name: str,
+    folder_id: str,
+    spinner: Optional[Spinner] = None,
+) -> 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&$top=1&$filter=(contains(Name,%27{urllib.parse.quote(package_name)}%27))&$orderby=Name%20asc"
+    response = requests.get(release_url, headers=headers)
+    if response.status_code == 200:
+        try:
+            data = json.loads(response.text)
+            release_id = data["value"][0]["Id"]
+            release_key = data["value"][0]["Key"]
+            return release_id, release_key
+        except KeyError:
+            if spinner:
+                spinner.stop()
+            click.echo("\n⚠️ Warning: Failed to deserialize release data")
+            return None, None
+        except IndexError:
+            if spinner:
+                spinner.stop()
+            click.echo(
+                "\n❌ Process not found in your workspace. Try publishing it first."
+            )
+            click.get_current_context().exit(1)
+
+    else:
+        if spinner:
+            spinner.stop()
+        click.echo("\n⚠️ Warning: Failed to fetch release info")
+        click.echo(f"Status code: {response.status_code}")
+        return None, None

{uipath-2.0.20 → uipath-2.0.22}/src/uipath/_cli/cli_auth.py

@@ -12,6 +12,7 @@ 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
 from ._utils._common import environment_options
+from .spinner import Spinner
 
 load_dotenv()
 
@@ -37,7 +38,7 @@ def set_port():
             if is_port_in_use(port_option_two):
                 if is_port_in_use(port_option_three):
                     raise RuntimeError(
-                        "All configured ports are in use. Please close applications using ports or configure different ports."
+                        "❌ All configured ports are in use. Please close applications using ports or configure different ports."
                     )
                 else:
                     port = port_option_three
@@ -56,6 +57,8 @@ def set_port():
 @environment_options
 def auth(domain="alpha"):
     """Authenticate with UiPath Cloud Platform."""
+    spinner = Spinner("Authenticating with UiPath...")
+    spinner.start()
     portal_service = PortalService(domain)
     if (
         os.getenv("UIPATH_URL")
@@ -64,9 +67,13 @@ def auth(domain="alpha"):
     ):
         try:
             portal_service.ensure_valid_token()
-            click.echo("Authentication successful")
+            spinner.stop()
+            click.echo(
+                click.style("✓ ", fg="green", bold=True) + "Authentication successful"
+            )
             return
         except Exception:
+            spinner.stop()
             click.echo(
                 "Authentication not found or expired. Please authenticate again."
             )
@@ -75,23 +82,26 @@ def auth(domain="alpha"):
 
     webbrowser.open(auth_url, 1)
     auth_config = get_auth_config()
-
+    spinner.stop()
     print(
         "If a browser window did not open, please open the following URL in your browser:"
     )
     print(auth_url)
+
     server = HTTPSServer(port=auth_config["port"])
     token_data = server.start(state, code_verifier, domain)
-    try:
-        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()
-            select_tenant(domain, tenants_and_organizations)
-        else:
-            click.echo("Authentication failed")
-    except Exception as e:
-        click.echo(f"Authentication failed: {e}")
+    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()
+        select_tenant(domain, tenants_and_organizations)
+        click.echo(
+            click.style("✓ ", fg="green", bold=True)
+            + "Authentication completed successfully!"
+        )
+    else:
+        click.echo("❌ Authentication failed")

{uipath-2.0.20 → uipath-2.0.22}/src/uipath/_cli/cli_init.py

@@ -11,6 +11,7 @@ import click
 from ._utils._input_args import generate_args
 from ._utils._parse_ast import generate_bindings_json
 from .middlewares import Middlewares
+from .spinner import Spinner
 
 
 def generate_env_file(target_directory):
@@ -51,6 +52,7 @@ def get_user_script(directory: str, entrypoint: Optional[str] = None) -> Optiona
 @click.argument("entrypoint", required=False, default=None)
 def init(entrypoint: str) -> None:
     """Initialize a uipath.json configuration file for the script."""
+    spinner = Spinner("Initializing UiPath project...")
     current_directory = os.getcwd()
     generate_env_file(current_directory)
 
@@ -67,12 +69,11 @@ def init(entrypoint: str) -> None:
 
     if not result.should_continue:
         return
-
     script_path = get_user_script(current_directory, entrypoint=entrypoint)
 
     if not script_path:
         click.get_current_context().exit(1)
-
+    spinner.start()
     try:
         args = generate_args(script_path)
 
@@ -94,21 +95,23 @@ def init(entrypoint: str) -> None:
         # Generate bindings JSON based on the script path
         try:
             bindings_data = generate_bindings_json(script_path)
-
             # Add bindings to the config data
             config_data["bindings"] = bindings_data
-
-            click.echo("Bindings generated successfully.")
         except Exception as e:
-            click.echo(f"Warning: Could not generate bindings: {str(e)}")
+            click.echo(f"⚠️ Warning: Could not generate bindings: {str(e)}")
 
         config_path = "uipath.json"
         with open(config_path, "w") as config_file:
             json.dump(config_data, config_file, indent=4)
 
-        click.echo(f"Configuration file {config_path} created successfully.")
+        spinner.stop()
+        click.echo(
+            click.style("✓ ", fg="green", bold=True)
+            + f"Configuration file {config_path} created successfully."
+        )
 
     except Exception as e:
-        click.echo(f"Error generating configuration: {str(e)}")
+        spinner.stop()
+        click.echo(f"❌ Error generating configuration: {str(e)}")
         click.echo(traceback.format_exc())
         click.get_current_context().exit(1)

uipath-2.0.22/src/uipath/_cli/cli_invoke.py

@@ -0,0 +1,105 @@
+# type: ignore
+import logging
+import os
+from typing import Optional
+
+import click
+import requests
+from dotenv import load_dotenv
+
+from .spinner import Spinner
+
+try:
+    import tomllib
+except ImportError:
+    import tomli as tomllib
+
+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()
+
+
+def _read_project_name() -> str:
+    current_path = os.getcwd()
+    toml_path = os.path.join(current_path, "pyproject.toml")
+    if not os.path.isfile(toml_path):
+        raise Exception("pyproject.toml not found")
+
+    with open(toml_path, "rb") as f:
+        content = tomllib.load(f)
+        if "project" not in content:
+            raise Exception("pyproject.toml is missing the required field: project")
+        if "name" not in content["project"]:
+            raise Exception(
+                "pyproject.toml is missing the required field: project.name"
+            )
+
+        return content["project"]["name"]
+
+
+@click.command()
+@click.argument("entrypoint", required=False)
+@click.argument("input", required=False, default="{}")
+def invoke(entrypoint: Optional[str], input: Optional[str]) -> None:
+    """Invoke a remote agent with JSON input."""
+    spinner = Spinner("Starting job...")
+    spinner.start()
+
+    current_path = os.getcwd()
+    load_dotenv(os.path.join(current_path, ".env"), override=True)
+    [base_url, token] = get_env_vars(spinner)
+
+    url = f"{base_url}/orchestrator_/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs"
+    _, personal_workspace_folder_id = get_personal_workspace_info(
+        base_url, token, spinner
+    )
+    project_name = _read_project_name()
+
+    _, release_key = get_release_info(
+        base_url, token, project_name, personal_workspace_folder_id, spinner
+    )
+    payload = {
+        "StartInfo": {
+            "ReleaseKey": str(release_key),
+            "RunAsMe": True,
+            "InputArguments": input,
+            "EntryPointPath": entrypoint,
+        }
+    }
+    headers = {
+        "Authorization": f"Bearer {token}",
+        "x-uipath-organizationunitid": str(personal_workspace_folder_id),
+    }
+
+    response = requests.post(url, json=payload, headers=headers)
+    spinner.stop()
+
+    if response.status_code == 201:
+        job_key = None
+        try:
+            job_key = response.json()["value"][0]["Key"]
+        except KeyError:
+            click.echo("Error: Failed to get job key from response")
+            click.Abort()
+        if job_key:
+            job_url = f"{base_url}/orchestrator_/jobs(sidepanel:sidepanel/jobs/{job_key}/details)?fid={personal_workspace_folder_id}"
+            click.echo("\n✨ Job started successfully!")
+            click.echo(
+                "\n🔗 Monitor your job here: "
+                + click.style(
+                    f"\u001b]8;;{job_url}\u001b\\{job_url}\u001b]8;;\u001b\\",
+                    fg="bright_blue",
+                    bold=True,
+                )
+                + "\n"
+            )
+    else:
+        click.echo(f"\n❌ Error starting job: {response.text}")
+        click.Abort()
+
+
+if __name__ == "__main__":
+    invoke()

{uipath-2.0.20 → uipath-2.0.22}/src/uipath/_cli/cli_new.py

@@ -6,6 +6,7 @@ import traceback
 import click
 
 from .middlewares import Middlewares
+from .spinner import Spinner
 
 
 def generate_script(target_directory):
@@ -37,6 +38,7 @@ requires-python = ">=3.9"
 @click.command()
 @click.argument("name", type=str, default="")
 def new(name: str):
+    spinner = Spinner("Creating new project...")
     directory = os.getcwd()
 
     if not name:
@@ -44,12 +46,15 @@ def new(name: str):
             "Please specify a name for your project\n`uipath new hello-world`"
         )
 
-    click.echo(f"Initializing project {name} in current directory..")
+    click.echo(
+        click.style("✓ ", fg="green", bold=True)
+        + f"Initializing project {name} in current directory.."
+    )
 
     result = Middlewares.next("new", name)
 
     if result.error_message:
-        click.echo(result.error_message)
+        click.echo("❌ " + result.error_message)
         if result.should_include_stacktrace:
             click.echo(traceback.format_exc())
         click.get_current_context().exit(1)
@@ -61,13 +66,14 @@ def new(name: str):
         return
 
     generate_script(directory)
-    click.echo("Created main.py file.")
+    click.echo(click.style("✓ ", fg="green", bold=True) + "Created main.py file")
     generate_pyproject(directory, name)
-    click.echo("Created pyproject.toml file.")
-
+    click.echo(click.style("✓ ", fg="green", bold=True) + "Created pyproject.toml file")
+    spinner.start()
     ctx = click.get_current_context()
     init_cmd = ctx.parent.command.get_command(ctx, "init")
     ctx.invoke(init_cmd)
+    spinner.stop()
 
     click.echo("""` uipath run main.py '{"message": "Hello World!"}' `""")