{"id":28954397,"url":"https://github.com/uipath/uipath-python","last_synced_at":"2026-02-27T07:01:30.633Z","repository":{"id":287217539,"uuid":"925171912","full_name":"UiPath/uipath-python","owner":"UiPath","description":"A comprehensive Python SDK for interacting with UiPath's automation platform","archived":false,"fork":false,"pushed_at":"2025-06-20T12:18:14.000Z","size":7896,"stargazers_count":19,"open_issues_count":9,"forks_count":7,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-06-20T13:29:12.227Z","etag":null,"topics":["agentic-ai","automation","python","uipath"],"latest_commit_sha":null,"homepage":"https://uipath.github.io/uipath-python/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UiPath.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-01-31T11:20:03.000Z","updated_at":"2025-06-20T12:17:45.000Z","dependencies_parsed_at":"2025-04-10T16:02:42.962Z","dependency_job_id":"be8dda2a-73f1-477c-ae0c-1350c235dfda","html_url":"https://github.com/UiPath/uipath-python","commit_stats":null,"previous_names":["uipath/uipath-python"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/UiPath/uipath-python","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fuipath-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fuipath-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fuipath-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fuipath-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UiPath","download_url":"https://codeload.github.com/UiPath/uipath-python/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UiPath%2Fuipath-python/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261539362,"owners_count":23174139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agentic-ai","automation","python","uipath"],"created_at":"2025-06-23T19:10:17.295Z","updated_at":"2026-02-27T07:01:30.626Z","avatar_url":"https://github.com/UiPath.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UiPath Python SDK\n\n[![PyPI downloads](https://img.shields.io/pypi/dm/uipath.svg)](https://pypi.org/project/uipath/)\n[![PyPI - Version](https://img.shields.io/pypi/v/uipath)](https://img.shields.io/pypi/v/uipath)\n[![Python versions](https://img.shields.io/pypi/pyversions/uipath.svg)](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\nCheck out other [UiPath Integrations](https://github.com/UiPath/uipath-integrations-python) to pack and publish agents built with LlamaIndex, OpenAI Agents, Google ADK, and more.\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.platform 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.tasks` - 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\n```\n\nThe `uipath.json` file should include your entry points in the `functions` section:\n```json\n{\n  \"functions\": {\n    \"main\": \"main.py:main\"\n  }\n}\n```\n\nRunning `uipath init` will process these function definitions and create the corresponding `entry-points.json` file needed for deployment.\n\nFor more details on the configuration format, see the [UiPath configuration specifications](specs/README.md).\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: \u0026, \u003c, \u003e, \", ', ;)\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 with your function definitions (e.g., `\"functions\": {\"main\": \"main.py:main\"}`)\n-   A `entry-points.json` file (generated by `uipath init`)\n-   A `bindings.json` file (generated by `uipath init`) to configure resource overrides\n-   Any Python files needed for your automation\n\n\n## Development\n\n### Tools\n\nCheck out [uipath-dev](https://github.com/uipath/uipath-dev-python) - an interactive application for building, testing, and debugging UiPath Python runtimes, agents, and automation scripts.\n\n### Contributions\n\nPlease read our [contribution guidelines](https://github.com/UiPath/uipath-integrations-python/blob/main/CONTRIBUTING.md) before submitting a pull request.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Fuipath-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fuipath%2Fuipath-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fuipath%2Fuipath-python/lists"}