| Name | uipath JSON |
| Version |
2.0.76
JSON |
| download |
| home_page | None |
| Summary | Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools. |
| upload_time | 2025-07-09 11:22:28 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# UiPath Python SDK
[](https://pypi.org/project/uipath/)
[](https://img.shields.io/pypi/v/uipath)
[](https://pypi.org/project/uipath/)
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.
Use the [UiPath LlamaIndex SDK](https://github.com/UiPath/uipath-llamaindex-python) to pack and publish LlamaIndex 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)
- [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 [CONTRIBUTING.md](https://github.com/UiPath/uipath-python/blob/main/CONTRIBUTING.md) before submitting a pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "uipath",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Marius Cosareanu <marius.cosareanu@uipath.com>, Cristian Pufu <cristian.pufu@uipath.com>",
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e8/d1/8d14efe6a75932f2d761fc3dcf96ceabcea54b3409f02b22555d26f30bcb/uipath-2.0.76.tar.gz",
"platform": null,
"description": "# UiPath Python SDK\n\n[](https://pypi.org/project/uipath/)\n[](https://img.shields.io/pypi/v/uipath)\n[](https://pypi.org/project/uipath/)\n\nA 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.\n\nUse the [UiPath LangChain SDK](https://github.com/UiPath/uipath-langchain-python) to pack and publish LangGraph Agents.\n\nUse the [UiPath LlamaIndex SDK](https://github.com/UiPath/uipath-llamaindex-python) to pack and publish LlamaIndex Agents.\n\nThis [quickstart guide](https://uipath.github.io/uipath-python/) walks you through deploying your first agent to UiPath Cloud Platform.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Configuration](#configuration)\n - [Environment Variables](#environment-variables)\n- [Basic Usage](#basic-usage)\n- [Available Services](#available-services)\n- [Examples](#examples)\n - [Buckets Service](#buckets-service)\n - [Context Grounding Service](#context-grounding-service)\n- [Command Line Interface (CLI)](#command-line-interface-cli)\n - [Authentication](#authentication)\n - [Initialize a Project](#initialize-a-project)\n - [Debug a Project](#debug-a-project)\n - [Package a Project](#package-a-project)\n - [Publish a Package](#publish-a-package)\n- [Project Structure](#project-structure)\n- [Development](#development)\n - [Setting Up a Development Environment](#setting-up-a-development-environment)\n\n## Installation\n\n```bash\npip install uipath\n```\n\nusing `uv`:\n\n```bash\nuv add uipath\n```\n\n## Configuration\n\n### Environment Variables\n\nCreate a `.env` file in your project root with the following variables:\n\n```\nUIPATH_URL=https://cloud.uipath.com/ACCOUNT_NAME/TENANT_NAME\nUIPATH_ACCESS_TOKEN=YOUR_TOKEN_HERE\n```\n\n## Basic Usage\n\n```python\nfrom uipath import UiPath\n# Initialize the SDK\nsdk = UiPath()\n# Execute a process\njob = sdk.processes.invoke(\n name=\"MyProcess\",\n input_arguments={\"param1\": \"value1\", \"param2\": 42}\n)\n# Work with assets\nasset = sdk.assets.retrieve(name=\"MyAsset\")\n```\n\n## Available Services\n\nThe SDK provides access to various UiPath services:\n\n- `sdk.processes` - Manage and execute UiPath automation processes\n\n- `sdk.assets` - Work with assets (variables, credentials) stored in UiPath\n\n- `sdk.buckets` - Manage cloud storage containers for automation files\n\n- `sdk.connections` - Handle connections to external systems\n\n- `sdk.context_grounding` - Work with semantic contexts for AI-enabled automation\n\n- `sdk.jobs` - Monitor and manage automation jobs\n\n- `sdk.queues` - Work with transaction queues\n\n- `sdk.actions` - Work with Action Center\n\n- `sdk.api_client` - Direct access to the API client for custom requests\n\n## Examples\n\n### Buckets Service\n\n```python\n# Download a file from a bucket\nsdk.buckets.download(\n bucket_key=\"my-bucket\",\n blob_file_path=\"path/to/file.xlsx\",\n destination_path=\"local/path/file.xlsx\"\n)\n```\n\n### Context Grounding Service\n\n```python\n# Search for contextual information\nresults = sdk.context_grounding.search(\n name=\"my-knowledge-index\",\n query=\"How do I process an invoice?\",\n number_of_results=5\n)\n```\n\n## Command Line Interface (CLI)\n\nThe SDK also provides a command-line interface for creating, packaging, and deploying automations:\n\n### Authentication\n\n```bash\nuipath auth\n```\n\nThis command opens a browser for authentication and creates/updates your `.env` file with the proper credentials.\n\n### Initialize a Project\n\n```bash\nuipath init [ENTRYPOINT]\n```\n\nCreates 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.\n\n### Debug a Project\n\n```bash\nuipath run ENTRYPOINT [INPUT]\n```\n\nExecutes a Python script with the provided JSON input arguments.\n\n### Package a Project\n\n```bash\nuipath pack\n```\n\nPackages your project into a `.nupkg` file that can be deployed to UiPath.\n\n**Note:** Your `pyproject.toml` must include:\n\n- A description field (avoid characters: &, <, >, \", ', ;)\n- Author information\n\nExample:\n\n```toml\ndescription = \"Your package description\"\nauthors = [{name = \"Your Name\", email = \"your.email@example.com\"}]\n```\n\n### Publish a Package\n\n```bash\nuipath publish\n```\n\nPublishes the most recently created package to your UiPath Orchestrator.\n\n## Project Structure\n\nTo properly use the CLI for packaging and publishing, your project should include:\n\n- A `pyproject.toml` file with project metadata\n- A `uipath.json` file (generated by `uipath init`)\n- Any Python files needed for your automation\n\n## Development\n\n### Setting Up a Development Environment\n\nPlease read [CONTRIBUTING.md](https://github.com/UiPath/uipath-python/blob/main/CONTRIBUTING.md) before submitting a pull request.\n",
"bugtrack_url": null,
"license": null,
"summary": "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.",
"version": "2.0.76",
"project_urls": {
"Documentation": "https://uipath.github.io/uipath-python/",
"Homepage": "https://uipath.com",
"Repository": "https://github.com/UiPath/uipath-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "fcf5135538e8be54e4acaafd9f5ef5122a49d25af02bb3fff267cd8a111838a0",
"md5": "78a80f7a7c95a3b0a0d602d874308dbf",
"sha256": "de472eb5ebaf9cd025ae971421e40d3c475e2d15a4f7da2b74a71eec37bc674c"
},
"downloads": -1,
"filename": "uipath-2.0.76-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78a80f7a7c95a3b0a0d602d874308dbf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 133309,
"upload_time": "2025-07-09T11:22:26",
"upload_time_iso_8601": "2025-07-09T11:22:26.967326Z",
"url": "https://files.pythonhosted.org/packages/fc/f5/135538e8be54e4acaafd9f5ef5122a49d25af02bb3fff267cd8a111838a0/uipath-2.0.76-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e8d18d14efe6a75932f2d761fc3dcf96ceabcea54b3409f02b22555d26f30bcb",
"md5": "530c31bd6959914dcbd53b279b0b4577",
"sha256": "686fe7a34fd535b3b1a8da5ece0ca69a5961c7095d1938c3152f3ce328ceaf9b"
},
"downloads": -1,
"filename": "uipath-2.0.76.tar.gz",
"has_sig": false,
"md5_digest": "530c31bd6959914dcbd53b279b0b4577",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1839159,
"upload_time": "2025-07-09T11:22:28",
"upload_time_iso_8601": "2025-07-09T11:22:28.832692Z",
"url": "https://files.pythonhosted.org/packages/e8/d1/8d14efe6a75932f2d761fc3dcf96ceabcea54b3409f02b22555d26f30bcb/uipath-2.0.76.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 11:22:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UiPath",
"github_project": "uipath-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "uipath"
}
