uipath 2.0.33__tar.gz → 2.0.35__tar.gz

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

@@ -46,20 +46,3 @@ jobs:
           uv publish
         env:
           UV_PUBLISH_TOKEN: ${{ secrets.token }}
-
-      - name: Clone plugins
-        if: ${{ steps.check_version.outputs.modified }} == 'true'
-        run: |
-          git clone https://x-access-token:${{ secrets.repo_access }}@github.com/UiPath/uipath-langchain-python plugins/uipath-langchain-python
-
-      - name: Symlink plugin docs
-        if: ${{ steps.check_version.outputs.modified }} == 'true'
-        run: |
-          mkdir -p docs/plugins
-          ln -s ../../plugins/uipath-langchain-python docs/plugins/uipath-langchain-python
-
-      - name: Publish Docs
-        if: ${{ steps.check_version.outputs.modified }} == 'true'
-        run: |
-          ls -la docs
-          uv run mkdocs gh-deploy --force

uipath-2.0.35/.github/workflows/publish-docs.yml

@@ -0,0 +1,38 @@
+name: Publish Docs
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-docs:
+    runs-on: "ubuntu-24.04"
+
+    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: Clone plugins
+        run: |
+          git clone https://x-access-token:${{ secrets.REPO_ACCESS }}@github.com/UiPath/uipath-langchain-python plugins/uipath-langchain-python
+
+      - name: Symlink plugin docs
+        run: |
+          mkdir -p docs/plugins
+          ln -s ../../plugins/uipath-langchain-python docs/plugins/uipath-langchain-python
+
+      - name: Publish Docs
+        run: |
+          ls -la docs
+          uv run mkdocs gh-deploy --force

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

@@ -23,3 +23,6 @@ wheels/
 **/docs/plugins/.*
 **/docs/quick_start_images/*
 **/docs/quick_start_images/.*
