| Name | uipathlib JSON |
| Version |
0.0.12
JSON |
| download |
| home_page | None |
| Summary | UiPath Cloud client Python package that uses the requests library |
| upload_time | 2025-10-24 01:22:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
uipath
orchestrator
rpa
python
api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# uipathlib
* [Description](#package-description)
* [Usage](#usage)
* [Installation](#installation)
* [License](#license)
## Package Description
UiPath Cloud client Python package that uses the [requests](https://pypi.org/project/requests/) library.
> [!IMPORTANT]
> This packages uses pydantic~=1.0!
## Usage
* [uipathlib](#uipathlib)
from a script:
```python
import uipathlib
url_base = "https://cloud.uipath.com/my_company/Production/orchestrator_/"
client_id = "ABX"
refresh_token = "ABD"
scope = "OR.Folders.Read OR.Jobs OR.Queues OR.Execution.Read OR.Robots.Read OR.Settings.Read"
fid = "1138055" # Folder ID (Organization ID)
uipath = uipathlib.UiPath(url_base=url_base,
client_id=client_id,
refresh_token=refresh_token,
scope=scope)
```
```python
# ASSETS
response = uipath.list_assets(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# BUCKETS
response = uipath.list_buckets(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
response = uipath.create_bucket(fid=fid,
name="Test 1",
guid="f7ea20e9-971b-4c23-9979-321178a68c46",
description="Test description 1")
if response.status_code == 201:
print("Bucket created successfully")
```
```python
bid = "69248" # bucked id example
response = uipath.delete_bucket(fid=fid, id=bid)
if response.status_code == 204:
print("Bucket deleted successfully")
```
```python
# UPLOAD
bid = "69243" # bucked id example
response = uipath.upload_bucket_file(fid=fid,
id=bid,
localpath=r"C:\Users\admin\Desktop\my_bucket_demo.txt",
remotepath=r"my_bucket_demo.txt")
if response.status_code in [200, 201]:
print("File uploaded successfully")
```
```python
# DELETE
bid = "69243" # bucked id example
response = uipath.delete_bucket_file(fid=fid,
id=bid,
filename=r"my_bucket_demo.txt")
if response.status_code == 204:
print("File deleted successfully")
```
```python
# CALENDARS
response = uipath.list_calendars(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# ENVIRONMENTS (UNDER DEVELOPMENT)
response = uipath.list_environments(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# JOBS
# Filter examples:
# - "State eq 'Running'"
# - "State eq 'Successful' and ReleaseName eq 'ReleaseNameOrProcessName'"
# - "ReleaseName eq 'ReleaseNameOrProcessName'"
response = uipath.list_jobs(fid=fid, filter="State eq 'Running'")
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
process_key = "ead3e825-7817-426d-8b1d-3991e6eb2809" # example process key
robot_id = None # None for default robot, or specify robot ID
response = uipath.start_job(fid=fid,
process_key=process_key,
robot_id=robot_id)
if response.status_code == 201:
print(response.content)
```
```python
# MACHINES
response = uipath.list_machines(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
print(df)
```
```python
# PROCESSES
response = uipath.list_processes(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# QUEUES
response = uipath.list_queues(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
response = uipath.list_queue_items(fid=fid,
filter="QueueDefinitionId eq 317460")
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
queue_item_id = 1125058579 # example queue item id
response = uipath.get_queue_item(fid=fid,
id=queue_item_id)
if response.status_code == 200:
df = pd.DataFrame([response.content])
display(df) # print(df)
```
```python
queue_name = "RPA_1201_..." # queue name example
response = uipath.add_queue_item(fid=fid,
queue=queue_name,
data={"EmployeeId": "12345",
"RowId": "566829607423876",
"State": "Approved",
"RequestId": "LR00001",
"Language": "English"},
reference="12345",
priority="Normal")
if response.status_code == 201:
print(response.content)
```
```python
queue_name = "RPA_1201_..." # queue name example
queue_item_id = 913233204 # example queue item id
response = uipath.update_queue_item(fid=fid,
queue=queue_name,
id=queue_item_id,
data={"EmployeeId": "54321",
"RowId": "566829607423876",
"State": "Approved",
"RequestId": "LR20001",
"Language": "English"})
if response.status_code == 200:
print("Queue item updated successfully")
```
```python
queue_item_id = 913233204 # example queue item id
response = uipath.delete_queue_item(fid=fid,
id=queue_item_id)
if response.status_code == 204:
print("Queue item deleted successfully")
```
```python
# RELEASES
response = uipath.list_releases(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# ROBOTS
response = uipath.list_robots(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
response = uipath.list_robot_logs(fid=fid, filter="JobKey eq a111d111-b111-1f11-b11d-111adac1111d")
if response.status_code == 200:
df = pd.DataFrame(response.content)
print(df)
```
```python
# ROLES
response = uipath.list_roles()
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# SCHEDULES
response = uipath.list_schedules(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# SESSIONS
response = uipath.list_sessions(fid=fid)
if response.status_code == 200:
df = pd.DataFrame(response.content)
display(df) # print(df)
```
```python
# Close
del(uipath)
```
## Installation
* [uipathlib](#uipathlib)
Install python and pip if you have not already.
Then run:
```bash
pip install pip --upgrade
```
For production:
```bash
pip install uipathlib
```
This will install the package and all of it's python dependencies.
If you want to install the project for development:
```bash
git clone https://github.com/aghuttun/uipathlib.git
cd uipathlib
pip install -e ".[dev]"
```
To test the development package: [Testing](#testing)
## License
* [uipathlib](#uipathlib)
BSD License (see license file)
Raw data
{
"_id": null,
"home_page": null,
"name": "uipathlib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Paulo Portela <portela.paulo@gmail.com>",
"keywords": "UiPath, Orchestrator, RPA, Python, API",
"author": null,
"author_email": "Paulo Portela <portela.paulo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/79/75/d619548c2713cc41e51deb7c65128f5f858ca6aed8922e47aa8888b80aac/uipathlib-0.0.12.tar.gz",
"platform": null,
"description": "# uipathlib\r\n\r\n* [Description](#package-description)\r\n* [Usage](#usage)\r\n* [Installation](#installation)\r\n* [License](#license)\r\n\r\n## Package Description\r\n\r\nUiPath Cloud client Python package that uses the [requests](https://pypi.org/project/requests/) library.\r\n\r\n> [!IMPORTANT]\r\n> This packages uses pydantic~=1.0!\r\n\r\n## Usage\r\n\r\n* [uipathlib](#uipathlib)\r\n\r\nfrom a script:\r\n\r\n```python\r\nimport uipathlib\r\n\r\nurl_base = \"https://cloud.uipath.com/my_company/Production/orchestrator_/\"\r\nclient_id = \"ABX\"\r\nrefresh_token = \"ABD\"\r\nscope = \"OR.Folders.Read OR.Jobs OR.Queues OR.Execution.Read OR.Robots.Read OR.Settings.Read\"\r\nfid = \"1138055\" # Folder ID (Organization ID)\r\n\r\nuipath = uipathlib.UiPath(url_base=url_base,\r\n client_id=client_id,\r\n refresh_token=refresh_token,\r\n scope=scope)\r\n```\r\n\r\n```python\r\n# ASSETS\r\nresponse = uipath.list_assets(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# BUCKETS\r\nresponse = uipath.list_buckets(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nresponse = uipath.create_bucket(fid=fid,\r\n name=\"Test 1\",\r\n guid=\"f7ea20e9-971b-4c23-9979-321178a68c46\",\r\n description=\"Test description 1\")\r\nif response.status_code == 201:\r\n print(\"Bucket created successfully\")\r\n```\r\n\r\n```python\r\nbid = \"69248\" # bucked id example\r\nresponse = uipath.delete_bucket(fid=fid, id=bid)\r\nif response.status_code == 204:\r\n print(\"Bucket deleted successfully\")\r\n```\r\n\r\n```python\r\n# UPLOAD\r\nbid = \"69243\" # bucked id example\r\nresponse = uipath.upload_bucket_file(fid=fid,\r\n id=bid,\r\n localpath=r\"C:\\Users\\admin\\Desktop\\my_bucket_demo.txt\",\r\n remotepath=r\"my_bucket_demo.txt\")\r\nif response.status_code in [200, 201]:\r\n print(\"File uploaded successfully\")\r\n```\r\n\r\n```python\r\n# DELETE\r\nbid = \"69243\" # bucked id example\r\nresponse = uipath.delete_bucket_file(fid=fid,\r\n id=bid, \r\n filename=r\"my_bucket_demo.txt\")\r\nif response.status_code == 204:\r\n print(\"File deleted successfully\")\r\n```\r\n\r\n```python\r\n# CALENDARS\r\nresponse = uipath.list_calendars(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# ENVIRONMENTS (UNDER DEVELOPMENT)\r\nresponse = uipath.list_environments(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# JOBS\r\n# Filter examples:\r\n# - \"State eq 'Running'\"\r\n# - \"State eq 'Successful' and ReleaseName eq 'ReleaseNameOrProcessName'\"\r\n# - \"ReleaseName eq 'ReleaseNameOrProcessName'\"\r\nresponse = uipath.list_jobs(fid=fid, filter=\"State eq 'Running'\")\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nprocess_key = \"ead3e825-7817-426d-8b1d-3991e6eb2809\" # example process key\r\nrobot_id = None # None for default robot, or specify robot ID\r\nresponse = uipath.start_job(fid=fid,\r\n process_key=process_key,\r\n robot_id=robot_id)\r\nif response.status_code == 201:\r\n print(response.content)\r\n```\r\n\r\n```python\r\n# MACHINES\r\nresponse = uipath.list_machines(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n print(df)\r\n```\r\n\r\n```python\r\n# PROCESSES\r\nresponse = uipath.list_processes(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# QUEUES\r\nresponse = uipath.list_queues(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nresponse = uipath.list_queue_items(fid=fid, \r\n filter=\"QueueDefinitionId eq 317460\")\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nqueue_item_id = 1125058579 # example queue item id\r\nresponse = uipath.get_queue_item(fid=fid,\r\n id=queue_item_id)\r\nif response.status_code == 200:\r\n df = pd.DataFrame([response.content])\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nqueue_name = \"RPA_1201_...\" # queue name example\r\nresponse = uipath.add_queue_item(fid=fid,\r\n queue=queue_name,\r\n data={\"EmployeeId\": \"12345\",\r\n \"RowId\": \"566829607423876\",\r\n \"State\": \"Approved\",\r\n \"RequestId\": \"LR00001\",\r\n \"Language\": \"English\"},\r\n reference=\"12345\",\r\n priority=\"Normal\")\r\nif response.status_code == 201:\r\n print(response.content)\r\n```\r\n\r\n```python\r\nqueue_name = \"RPA_1201_...\" # queue name example\r\nqueue_item_id = 913233204 # example queue item id\r\nresponse = uipath.update_queue_item(fid=fid,\r\n queue=queue_name,\r\n id=queue_item_id,\r\n data={\"EmployeeId\": \"54321\",\r\n \"RowId\": \"566829607423876\",\r\n \"State\": \"Approved\",\r\n \"RequestId\": \"LR20001\",\r\n \"Language\": \"English\"})\r\nif response.status_code == 200:\r\n print(\"Queue item updated successfully\")\r\n```\r\n\r\n```python\r\nqueue_item_id = 913233204 # example queue item id\r\nresponse = uipath.delete_queue_item(fid=fid,\r\n id=queue_item_id)\r\nif response.status_code == 204:\r\n print(\"Queue item deleted successfully\")\r\n```\r\n\r\n```python\r\n# RELEASES\r\nresponse = uipath.list_releases(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# ROBOTS\r\nresponse = uipath.list_robots(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\nresponse = uipath.list_robot_logs(fid=fid, filter=\"JobKey eq a111d111-b111-1f11-b11d-111adac1111d\")\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n print(df)\r\n```\r\n\r\n```python\r\n# ROLES\r\nresponse = uipath.list_roles()\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# SCHEDULES\r\nresponse = uipath.list_schedules(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# SESSIONS\r\nresponse = uipath.list_sessions(fid=fid)\r\nif response.status_code == 200:\r\n df = pd.DataFrame(response.content)\r\n display(df) # print(df)\r\n```\r\n\r\n```python\r\n# Close\r\ndel(uipath)\r\n```\r\n\r\n## Installation\r\n\r\n* [uipathlib](#uipathlib)\r\n\r\nInstall python and pip if you have not already.\r\n\r\nThen run:\r\n\r\n```bash\r\npip install pip --upgrade\r\n```\r\n\r\nFor production:\r\n\r\n```bash\r\npip install uipathlib\r\n```\r\n\r\nThis will install the package and all of it's python dependencies.\r\n\r\nIf you want to install the project for development:\r\n\r\n```bash\r\ngit clone https://github.com/aghuttun/uipathlib.git\r\ncd uipathlib\r\npip install -e \".[dev]\"\r\n```\r\n\r\nTo test the development package: [Testing](#testing)\r\n\r\n## License\r\n\r\n* [uipathlib](#uipathlib)\r\n\r\nBSD License (see license file)\r\n",
"bugtrack_url": null,
"license": null,
"summary": "UiPath Cloud client Python package that uses the requests library",
"version": "0.0.12",
"project_urls": {
"Documentation": "https://github.com/aghuttun/uipathlib/blob/main/README.md",
"Homepage": "https://github.com/aghuttun/uipathlib"
},
"split_keywords": [
"uipath",
" orchestrator",
" rpa",
" python",
" api"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "71666a8eaaf3f1eb752ed8a549d7f4d40e6584a6351c2b45fdd899dd37881416",
"md5": "16f06bc217e7496c69648ee097d37960",
"sha256": "da687afe9650c2407059b3e952dbf864882cf36a9dd7fffd8376d3a8bd393c75"
},
"downloads": -1,
"filename": "uipathlib-0.0.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "16f06bc217e7496c69648ee097d37960",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 12729,
"upload_time": "2025-10-24T01:22:22",
"upload_time_iso_8601": "2025-10-24T01:22:22.798541Z",
"url": "https://files.pythonhosted.org/packages/71/66/6a8eaaf3f1eb752ed8a549d7f4d40e6584a6351c2b45fdd899dd37881416/uipathlib-0.0.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7975d619548c2713cc41e51deb7c65128f5f858ca6aed8922e47aa8888b80aac",
"md5": "6c844029f9d7fd5c4af7109c3a976392",
"sha256": "c8b7abda7685238168a6c1c3ead8249682eb1ecd6beaf5894986ced4c7b34c3b"
},
"downloads": -1,
"filename": "uipathlib-0.0.12.tar.gz",
"has_sig": false,
"md5_digest": "6c844029f9d7fd5c4af7109c3a976392",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 14154,
"upload_time": "2025-10-24T01:22:23",
"upload_time_iso_8601": "2025-10-24T01:22:23.643467Z",
"url": "https://files.pythonhosted.org/packages/79/75/d619548c2713cc41e51deb7c65128f5f858ca6aed8922e47aa8888b80aac/uipathlib-0.0.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-24 01:22:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aghuttun",
"github_project": "uipathlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "uipathlib"
}
