uipath 1.0.0__tar.gz → 2.0.0__tar.gz

uipath-2.0.0/.gitignore

@@ -0,0 +1,19 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+**/.env
+**/uipath.db
+**/.uipath
+**/**.nupkg
+**/uipath.json
+**/__uipath/
+
+**/playground.py
+**/.idea

uipath-2.0.0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: uipath
+Version: 2.0.0
+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
+Maintainer-email: Marius Cosareanu <marius.cosareanu@uipath.com>, Cristian Pufu <cristian.pufu@uipath.com>
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.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: click>=8.1.8
+Requires-Dist: httpx>=0.28.1
+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: tenacity>=9.0.0
+Requires-Dist: tomli>=2.2.1
+Requires-Dist: types-requests>=2.32.0.20250306
+Provides-Extra: langchain
+Requires-Dist: uipath-langchain==0.0.85; extra == 'langchain'
+Description-Content-Type: text/markdown
+
+# UiPath Python SDK
+
+[![PyPI downloads](https://img.shields.io/pypi/dm/uipath.svg)](https://pypi.org/project/uipath/)
+[![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.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+  - [Environment Variables](#environment-variables)
+- [Basic Usage](#basic-usage)
+- [Available Services](#available-services)
+- [Examples](#examples)
+  - [Buckets Service](#buckets-service)
+  - [Context Grounding Service](#context-grounding-service)
+- [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Authentication](#authentication)
+  - [Initialize a Project](#initialize-a-project)
+  - [Debug a Project](#debug-a-project)
+  - [Package a Project](#package-a-project)
+  - [Publish a Package](#publish-a-package)
+- [Project Structure](#project-structure)
+- [Development](#development)
+  - [Setting Up a Development Environment](#setting-up-a-development-environment)
+
+## Installation
+
+```bash
+pip install uipath
+```
+
+using `uv`:
+
+```bash
+uv add uipath
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file in your project root with the following variables:
+
+```
+UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME
+UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE
+```
+
+## Basic Usage
+
+```python
+from uipath import UiPath
+# Initialize the SDK
+sdk = UiPath()
+# Execute a process
+job = sdk.processes.invoke(
+    name="MyProcess",
+    input_arguments={"param1": "value1", "param2": 42}
+)
+# Work with assets
+asset = sdk.assets.retrieve(name="MyAsset")
+```
+
+## Available Services
+
+The SDK provides access to various UiPath services:
+- `sdk.processes` - Manage and execute UiPath automation processes
+- `sdk.assets` - Work with assets (variables, credentials) stored in UiPath
+- `sdk.buckets` - Manage cloud storage containers for automation files
+- `sdk.connections` - Handle connections to external systems
+- `sdk.context_grounding` - Work with semantic contexts for AI-enabled automation
+- `sdk.jobs` - Monitor and manage automation jobs
+- `sdk.queues` - Work with transaction queues
+- `sdk.actions` - Work with Action Center
+- `sdk.api_client` - Direct access to the API client for custom requests
+
+## Examples
+
+### Buckets Service
+
+```python
+# Download a file from a bucket
+sdk.buckets.download(
+    bucket_key="my-bucket",
+    blob_file_path="path/to/file.xlsx",
+    destination_path="local/path/file.xlsx"
+)
+```
+
+### Context Grounding Service
+
+```python
+# Search for contextual information
+results = sdk.context_grounding.search(
+    name="my-knowledge-index",
+    query="How do I process an invoice?",
+    number_of_results=5
+)
+```
+
+## Command Line Interface (CLI)
+
+The SDK also provides a command-line interface for creating, packaging, and deploying automations:
+
+### Authentication
+
+```bash
+uipath auth
+```
+
+This command opens a browser for authentication and creates/updates your `.env` file with the proper credentials.
+
+### Initialize a Project
+
+```bash
+uipath init [ENTRYPOINT]
+```
+
+Creates a `uipath.json` configuration file for your project. If the entrypoint is not provided, it will try to find a single Python file in the current directory.
+
+### Debug a Project
+
+```bash
+uipath run ENTRYPOINT [INPUT]
+```
+
+Executes a Python script with the provided JSON input arguments.
+
+### Package a Project
+
+```bash
+uipath pack
+```
+
+Packages your project into a `.nupkg` file that can be deployed to UiPath.
+
+**Note:** 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"}]
+```
+
+### Publish a Package
+
+```bash
+uipath publish
+```
+
+Publishes the most recently created package to your UiPath Orchestrator.
+
+## Project Structure
+
+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
+
+ ## Development
+
+ ### Setting Up a Development Environment
+
+ Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.

uipath-2.0.0/README.md

@@ -0,0 +1,170 @@
+# UiPath Python SDK
+
+[![PyPI downloads](https://img.shields.io/pypi/dm/uipath.svg)](https://pypi.org/project/uipath/)
+[![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.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Configuration](#configuration)
+  - [Environment Variables](#environment-variables)
+- [Basic Usage](#basic-usage)
+- [Available Services](#available-services)
+- [Examples](#examples)
+  - [Buckets Service](#buckets-service)
+  - [Context Grounding Service](#context-grounding-service)
+- [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Authentication](#authentication)
+  - [Initialize a Project](#initialize-a-project)
+  - [Debug a Project](#debug-a-project)
+  - [Package a Project](#package-a-project)
+  - [Publish a Package](#publish-a-package)
+- [Project Structure](#project-structure)
+- [Development](#development)
+  - [Setting Up a Development Environment](#setting-up-a-development-environment)
+
+## Installation
+
+```bash
+pip install uipath
+```
+
+using `uv`:
+
+```bash
+uv add uipath
+```
+
+## Configuration
+
+### Environment Variables
+
+Create a `.env` file in your project root with the following variables:
+
+```
+UIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME
+UIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE
+```
+
+## Basic Usage
+
+```python
+from uipath import UiPath
+# Initialize the SDK
+sdk = UiPath()
+# Execute a process
+job = sdk.processes.invoke(
+    name="MyProcess",
+    input_arguments={"param1": "value1", "param2": 42}
+)
+# Work with assets
+asset = sdk.assets.retrieve(name="MyAsset")
+```
+
+## Available Services
+
+The SDK provides access to various UiPath services:
+- `sdk.processes` - Manage and execute UiPath automation processes
+- `sdk.assets` - Work with assets (variables, credentials) stored in UiPath
+- `sdk.buckets` - Manage cloud storage containers for automation files
+- `sdk.connections` - Handle connections to external systems
+- `sdk.context_grounding` - Work with semantic contexts for AI-enabled automation
+- `sdk.jobs` - Monitor and manage automation jobs
+- `sdk.queues` - Work with transaction queues
+- `sdk.actions` - Work with Action Center
+- `sdk.api_client` - Direct access to the API client for custom requests
+
+## Examples
+
+### Buckets Service
+
+```python
+# Download a file from a bucket
+sdk.buckets.download(
+    bucket_key="my-bucket",
+    blob_file_path="path/to/file.xlsx",
+    destination_path="local/path/file.xlsx"
+)
+```
+
+### Context Grounding Service
+
+```python
+# Search for contextual information
+results = sdk.context_grounding.search(
+    name="my-knowledge-index",
+    query="How do I process an invoice?",
+    number_of_results=5
+)
+```
+
+## Command Line Interface (CLI)
+
+The SDK also provides a command-line interface for creating, packaging, and deploying automations:
+
+### Authentication
+
+```bash
+uipath auth
+```
+
+This command opens a browser for authentication and creates/updates your `.env` file with the proper credentials.
+
+### Initialize a Project
+
+```bash
+uipath init [ENTRYPOINT]
+```
+
+Creates a `uipath.json` configuration file for your project. If the entrypoint is not provided, it will try to find a single Python file in the current directory.
+
+### Debug a Project
+
+```bash
+uipath run ENTRYPOINT [INPUT]
+```
+
+Executes a Python script with the provided JSON input arguments.
+
+### Package a Project
+
+```bash
+uipath pack
+```
+
+Packages your project into a `.nupkg` file that can be deployed to UiPath.
+
+**Note:** 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"}]
+```
+
+### Publish a Package
+
+```bash
+uipath publish
+```
+
+Publishes the most recently created package to your UiPath Orchestrator.
+
+## Project Structure
+
+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
+
+ ## Development
+
+ ### Setting Up a Development Environment
+
+ Please read our [contribution guidelines](CONTRIBUTING.md) before submitting a pull request.

uipath-2.0.0/pyproject.toml

@@ -0,0 +1,112 @@
+[project]
+name = "uipath"
+version = "2.0.0"
+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",
+  "pydantic>=2.11.1",
+  "pytest-asyncio>=0.25.3",
+  "python-dotenv>=1.0.1",
+  "requests>=2.32.3",
+  "tenacity>=9.0.0",
+  "tomli>=2.2.1",
+  "types-requests>=2.32.0.20250306",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Build Tools",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+maintainers = [
+  { name = "Marius Cosareanu", email = "marius.cosareanu@uipath.com" },
+  { name = "Cristian Pufu", email = "cristian.pufu@uipath.com" },
+]
+
+[project.urls]
+Homepage = "https://uipath.com"
+Repository = "https://github.com/UiPath/uipath-python"
+
+[project.scripts]
+uipath = "uipath._cli:cli"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/uipath"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/uipath"]
+
+[dependency-groups]
+dev = [
+  "bandit>=1.8.2",
+  "mypy>=1.14.1",
+  "ruff>=0.9.4",
+  "rust-just>=1.39.0",
+  "pytest>=7.4.0",
+  "pytest-cov>=4.1.0",
+  "pytest-mock>=3.11.1",
+  "pre-commit>=4.1.0",
+  "mkdocs>=1.6.1",
+  "mkdocs-material>=9.6.7",
+  "mkdocstrings>=0.29.0",
+  "mkdocstrings-python>=1.16.5",
+]
+
+[project.optional-dependencies]
+langchain = ["uipath-langchain==0.0.85"]
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+
+[tool.ruff.lint]
+select = ["E", "F", "B", "I", "D"]
+ignore = ["D417"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+ignore-decorators = []
+
+[tool.ruff.lint.per-file-ignores]
+"*" = ["E501"]
+"tests/**" = ["D"]
+"*_test.py" = ["D"]
+# TODO: Remove this once the documentation for CLI is updated
+"uipath/_cli/**" = ["D"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+follow_imports = "silent"
+warn_redundant_casts = true
+warn_unused_ignores = true
+disallow_any_generics = true
+check_untyped_defs = true
+no_implicit_reexport = true
+
+disallow_untyped_defs = false
+
+[tool.pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+addopts = "-ra -q"

uipath-2.0.0/uipath/__init__.py

@@ -0,0 +1,24 @@
+"""UiPath SDK for Python.
+
+This package provides a Python interface to interact with UiPath's automation platform.
+
+
+The main entry point is the UiPath class, which provides access to all SDK functionality.
+
+Example:
+```python
+    # First set these environment variables:
+    # export UIPATH_URL="https://cloud.uipath.com/organization-name/default-tenant"
+    # export UIPATH_ACCESS_TOKEN="your_**_token"
+    # export UIPATH_FOLDER_PATH="your/folder/path"
+
+    from uipath import UiPath
+    sdk = UiPath()
+    # Invoke a process by name
+    sdk.processes.invoke("MyProcess")
+```
+"""
+
+from ._uipath import UiPath
+
+__all__ = ["UiPath"]

uipath-2.0.0/uipath/_cli/README.md

@@ -0,0 +1,11 @@
+# parse
+
+`parse-ast.py` will extract names and types of resources to prepare for bindings. currently it's hardcoded to run on `dummy-main.py`
+
+# init
+
+asks for project name, type (process/agent) description and target directory where to init the project. it inits a script, a requirements.txt for the user to install, and a config.json file that we'll use at packing time.
+
+# pack
+
+asks for target directory of the package files and the version and will create a nupkg file

uipath-2.0.0/uipath/_cli/__init__.py

@@ -0,0 +1,54 @@
+import importlib.metadata
+import sys
+
+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_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
+
+
+@click.group(invoke_without_command=True)
+@click.version_option(
+    importlib.metadata.version("uipath"),
+    prog_name="uipath",
+    message="%(prog)s version %(version)s",
+)
+@click.option(
+    "-lv",
+    is_flag=True,
+    help="Display the current version of uipath-langchain.",
+)
+@click.option(
+    "-v",
+    is_flag=True,
+    help="Display the current version of uipath.",
+)
+def cli(lv: bool, v: bool) -> None:
+    if lv:
+        try:
+            version = importlib.metadata.version("uipath-langchain")
+            click.echo(f"uipath-langchain version {version}")
+        except importlib.metadata.PackageNotFoundError:
+            click.echo("uipath-langchain is not installed", err=True)
+            sys.exit(1)
+    if v:
+        try:
+            version = importlib.metadata.version("uipath")
+            click.echo(f"uipath version {version}")
+        except importlib.metadata.PackageNotFoundError:
+            click.echo("uipath is not installed", err=True)
+            sys.exit(1)
+
+
+cli.add_command(new)
+cli.add_command(init)
+cli.add_command(pack)
+cli.add_command(publish)
+cli.add_command(run)
+cli.add_command(deploy)
+cli.add_command(auth)