+
+.cache/*
+.cache

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.33
+Version: 2.0.35
 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.35/docs/cli/index.md

@@ -0,0 +1,165 @@
+# CLI Reference
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: auth
+    :depth: 1
+    :style: table
+
+<!-- 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.
+```
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: init
+    :depth: 1
+    :style: table
+
+/// warning
+
+The `uipath init` command executes your `main.py` file to analyze its structure and collect information about inputs and outputs.
+///
+
+<!-- termynal -->
+```shell
+> uipath init
+⠋ Initializing UiPath project ...
+✓  Created 'uipath.json' file.
+```
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: run
+    :depth: 1
+    :style: table
+
+/// warning
+Depending on the shell you are using, it may be necessary to escape the input json:
+
+/// tab | Bash/ZSH
+```console
+uipath run agent '{"topic": "UiPath"}'
+```
+///
+
+/// tab | Windows CMD
+```console
+uipath run agent "{""topic"": ""UiPath""}"
+```
+///
+
+/// tab | Windows PowerShell
+```console
+uipath run agent '{\"topic\":\"uipath\"}'
+```
+///
+
+///
+
+<!-- termynal -->
+
+```shell
+> uipath run main.py '{"message": "test"}'
+[2025-04-11 10:13:58,857][INFO] {'message': 'test'}
+```
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: pack
+    :depth: 1
+    :style: table
+
+Packages your project into a `.nupkg` file that can be deployed to UiPath.
+
+/// warning
+Your `pyproject.toml` must include:
+
+-   A description field (avoid characters: &, <, >, ", ', ;)
+-   Author information
+
+Example:
+
+```toml
+description = "Your package description"
+authors = [{name = "Your Name", email = "your.email@example.com"}]
+```
+///
+
+<!-- termynal -->
+```shell
+> uipath pack
+⠋ Packaging project ...
+Name       : test
+Version    : 0.1.0
+Description: Add your description here
+Authors    : Your Name
+✓  Project successfully packaged.
+```
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: publish
+    :depth: 1
+    :style: table
+
+/// warning
+To properly use the CLI for packaging and publishing, your project should include:
+
+-   A `pyproject.toml` file with project metadata
+-   A `uipath.json` file (generated by `uipath init`)
+-   Any Python files needed for your automation
+///
+
+<!-- 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!
+```
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: deploy
+    :depth: 1
+    :style: table
+
+---
+
+::: mkdocs-click
+    :module: uipath._cli
+    :command: invoke
+    :depth: 1
+    :style: table
+
+<!-- termynal -->
+
+```shell
+> uipath invoke agent '{"topic": "UiPath"}'
+⠴ Loading configuration ...
+⠴ Starting job ...
+✨ Job started successfully!
+🔗 Monitor your job here: [LINK]
+```

{uipath-2.0.33 → uipath-2.0.35}/docs/core/getting_started.md

@@ -153,8 +153,7 @@ To create a UiPath project, run the following command in your terminal:
 ✓  Created 'uipath.json' file.
 ```
 
-/// admonition
-    type: warning
+/// warning
 
 The `uipath init` command executes your `main.py` file to analyze its structure and collect information about inputs and outputs.
 ///

uipath-2.0.35/docs/javascripts/extra.js

@@ -0,0 +1,35 @@
+function updateThemePictures() {
+    const body = document.body;
+    const mediaAttr = body.getAttribute("data-md-color-media") || "";
+    const isDark = mediaAttr.includes("dark");
+
+    const pictures = document.querySelectorAll("picture");
+
+    pictures.forEach((picture) => {
+        const darkSrc = picture.getAttribute("data-dark");
+        const lightSrc = picture.getAttribute("data-light");
+
+        const source = picture.querySelector("source");
+        const img = picture.querySelector("img");
+
+        if (isDark) {
+            source.media = "all";
+            source.srcset = darkSrc;
+            img.src = darkSrc;
+        } else {
+            source.media = "not all";
+            source.srcset = lightSrc;
+            img.src = lightSrc;
+        }
+    });
+}
+
+// Run on load
+updateThemePictures();
+
+// Watch for changes to the theme
+const observer = new MutationObserver(updateThemePictures);
+observer.observe(document.body, {
+    attributes: true,
+    attributeFilter: ["data-md-color-media"],
+});

uipath-2.0.35/docs/release_policy.md

@@ -0,0 +1,124 @@
+# Release Policy
+
+The UiPath Python ecosystem is composed of different component packages:
+
+- `uipath`: The core SDK package (version >= 2.0.0)
+- `uipath-langchain`: The LangChain integration package (version >= 0.0.0)
+
+Both packages are under rapid development, following semantic versioning in the format of **X.Y.Z**:
+
+- **X** (major version):
+    - `uipath`: X = 2
+    - `uipath-langchain`: X = 0
+- **Y** (minor version) increases indicate breaking changes for public interfaces not marked as beta
+- **Z** (patch version) increases indicate:
+    - Bug fixes
+    - New features
+    - Changes to private interfaces
+    - Changes to beta features
+
+### Version Number Format
+
+The version format is `X.Y.Z` where:
+
+- For `uipath`: X = 2 (e.g., 2.0.0, 2.1.0)
+- For `uipath-langchain`: X = 0 (e.g., 0.0.0, 0.1.0)
+- Y represents the minor version
+- Z represents the patch version
+
+### Release Candidates
+
+From time to time, we will version packages as release candidates. These are versions that are intended to be released as stable versions, but we want to get feedback from the community before doing so.
+
+Release candidates are versioned as `X.Y.ZrcN`. For example:
+
+- `uipath`: `2.2.0rc1`
+- `uipath-langchain`: `0.1.0rc1`
+
+If no issues are found, the release candidate will be released as a stable version with the same version number. If issues are found, we will release a new release candidate with an incremented N value (e.g., `2.2.0rc2` or `0.1.0rc2`).
+
+When upgrading between minor versions, users should review the list of breaking changes and deprecations.
+
+## Release Cadence
+
+### Minor Releases (X.Y.0)
+
+- Released as needed based on feature development and breaking changes
+- Include breaking changes for public interfaces not marked as beta
+- Require a migration guide for users
+- Preceded by a release candidate (RC) phase
+
+### Patch Releases (X.Y.Z)
+
+- Released as needed based on bug fixes and improvements
+- Include bug fixes, new features, and changes to private interfaces
+- Always maintain backward compatibility for public interfaces
+
+## API Stability
+
+### Public API
+The following components are considered part of the public API:
+
+- All classes and methods in the `src/uipath` directory
+- CLI commands and their interfaces
+
+### Internal API
+Components marked as internal include:
+
+- Methods and classes prefixed with `_`
+- Test utilities and fixtures
+- Build and development tools
+
+## Breaking Changes
+
+Breaking changes are introduced in minor releases (X.Y.0) and follow these guidelines:
+
+1. **Deprecation Period**: Features marked for removal will be deprecated for at least one minor release cycle
+2. **Migration Path**: Breaking changes must provide a clear migration path
+3. **Documentation**: All breaking changes must be documented in the release notes and migration guide
+4. **Beta Features**: Breaking changes to beta features can occur in patch releases
+
+## Deprecation Policy
+
+1. **Announcement**: Features to be deprecated will be announced in release notes
+2. **Warning Period**: Deprecated features will trigger warnings when used
+3. **Removal**: Deprecated features will be removed in the next major release
+
+## Release Process
+
+1. **Development**:
+    - Features and fixes are developed in feature branches
+    - All changes require tests and documentation
+    - Code must pass all CI checks
+
+2. **Release Candidate**:
+    - Minor releases include an RC phase
+    - RCs are versioned as `X.Y.ZrcN`
+    - Community feedback is collected during RC phase
+
+3. **Release**:
+    - Version number is updated in `pyproject.toml`
+    - Release notes are prepared
+    - Package is published to PyPI
+    - Documentation is updated
+
+## Support Policy
+
+- Current major version: Full support
+- Previous major version: Security fixes only
+- Older versions: No official support
+
+## Dependencies
+
+The SDK maintains compatibility with:
+
+- Python 3.10+
+- Key dependencies as specified in `pyproject.toml`
+- Regular updates to dependencies are performed in minor releases
+
+## Documentation
+
+- All public APIs must be documented
+- Documentation follows Google-style docstrings
+- Examples and usage guides are provided for new features
+- Breaking changes are clearly documented in migration guides

{uipath-2.0.33 → uipath-2.0.35}/docs/stylesheets/extra.css

@@ -80,4 +80,4 @@ body[data-md-color-scheme=slate] {
             display: none;
         }
     }
-}
+}

{uipath-2.0.33 → uipath-2.0.35}/mkdocs.yml

@@ -9,6 +9,9 @@ copyright: Copyright © 2025 UiPath
 extra_css:
   - stylesheets/extra.css
 
+extra_javascript:
+  - javascripts/extra.js
+
 theme:
   name: material
   palette:
@@ -35,25 +38,24 @@ theme:
     - 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
+  favicon: assets/favicon.png
 
 nav:
   - UiPath Langchain SDK:
-      - langchain/index.md
       - Getting Started: index.md
+      - Sample agents: https://github.com/UiPath/uipath-langchain-python/tree/main/samples
       - 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
+      - CLI Reference: cli/index.md
       - Services:
         - Actions: core/actions.md
         - Assets: core/assets.md
@@ -63,6 +65,7 @@ nav:
         - Queues: core/queues.md
         - Processes: core/processes.md
   - How To Contribute: CONTRIBUTING.md
+  - Release Policy: release_policy.md
 
 plugins:
   - search
@@ -74,11 +77,12 @@ plugins:
       prompt_literal_start:
         - "$"
         - ">"
-
+  - social
 markdown_extensions:
   - attr_list
   - md_in_html
   - admonition
+  - mkdocs-click
   - pymdownx.blocks.tab:
       alternate_style: true
   - pymdownx.blocks.admonition:
@@ -102,5 +106,8 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.magiclink
   - pymdownx.snippets
+  - pymdownx.fancylists
   - pymdownx.tabbed:
       alternate_style: true
+  - toc:
+      title: On this page

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

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.33"
+version = "2.0.35"
 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"
@@ -53,11 +53,12 @@ dev = [
   "pytest-mock>=3.11.1",
   "pre-commit>=4.1.0",
   "mkdocs>=1.6.1",
-  "mkdocs-material>=9.6.7",
+  "mkdocs-material[imaging]>=9.6.7",
   "mkdocstrings>=0.29.0",
   "mkdocstrings-python>=1.16.5",
   "termynal>=0.13.0",
   "mkdocs-simple-hooks>=0.1.5",
+  "mkdocs-click>=0.9.0",
 ]
 
 [project.optional-dependencies]

{uipath-2.0.33 → uipath-2.0.35}/src/uipath/_cli/_utils/_processes.py

@@ -30,7 +30,7 @@ def get_release_info(
             return None, None
         except IndexError:
             console.error(
-                "Error: No process found in your workspace. Please publish the process first."
+                f"Error: No process with name '{package_name}' found in your workspace. Please publish the process first."
             )
             return None, None
     else:

{uipath-2.0.33 → uipath-2.0.35}/src/uipath/_cli/cli_init.py

@@ -20,10 +20,9 @@ def generate_env_file(target_directory):
 
     if not os.path.exists(env_path):
         relative_path = os.path.relpath(env_path, target_directory)
+        with open(env_path, "w"):
+            pass
         console.success(f" Created '{relative_path}' file.")
-        with open(env_path, "w") as f:
-            f.write("UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE\n")
-            f.write("UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME\n")
 
 
 def get_user_script(directory: str, entrypoint: Optional[str] = None) -> Optional[str]:

{uipath-2.0.33 → uipath-2.0.35}/src/uipath/_cli/cli_invoke.py

@@ -43,7 +43,7 @@ def _read_project_name() -> str:
 @click.argument("entrypoint", required=False)
 @click.argument("input", required=False, default="{}")
 def invoke(entrypoint: Optional[str], input: Optional[str]) -> None:
-    """Invoke a published agent."""
+    """Invoke an agent published in my workspace."""
     with console.spinner("Loading configuration ..."):
         current_path = os.getcwd()
         load_dotenv(os.path.join(current_path, ".env"), override=True)

{uipath-2.0.33 → uipath-2.0.35}/src/uipath/_cli/cli_new.py

@@ -68,9 +68,8 @@ def new(name: str):
         ctx = click.get_current_context()
         init_cmd = ctx.parent.command.get_command(ctx, "init")
         ctx.invoke(init_cmd)
-        console.hint(
-            """Run project: uipath run main.py '{"message": "Hello World!"}'"""
-        )
+        run_command = """uipath run main.py '{"message": "Hello World!"}'"""
+        console.hint(f"""Run project: {click.style(run_command, fg="cyan")}""")
 
 
 if __name__ == "__main__":

{uipath-2.0.33 → uipath-2.0.35}/src/uipath/_cli/cli_run.py

@@ -1,6 +1,5 @@
 # type: ignore
 import asyncio
-import logging
 import os
 import traceback
 from os import environ as env
@@ -16,9 +15,10 @@ from ._runtime._contracts import (
     UiPathTraceContext,
 )
 from ._runtime._runtime import UiPathRuntime
+from ._utils._console import ConsoleLogger
 from .middlewares import MiddlewareResult, Middlewares
 
-logger = logging.getLogger(__name__)
+console = ConsoleLogger()
 load_dotenv()
 
 
@@ -39,14 +39,14 @@ def python_run_middleware(
         return MiddlewareResult(
             should_continue=False,
             info_message="""Error: No entrypoint specified. Please provide a path to a Python script.
-Usage: `uipath run <entrypoint_path> <input_arguments>`""",
+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}.
-Usage: `uipath run <entrypoint_path> <input_arguments>`""",
+Usage: `uipath run <entrypoint_path> <input_arguments> [-f <input_json_file_path>]`""",
         )
 
     try:
@@ -74,7 +74,6 @@ Usage: `uipath run <entrypoint_path> <input_arguments>`""",
                 reference_id=env.get("UIPATH_JOB_KEY") or str(uuid4()),
             )
             context.logs_min_level = env.get("LOG_LEVEL", "INFO")
-
             async with UiPathRuntime.from_context(context) as runtime:
                 await runtime.execute()
 
@@ -91,7 +90,6 @@ Usage: `uipath run <entrypoint_path> <input_arguments>`""",
         )
     except Exception as e:
         # Handle unexpected errors
-        logger.exception("Unexpected error in Python runtime middleware")
         return MiddlewareResult(
             should_continue=False,
             error_message=f"Error: Unexpected error occurred - {str(e)}",
@@ -103,8 +101,23 @@ Usage: `uipath run <entrypoint_path> <input_arguments>`""",
 @click.argument("entrypoint", required=False)
 @click.argument("input", required=False, default="{}")
 @click.option("--resume", is_flag=True, help="Resume execution from a previous state")
-def run(entrypoint: Optional[str], input: Optional[str], resume: bool) -> None:
+@click.option(
+    "-f",
+    "--file",
+    required=False,
+    type=click.Path(exists=True),
+    help="File path for the .json input",
+)
+def run(
+    entrypoint: Optional[str], input: Optional[str], resume: bool, file: Optional[str]
+) -> None:
     """Execute the project."""
+    if file:
+        _, file_extension = os.path.splitext(file)
+        if file_extension != ".json":
+            console.error("Input file extension must be '.json'.")
+        with open(file) as f:
+            input = f.read()
     # Process through middleware chain
     result = Middlewares.next("run", entrypoint, input, resume)
 
@@ -115,18 +128,22 @@ def run(entrypoint: Optional[str], input: Optional[str], resume: bool) -> None:
 
     # Handle result from middleware
     if result.error_message:
-        click.echo(result.error_message, err=True)
+        console.error(result.error_message, include_traceback=True)
         if result.should_include_stacktrace:
-            click.echo(traceback.format_exc(), err=True)
+            console.error(traceback.format_exc())
         click.get_current_context().exit(1)
 
     if result.info_message:
-        click.echo(result.info_message)
+        console.info(result.info_message)
 
     # If middleware chain completed but didn't handle the request
     if result.should_continue:
-        click.echo("Error: Could not process the request with any available handler.")
-        click.get_current_context().exit(1)
+        console.error(
+            "Error: Could not process the request with any available handler."
+        )
+
+    if not result.should_continue and not result.error_message:
+        console.success("Successful execution.")
 
 
 if __name__ == "__main__":

{uipath-2.0.33 → uipath-2.0.35}/tests/cli/test_init.py

@@ -19,14 +19,7 @@ def test_init_env_file_creation(runner: CliRunner, temp_dir: str) -> None:
         assert result.exit_code == 0
         assert "Created '.env' file" in result.output
 
-        # Use relative path instead of temp_dir
-        with open(".env", "r") as f:
-            content = f.read()
-            assert "UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE" in content
-            assert (
-                "UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME"
-                in content
-            )
+        assert os.path.exists(".env")
 
         # Test existing .env isn't overwritten
         original_content = "EXISTING=CONFIG"