uipath 2.0.31__tar.gz → 2.0.33__tar.gz

{uipath-2.0.31 → uipath-2.0.33}/.github/workflows/build.yml

@@ -56,7 +56,6 @@ jobs:
         if: ${{ steps.check_version.outputs.modified }} == 'true'
         run: |
           mkdir -p docs/plugins
-          mkdir -p docs/docs
           ln -s ../../plugins/uipath-langchain-python docs/plugins/uipath-langchain-python
 
       - name: Publish Docs

{uipath-2.0.31 → uipath-2.0.33}/.gitignore

@@ -17,3 +17,9 @@ wheels/
 
 **/playground.py
 **/.idea
+
+**/docs/index.md
+**/docs/plugins/*
+**/docs/plugins/.*
+**/docs/quick_start_images/*
+**/docs/quick_start_images/.*

{uipath-2.0.31 → uipath-2.0.33}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.31
+Version: 2.0.33
 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
@@ -35,10 +35,12 @@ Description-Content-Type: text/markdown
 [![PyPI - Version](https://img.shields.io/pypi/v/uipath)](https://img.shields.io/pypi/v/uipath)
 [![Python versions](https://img.shields.io/pypi/pyversions/uipath.svg)](https://pypi.org/project/uipath/)
 
-A Python SDK that enables programmatic interaction with UiPath Platform services including processes, assets, buckets, context grounding, data services, jobs, and more. The package also features a CLI for creation, packaging, and deployment of automations to UiPath Platform.
+A Python SDK that enables programmatic interaction with UiPath Cloud Platform services including processes, assets, buckets, context grounding, data services, jobs, and more. The package also features a CLI for creation, packaging, and deployment of automations to UiPath Cloud Platform.
 
 Use the [UiPath LangChain SDK](https://github.com/UiPath/uipath-langchain-python) to pack and publish LangGraph Agents.
 
+This [quickstart guide](https://uipath.github.io/uipath-python/) walks you through deploying your first agent to UiPath Cloud Platform.
+
 ## Table of Contents
 
 -   [Installation](#installation)
@@ -211,4 +213,4 @@ To properly use the CLI for packaging and publishing, your project should includ
 
 ### Setting Up a Development Environment
 
-Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting a pull request.
+Please read [CONTRIBUTING.md](https://github.com/UiPath/uipath-python/blob/main/CONTRIBUTING.md) before submitting a pull request.

{uipath-2.0.31 → uipath-2.0.33}/README.md

@@ -4,10 +4,12 @@
 [![PyPI - Version](https://img.shields.io/pypi/v/uipath)](https://img.shields.io/pypi/v/uipath)
 [![Python versions](https://img.shields.io/pypi/pyversions/uipath.svg)](https://pypi.org/project/uipath/)
 
-A Python SDK that enables programmatic interaction with UiPath Platform services including processes, assets, buckets, context grounding, data services, jobs, and more. The package also features a CLI for creation, packaging, and deployment of automations to UiPath Platform.
+A Python SDK that enables programmatic interaction with UiPath Cloud Platform services including processes, assets, buckets, context grounding, data services, jobs, and more. The package also features a CLI for creation, packaging, and deployment of automations to UiPath Cloud Platform.
 
 Use the [UiPath LangChain SDK](https://github.com/UiPath/uipath-langchain-python) to pack and publish LangGraph Agents.
 
+This [quickstart guide](https://uipath.github.io/uipath-python/) walks you through deploying your first agent to UiPath Cloud Platform.
+
 ## Table of Contents
 
 -   [Installation](#installation)
@@ -180,4 +182,4 @@ To properly use the CLI for packaging and publishing, your project should includ
 
 ### Setting Up a Development Environment
 
-Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting a pull request.
+Please read [CONTRIBUTING.md](https://github.com/UiPath/uipath-python/blob/main/CONTRIBUTING.md) before submitting a pull request.

{uipath-2.0.31 → uipath-2.0.33}/docs/CONTRIBUTING.md

@@ -1,8 +1,3 @@
----
-hide:
-  - navigation
----
-
 --8<--
 CONTRIBUTING.md
 --8<--

uipath-2.0.33/docs/core/getting_started.md

@@ -0,0 +1,246 @@
+# Getting Started
+
+## Prerequisites
+
+-   Python 3.10 or higher
+-   `pip` or `uv` package manager
+-   A UiPath Cloud Platform account with appropriate permissions
+
+## Getting Started with the CLI
+
+//// tab | Linux, macOS, Windows Bash
+
+<!-- termynal -->
+
+```shell
+> mkdir example
+> cd example
+```
+
+////
+
+//// tab | Windows PowerShell
+
+<!-- termynal -->
+
+```powershell
+> New-Item -ItemType Directory -Path example
+> Set-Location example
+```
+
+////
+
+//// tab | uv
+    new: true
+
+<!-- termynal -->
+
+```shell
+# Initialize a new uv project in the current directory
+> uv init . --python 3.10
+
+# Create a new virtual environment
+# By default, uv creates a virtual environment in a directory called .venv
+> uv venv
+Using CPython 3.10.16 interpreter at: [PATH]
+Creating virtual environment at: .venv
+Activate with: source .venv/bin/activate
+
+# Activate the virtual environment
+# For Windows PowerShell: .venv\Scripts\Activate.ps1
+# For Windows Bash: source .venv/Scripts/activate
+> source .venv/bin/activate
+
+# Install the uipath package
+> uv add uipath
+
+# Verify the uipath installation
+> uipath --version
+uipath version 2.0.29
+```
+
+////
+
+//// tab | pip
+
+<!-- termynal -->
+
+```shell
+# Create a new virtual environment
+> python -m venv .venv
+
+# Activate the virtual environment
+# For Windows PowerShell: .venv\Scripts\Activate.ps1
+# For Windows Bash: source .venv/Scripts/activate
+> source .venv/bin/activate
+
+# Upgrade pip to the latest version
+> python -m pip install --upgrade pip
+
+# Install the uipath package
+> pip install uipath
+
+# Verify the uipath installation
+> uipath --version
+uipath version 2.0.29
+```
+
+////
+
+### Authentication
+
+To debug your script locally and publish your project, you need to authenticate with UiPath:
+
+<!-- termynal -->
+
+```shell
+> uipath auth
+⠋ Authenticating with UiPath ...
+🔗 If a browser window did not open, please open the following URL in your browser: [LINK]
+👇 Select tenant:
+  0: Tenant1
+  1: Tenant2
+Select tenant number: 0
+Selected tenant: Tenant1
+✓  Authentication successful.
+```
+
+This command opens a new browser window for authentication. If you encounter any issues, copy the URL from the terminal and paste it into your browser. After authentication, select your tenant by entering its corresponding number in the terminal.
+
+Upon successful authentication, your project will contain a `.env` file with your access token, UiPath URL, and other configuration details.
+
+### Writing Your Code
+
+Open `main.py` in your code editor. You can start with this example code:
+
+```python
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class EchoIn:
+    message: str
+    repeat: Optional[int] = 1
+    prefix: Optional[str] = None
+
+
+@dataclass
+class EchoOut:
+    message: str
+
+
+def main(input: EchoIn) -> EchoOut:
+    result = []
+    for _ in range(input.repeat or 1):
+        line = input.message
+        if input.prefix:
+            line = f"{input.prefix}: {line}"
+        result.append(line)
+
+    return EchoOut(message="\n".join(result))
+```
+
+### Initializing the UiPath Project
+
+To create a UiPath project, run the following command in your terminal:
+
+<!-- termynal -->
+
+```shell
+> uipath init
+⠋ Initializing UiPath project ...
+✓  Created 'uipath.json' file.
+```
+
+/// admonition
+    type: warning
+
+The `uipath init` command executes your `main.py` file to analyze its structure and collect information about inputs and outputs.
+///
+
+This command creates a `uipath.json` file containing the project metadata.
+
+<!-- termynal -->
+
+```shell
+# Debug your project
+> uipath run main.py '{"message": "test"}'
+[2025-04-11 10:13:58,857][INFO] {'message': 'test'}
+```
+
+### Packaging and Publishing
+
+Before packaging your project, add your details to the `pyproject.toml` file. Add the following line below the `description` field:
+
+```toml
+authors = [{ name = "Your Name", email = "your.email@uipath.com" }]
+```
+
+Then, package your project:
+
+<!-- termynal -->
+
+```shell
+> uipath pack
+⠋ Packaging project ...
+Name       : test
+Version    : 0.1.0
+Description: Add your description here
+Authors    : Your Name
+✓  Project successfully packaged.
+```
+
+Finally, publish your package:
+
+<!-- termynal -->
+
+```shell
+> uipath publish
+⠋ Fetching available package feeds...
+👇 Select package feed:
+  0: Orchestrator Tenant Processes Feed
+  1: Orchestrator Personal Workspace Feed
+Select feed number: 0
+Selected feed: Orchestrator Tenant Processes Feed
+⠸ Publishing most recent package: test.0.1.0.nupkg ...
+✓  Package published successfully!
+```
+
+After selecting your publishing destination (tenant or personal workspace), you'll see details about your package and a confirmation message.
+
+## Getting Started with the SDK
+
+Create a new project following the same steps as above.
+
+Open `main.py` in your code editor and add the following code:
+
+```python
+from uipath import UiPath
+
+
+def main():
+    sdk = UiPath()
+    sdk.processes.invoke(
+        "test",
+        input_arguments={
+            "message": "Hello, World!",
+            "repeat": 3,
+            "prefix": "[Echo]"
+        }
+    )
+```
+
+### Verifying the Execution
+
+<!-- termynal -->
+
+```shell
+> uipath run main.py
+```
+
+Open your browser and navigate to UiPath. Go to the specified folder, where you'll see a new job for `test` has been executed. The output will be:
+
+```
+[Echo]: Hello, World! Echo: Hello, World! Echo: Hello, World!
+```

uipath-2.0.33/docs/core/index.md

@@ -0,0 +1,7 @@
+---
+title: Introduction
+---
+
+--8<--
+README.md
+--8<--

uipath-2.0.33/docs/hooks.py

@@ -0,0 +1,13 @@
+import os
+import shutil
+
+
+def redirect_index(*args, **kwargs):
+    if not os.path.exists("docs/quick_start_images"):
+        shutil.copy(
+            "docs/plugins/uipath-langchain-python/docs/quick_start.md", "docs/index.md"
+        )
+        shutil.copytree(
+            "docs/plugins/uipath-langchain-python/docs/quick_start_images",
+            "docs/quick_start_images",
+        )

uipath-2.0.33/docs/langchain/chat_models.md

@@ -0,0 +1,3 @@
+--8<--
+docs/plugins/uipath-langchain-python/docs/chat_models.md
+--8<--

uipath-2.0.33/docs/langchain/context_grounding.md

@@ -0,0 +1,9 @@
+---
+title: Content Grounding
+---
+
+--8<--
+docs/plugins/uipath-langchain-python/docs/context_grounding.md
+--8<--
+
+

uipath-2.0.33/docs/langchain/human_in_the_loop.md

@@ -0,0 +1,3 @@
+--8<--
+docs/plugins/uipath-langchain-python/docs/human_in_the_loop.md
+--8<--

uipath-2.0.33/docs/langchain/index.md

@@ -0,0 +1,7 @@
+---
+title: Introduction
+---
+
+--8<--
+docs/plugins/uipath-langchain-python/README.md
+--8<--

uipath-2.0.33/docs/stylesheets/extra.css

@@ -0,0 +1,83 @@
+.md-header {
+    .md-header__title {
+        .md-header__topic:first-child {
+            display: none;
+        }
+    }
+}
+
+
+:root {
+    --md-primary-bg-color: #ffffff;
+    --md-primary-fg-color: #182027;
+    --md-typeset-a-color: #66adff;
+}
+
+
+[data-md-color-scheme=default]
+ {
+    --md-typeset-a-color: #0067df;
+}
+
+[data-md-color-scheme=slate] {
+    --md-typeset-a-color: #66adff;
+
+    .md-header {
+        background-color: #182027;
+        color: #ffffff;
+    }
+}
+
+body[data-md-color-scheme=slate] {
+    background-color: #182027 !important;
+}
+
+.md-header {
+    --md-primary-bg-color: #182027;
+    --md-primary-fg-color: #ffffff;
+}
+
+
+
+@media screen and (min-width: 60em) {
+    .md-search__form {
+        background-color: #ffffff;
+        color: #182027 !important;
+        border: 1px solid #182027;
+
+        &:hover {
+            background-color: #ffffff;
+            border-color: #66adff;
+        }
+    }
+
+    [data-md-color-scheme=slate] {
+        .md-search__form {
+            background-color: #182027;
+            color: #ffffff !important;
+            border: 1px solid #ffffff;
+
+            &:hover {
+                background-color: #182027;
+                border-color: #66adff;
+            }
+        }
+
+        .md-search__icon {
+            color: #ffffff !important;
+        }
+    }
+
+    .md-search__icon {
+        color: #182027 !important;
+    }
+}
+
+
+@media (min-width: 1220px) {
+    .md-sidebar {
+        .md-nav__title {
+            display: none;
+        }
+    }
+}

uipath-2.0.33/mkdocs.yml

@@ -0,0 +1,106 @@
+site_name: UiPath SDK
+site_url: https://uipath.github.io/uipath-python/
+
+repo_name: UiPath/uipath-python
+repo_url: https://github.com/UiPath/uipath-python
+
+copyright: Copyright © 2025 UiPath
+
+extra_css:
+  - stylesheets/extra.css
+
+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
+  icon:
+    repo: fontawesome/brands/github
+  features:
+    - content.code.copy
+    - content.footnote.tooltips
+    - content.tabs.link
+    - content.tooltips
+    - navigation.expand
+    - navigation.footer
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.sections
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+  logo: assets/uipath-logo.svg
+
+nav:
+  - UiPath Langchain SDK:
+      - langchain/index.md
+      - Getting Started: index.md
+      - Chat Models: langchain/chat_models.md
+      - Context Grounding: langchain/context_grounding.md
+      - Human In The Loop: langchain/human_in_the_loop.md
+  - UiPath SDK:
+      - core/index.md
+      - Getting Started: core/getting_started.md
+      - Services:
+        - Actions: core/actions.md
+        - Assets: core/assets.md
+        - Buckets: core/buckets.md
+        - Context Grounding: core/context_grounding.md
+        - Jobs: core/jobs.md
+        - Queues: core/queues.md
+        - Processes: core/processes.md
+  - How To Contribute: CONTRIBUTING.md
+
+plugins:
+  - search
+  - mkdocstrings
+  - mkdocs-simple-hooks:
+      hooks:
+        on_pre_build: "docs.hooks:redirect_index"
+  - termynal:
+      prompt_literal_start:
+        - "$"
+        - ">"
+
+markdown_extensions:
+  - attr_list
+  - md_in_html
+  - admonition
+  - pymdownx.blocks.tab:
+      alternate_style: true
+  - pymdownx.blocks.admonition:
+      types:
+        - note
+        - attention
+        - caution
+        - danger
+        - error
+        - tip
+        - hint
+        - warning
+        - info
+        - check
+  - pymdownx.details
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.superfences
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.magiclink
+  - pymdownx.snippets
+  - pymdownx.tabbed:
+      alternate_style: true

{uipath-2.0.31 → uipath-2.0.33}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.31"
+version = "2.0.33"
 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"
@@ -56,6 +56,8 @@ dev = [
   "mkdocs-material>=9.6.7",
   "mkdocstrings>=0.29.0",
   "mkdocstrings-python>=1.16.5",
+  "termynal>=0.13.0",
+  "mkdocs-simple-hooks>=0.1.5",
 ]
 
 [project.optional-dependencies]
@@ -80,6 +82,7 @@ ignore-decorators = []
 "*" = ["E501"]
 "tests/**" = ["D"]
 "*_test.py" = ["D"]
+"docs/**" = ["D"]
 # TODO: Remove this once the documentation for CLI is updated
 "uipath/_cli/**" = ["D"]
 # TODO: Remove this once model documentation is added

{uipath-2.0.31 → uipath-2.0.33}/src/uipath/_cli/_auth/_portal_service.py

@@ -145,19 +145,16 @@ class PortalService:
         url_try_enable_first_run = f"{or_base_url}/api/StudioWeb/TryEnableFirstRun"
         url_acquire_license = f"{or_base_url}/api/StudioWeb/AcquireLicense"
 
-        [try_enable_first_run_response, acquire_license_response] = [
-            requests.post(
-                url,
-                headers={"Authorization": f"Bearer {self.access_token}"},
-            )
-            for url in [url_try_enable_first_run, url_acquire_license]
-        ]
-
-        if (
-            try_enable_first_run_response.status_code != 200
-            or acquire_license_response.status_code != 200
-        ):
-            raise Exception("Failed to post auth")
+        try:
+            [try_enable_first_run_response, acquire_license_response] = [
+                requests.post(
+                    url,
+                    headers={"Authorization": f"Bearer {self.access_token}"},
+                )
+                for url in [url_try_enable_first_run, url_acquire_license]
+            ]
+        except Exception:
+            pass
 
     def has_initialized_auth(self):
         try:

{uipath-2.0.31 → uipath-2.0.33}/src/uipath/_cli/_runtime/_contracts.py

@@ -412,7 +412,7 @@ class UiPathBaseRuntime(ABC):
             raise
         finally:
             # Restore original logging
-            if self.context.job_id and self.logs_interceptor:
+            if self.logs_interceptor:
                 self.logs_interceptor.teardown()
 
             await self.cleanup()