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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-30Lines changed: 2 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,36 +34,8 @@ See `just --list` for linting, formatting and build commands.
34
34
### Use SDK Locally
35
35
1. Create a folder on your own device `mkdir project;cd project`
36
36
2. Initialize the python project `uv``uv init . --python 3.9`
37
-
3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/platform-sdk/sdk/core`
37
+
3. Obtain the project path `PATH_TO_SDK=/Users/YOU_USER/uipath-langchain/`
38
38
4. Install the sdk in editable mode `uv add --editable ${PATH_TO_SDK}`
39
39
40
-
:information_source: Instead of cloning the project into `.venv/lib/python3.9/site-packages/uipath_sdk`, this mode creates a file named `_uipath_sdk.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.)
40
+
:information_source: Instead of cloning the project into `.venv/lib/python3.9/site-packages/uipath_langchain`, this mode creates a file named `_uipath_langchain.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.)
41
41
42
-
## API Style Guide
43
-
44
-
### General Rule:
45
-
- use key instead of ID
46
-
47
-
### Standard Methods & Naming Conventions
48
-
49
-
#### 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)
54
-
55
-
#### List Multiple Resources
56
-
- **Method Name:**`list`
57
-
- **Usage:** To fetch a collection of resources, optionally filtered by query parameters.
0 commit comments