You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Follow the official installation instructions for your operating system.
20
18
21
19
3. **Create a virtual environment in the current working directory**:
22
20
```sh
@@ -25,45 +23,61 @@
25
23
26
24
4. **Install dependencies**:
27
25
```sh
28
-
uv sync --all-extras
26
+
uv sync --all-extras --no-cache
27
+
```
28
+
29
+
For additional commands related to linting, formatting, and building, run `just --list`.
30
+
31
+
### Using the SDK Locally
32
+
33
+
1. Create a project directory:
34
+
```sh
35
+
mkdir project
36
+
cd project
29
37
```
30
38
31
-
See `just --list`for linting, formatting and build commands.
39
+
2. Initialize the Python project:
40
+
```sh
41
+
uv init . --python 3.10
42
+
```
32
43
44
+
3. Set the SDK path:
45
+
```sh
46
+
PATH_TO_SDK=/Users/YOUR_USERNAME/uipath-python
47
+
```
33
48
34
-
### Use SDK Locally
35
-
1. Create a folder on your own device `mkdir project;cd project`
36
-
2. Initialize the python project `uv``uv init . --python 3.9`
37
-
3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/uipath-python`
38
-
4. Install the sdk in editable mode `uv add --editable ${PATH_TO_SDK}`
49
+
4. Install the SDK in editable mode:
50
+
```sh
51
+
uv add --editable ${PATH_TO_SDK}
52
+
```
39
53
40
-
:information_source: Instead of cloning the project into `.venv/lib/python3.9/site-packages/uipath`, this mode creates a file named `_uipath.pth` inside `.venv/lib/python3.9/site-packages`. This file contains the value of `PATH_TO_SDK`, which is added to `sys.path`—the list of directories where python searches for packages. (Run `python -c 'import sys; print(sys.path)'` to see the entries.)
54
+
>**Note:** Instead of cloning the project into `.venv/lib/python3.10/site-packages/uipath`, this mode creates a file named `_uipath.pth` inside `.venv/lib/python3.10/site-packages`. This file contains the value of `PATH_TO_SDK`, which is added to `sys.path`—the list of directories where Python searches for packages. To view the entries, run `python -c 'import sys; print(sys.path)'`.
41
55
42
56
## API Style Guide
43
57
44
-
### General Rule:
45
-
- use key instead of ID
58
+
### General Rule
59
+
- Use `key` instead of `id`for resource identifiers
46
60
47
-
### Standard Methods & Naming Conventions
61
+
### Standard Methods and Naming Conventions
48
62
49
63
#### Retrieve a Single Resource
50
-
- **Method Name:**`retrieve` instead of get
51
-
- **Usage:**To obtain a specific resource instance using its unique identifier (using *key* instead of ID).
52
-
- **Extended:**
53
-
- `retrieve_by_[field_name]` (for fields other than key)
64
+
- **Method Name:**`retrieve`
65
+
- **Purpose:**Obtain a specific resource instance using its unique identifier (using `key` instead of `id`)
66
+
- **Variations:**
67
+
- `retrieve_by_[field_name]` (for fields other than `key`)
54
68
55
69
#### List Multiple Resources
56
70
- **Method Name:**`list`
57
-
- **Usage:**To fetch a collection of resources, optionally filtered by query parameters.
71
+
- **Purpose:**Fetch a collection of resources, optionally filtered by query parameters
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.
9
8
10
-
Use the [UiPath LangChain SDK](https://github.com/UiPath/uipath-langchain-python) to pack and publish LangGraph Agents.
9
+
Use the [UiPath LangChain SDK](https://github.com/UiPath/uipath-langchain-python) to pack and publish LangGraph Agents.
0 commit comments