uipath 1.0.0__py3-none-any.whl → 2.0.0.dev2__py3-none-any.whl

uipath-2.0.0.dev2.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: uipath
+Version: 2.0.0.dev2
+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.9
+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.9
+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.dev2.dist-info/RECORD

@@ -0,0 +1,4 @@
+uipath-2.0.0.dev2.dist-info/METADATA,sha256=0mpddrh7zJIk7VBSXdq_zcCQ1wBbl6Ex8ISqyNFFIx4,5831
+uipath-2.0.0.dev2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.0.0.dev2.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.0.0.dev2.dist-info/RECORD,,

{uipath-1.0.0.dist-info → uipath-2.0.0.dev2.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

uipath-2.0.0.dev2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+uipath = uipath._cli:cli

uipath/__init__.py

@@ -1,9 +0,0 @@
-from uipath.__version__ import __version__
-from uipath.auth.authentication import UiPathAuth
-from uipath.client.api_client import UiPathClient
-
-__all__ = [
-    '__version__',
-    'UiPathAuth',
-    'UiPathClient',
-] 

uipath/__version__.py

@@ -1,3 +0,0 @@
-VERSION = (1, 0, 0)
-
-__version__ = '.'.join(map(str, VERSION)) 

uipath-1.0.0.dist-info/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Your Name
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE. 

uipath-1.0.0.dist-info/METADATA

@@ -1,181 +0,0 @@
-Metadata-Version: 2.2
-Name: uipath
-Version: 1.0.0
-Summary: A Python SDK for UiPath
-Home-page: https://github.com/christianblandford/uipath
-Author: Christian Blandford
-Author-email: christianblandford@me.com
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests>=2.25.0
-Requires-Dist: typing-extensions>=4.0.0; python_version < "3.8"
-Provides-Extra: dev
-Requires-Dist: pytest>=6.0; extra == "dev"
-Requires-Dist: pytest-cov>=2.0; extra == "dev"
-Requires-Dist: black>=22.0; extra == "dev"
-Requires-Dist: isort>=5.0; extra == "dev"
-Requires-Dist: mypy>=0.900; extra == "dev"
-Requires-Dist: flake8>=3.9; extra == "dev"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# UiPath Python SDK
-
-A Python SDK for interacting with UiPath's APIs. This SDK provides a simple and intuitive way to automate UiPath operations programmatically.
-
-## Installation 
-
-```bash
-pip install uipath
-```
-
-## Quick Start
-
-```python
-from uipath.auth.authentication import UiPathAuth
-from uipath.client.api_client import UiPathClient
-from uipath.resources.robots import RobotsResource
-
-# Initialize authentication
-auth = UiPathAuth(
-    tenant_name="your_tenant",
-    client_id="your_client_id",
-    client_secret="your_client_secret"
-)
-
-# Create API client
-client = UiPathClient(auth)
-
-# Use the robots resource
-robots = RobotsResource(client)
-
-# List all robots
-all_robots = robots.list_robots()
-```
-
-## Features
-
-- Simple, intuitive interface for UiPath APIs
-- Authentication handling
-- Comprehensive error handling
-- Type hints for better IDE support
-- Resource classes for all major UiPath entities:
-  - Robots
-  - Jobs
-  - Processes
-  - Assets
-  - And more...
-
-## Authentication
-
-The SDK supports client credentials authentication. You'll need:
-- Tenant name
-- Client ID
-- Client secret
-
-You can obtain these credentials from your UiPath Orchestrator account under Admin → API Access.
-
-```python
-auth = UiPathAuth(
-    tenant_name="your_tenant",
-    client_id="your_client_id",
-    client_secret="your_client_secret",
-    scope="OR.Default"  # Optional, defaults to OR.Default
-)
-```
-
-## Usage Examples
-
-### Working with Robots
-
-```python
-# List all robots
-robots = RobotsResource(client)
-all_robots = robots.list_robots()
-
-# Get a specific robot
-robot = robots.get_robot(robot_id=123)
-
-# Create a new robot
-new_robot = robots.create_robot(
-    name="MyNewRobot",
-    machine_name="DESKTOP-123",
-    type="Unattended"
-)
-```
-
-### Error Handling
-
-The SDK provides custom exceptions for different types of errors:
-
-```python
-from uipath.exceptions.exceptions import AuthenticationError, ApiError
-
-try:
-    robots.get_robot(robot_id=999)
-except AuthenticationError as e:
-    print("Authentication failed:", e)
-except ApiError as e:
-    print("API request failed:", e)
-```
-
-## Configuration
-
-The SDK can be configured with custom endpoints and API versions:
-
-```python
-client = UiPathClient(
-    auth,
-    base_url="https://cloud.uipath.com",  # Custom base URL
-    api_version="v1"  # API version
-)
-```
-
-## Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Support
-
-If you encounter any problems or have questions, please:
-1. Check the [documentation](docs/)
-2. Open an issue in the GitHub repository
-
-## Requirements
-
-- Python 3.7+
-- requests library
-
-## Disclaimer
-
-This is an unofficial SDK and is not affiliated with, maintained, authorized, endorsed, or sponsored by UiPath.

uipath-1.0.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-uipath/__init__.py,sha256=j2gsFvg5BudvoZxfNncyip-FBq9PqdM39hvCJzS6k0k,215
-uipath/__version__.py,sha256=Q1SV_A_xAMGhRrDOq-kOmB2-vbVwqaYR7R11-BM4jq8,63
-uipath-1.0.0.dist-info/LICENSE,sha256=FyuBsNr3YLXHPRQfWIpCAC4brUeSdYelr01V-Fkog8U,1066
-uipath-1.0.0.dist-info/METADATA,sha256=r9uU1FkrqU8Lkyb7l-GqA1pzys9E4VaActrh878pzoM,4536
-uipath-1.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-uipath-1.0.0.dist-info/top_level.txt,sha256=cO-fuTo_YlozqaZ6VNk0ST79wuBjLkcTRzYpXLM6rRg,7
-uipath-1.0.0.dist-info/RECORD,,

uipath-1.0.0.dist-info/top_level.txt

@@ -1 +0,0 @@
-uipath