uipath 2.0.5__tar.gz → 2.0.7__tar.gz

{uipath-2.0.5 → uipath-2.0.7}/.github/workflows/build.yml

@@ -56,7 +56,9 @@ jobs:
         if: ${{ steps.check_version.outputs.modified }} == 'true'
         run: |
           mkdir -p docs/plugins
+          mkdir -p docs/docs
           ln -s ../../plugins/uipath-langchain-python docs/plugins/uipath-langchain-python
+          ln -s ../plugins/uipath-langchain-python/docs docs/docs
 
       - name: Publish Docs
         if: ${{ steps.check_version.outputs.modified }} == 'true'

{uipath-2.0.5 → uipath-2.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.5
+Version: 2.0.7
 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
@@ -208,4 +208,4 @@ To properly use the CLI for packaging and publishing, your project should includ
 
 ### Setting Up a Development Environment
 
-Please read [CONTRIBUTING.md](https://uipath.github.io/uipath-python/how_to_contribute/) before submitting a pull request.
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting a pull request.

{uipath-2.0.5 → uipath-2.0.7}/README.md

@@ -180,4 +180,4 @@ To properly use the CLI for packaging and publishing, your project should includ
 
 ### Setting Up a Development Environment
 
-Please read [CONTRIBUTING.md](https://uipath.github.io/uipath-python/how_to_contribute/) before submitting a pull request.
+Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting a pull request.

uipath-2.0.7/docs/getting_started_agent.md

@@ -0,0 +1,29 @@
+# Getting Started
+
+## Using an Agent Based on LangGraph
+
+To use the UiPath SDK with a LangGraph-based project:
+
+1. Add the `uipath-langchain` package to your project:
+
+    ```shell
+    uv add uipath-langchain
+    ```
+
+2. Initialize the project by running the following command in your activated virtual environment:
+
+    ```shell
+    uipath init
+    ```
+
+    > **Note:**: The `uipath init` command will execute your code to analyze its structure and collect information about inputs and outputs.
+
+3. Package and publish your project:
+    ```shell
+    uipath pack
+    uipath publish
+    ```
+
+This will create and publish your package to the UiPath platform, making it available for use in your automation workflows.
+
+For more examples and implementation patterns, check out the [sample projects](https://github.com/UiPath/uipath-langchain-python/tree/main/samples) in our GitHub repository.

uipath-2.0.5/docs/getting_started.md → uipath-2.0.7/docs/getting_started_cli.md

@@ -122,84 +122,3 @@ Finally, publish your package. After selecting your publishing destination (tena
 Publishing most recent package: test.0.1.0.nupkg
 Package published successfully!
 ```
-
-## Using the SDK
-
-### Creating a Process Client
-
-Now, let's create a new project to invoke the process we just created. We'll skip the installation and authentication steps since they're covered above.
-
-Create a new project:
-
-```shell
-mkdir test2
-cd test2
-uv init . --python 3.10
-uv add uipath
-```
-
-### Configuring the Project
-
-First, open `.env` in your code editor and specify the folder where you want to run the code. For example, to use the "Shared" folder:
-
-```shell
-UIPATH_FOLDER_PATH=Shared
-```
-
-### Writing the Client Code
-
-Open `main.py` in your code editor and add the following code:
-
-```python
-from uipath import UiPath
-
-
-def main():
-    sdk = UiPath()
-    sdk.processes.invoke(
-        "test-pack",
-        input_arguments={
-            "message": "Hello, World!",
-            "repeat": 3,
-            "prefix": "[Echo]"
-        }
-    )
-```
-
-> **Note:**: `test-pack` is the name of the process we created from the previous package.
-
-### Verifying the Execution
-
-Open your browser and navigate to UiPath. Go to the specified folder, and you'll see a new job for `test-pack` has been executed. The output will be:
-
-```
-[Echo]: Hello, World! Echo: Hello, World! Echo: Hello, World!
-```
-
-## Using an Agent Based on LangGraph
-
-To use the UiPath SDK with a LangGraph-based project:
-
-1. Add the `uipath-langchain` package to your project:
-
-    ```shell
-    uv add uipath-langchain
-    ```
-
-2. Initialize the project by running the following command in your activated virtual environment:
-
-    ```shell
-    uipath init
-    ```
-
-    > **Note:**: The `uipath init` command will execute your code to analyze its structure and collect information about inputs and outputs.
-
-3. Package and publish your project:
-    ```shell
-    uipath pack
-    uipath publish
-    ```
-
-This will create and publish your package to the UiPath platform, making it available for use in your automation workflows.
-
-For more examples and implementation patterns, check out the [sample projects](https://github.com/UiPath/uipath-langchain-python/tree/main/samples) in our GitHub repository.

uipath-2.0.7/docs/getting_started_cloud.md

@@ -0,0 +1,3 @@
+--8<--
+docs/plugins/uipath-langchain-python/samples/multi-agent-planner-researcher-coder-distributed/README.md:149:234
+--8<--

uipath-2.0.7/docs/getting_started_sdk.md

@@ -0,0 +1,83 @@
+# Getting Started
+
+## Prerequisites
+
+-   Python 3.10 or higher
+-   `pip` or `uv` package manager
+-   A UiPath Platform account with appropriate permissions
+
+## Creating a New Project
+
+We recommend using `uv` for package management. To create a new project:
+
+```shell
+mkdir example
+cd example
+uv init . --python 3.10
+```
+
+This command creates a basic project structure.
+
+### Installing the UiPath SDK
+
+Add the UiPath SDK to your project:
+
+```shell
+uv add uipath
+```
+
+To verify the installation, run:
+
+```shell
+uv run uipath --version
+```
+
+### Authentication
+
+To debug your script locally and publish your project, you need to authenticate with UiPath:
+
+```shell
+uv run uipath auth
+```
+
+This command opens a new browser window. If you encounter any issues, copy the URL from the terminal and paste it into your browser. After authentication, select your tenant by typing its corresponding number in the terminal.
+
+After completing this step, your project will contain a `.env` file with your access token, UiPath URL, and other configuration details.
+
+### Configuring the Project
+
+First, open `.env` in your code editor and specify the folder where you want to run the code. For example, to use the "Shared" folder:
+
+```shell
+UIPATH_FOLDER_PATH=Shared
+```
+
+### Writing the Client Code
+
+Open `main.py` in your code editor and add the following code:
+
+```python
+from uipath import UiPath
+
+
+def main():
+    sdk = UiPath()
+    sdk.processes.invoke(
+        "test-pack",
+        input_arguments={
+            "message": "Hello, World!",
+            "repeat": 3,
+            "prefix": "[Echo]"
+        }
+    )
+```
+
+> **Note:**: `test-pack` is the name of the process we created from the [previous package.](./getting_started_cli.md)
+
+### Verifying the Execution
+
+Open your browser and navigate to UiPath. Go to the specified folder, and you'll see a new job for `test-pack` has been executed. The output will be:
+
+```
+[Echo]: Hello, World! Echo: Hello, World! Echo: Hello, World!
+```

uipath-2.0.7/docs/index.md

@@ -0,0 +1,4 @@
+# Getting Started
+- [CLI Guide](./getting_started_cli.md) - Learn how to use the UiPath Python CLI
+- [SDK Guide](./getting_started_sdk.md) - Get started with the UiPath Python SDK
+- [Agent Guide](./getting_started_agent.md) - Learn about working with LangGraph and UiPath

{uipath-2.0.5 → uipath-2.0.7}/mkdocs.yml

@@ -34,9 +34,14 @@ theme:
   logo: assets/uipath-logo.svg
 
 nav:
-  - Getting Started: getting_started.md
-  - Home:
+  - Getting Started:
       - index.md
+      - CLI: getting_started_cli.md
+      - SDK: getting_started_sdk.md
+      - Agent: getting_started_agent.md
+      - Cloud: getting_started_cloud.md
+  - UiPath SDK:
+      - sdk.md
       - Actions: actions.md
       - Assets: assets.md
       - Buckets: buckets.md
@@ -45,13 +50,13 @@ nav:
       - Jobs: jobs.md
       - Queues: queues.md
       - Processes: processes.md
-  - Langchain:
+  - UiPathLangchain:
       - plugins/uipath-langchain-python/README.md
       - Chat models: plugins/uipath-langchain-python/docs/chat_models.md
       - Context Grounding Chain: plugins/uipath-langchain-python/docs/context_grounding_chain.md
       - Context Grounding Retriever: plugins/uipath-langchain-python/docs/context_grounding_retriever.md
       - Interrupt models: plugins/uipath-langchain-python/docs/interrupt_models.md
-  - How To Contribute: how_to_contribute.md
+  - How To Contribute: CONTRIBUTING.md
 
 plugins:
   - search

{uipath-2.0.5 → uipath-2.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.0.5"
+version = "2.0.7"
 description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"

{uipath-2.0.5 → uipath-2.0.7}/src/uipath/_folder_context.py

@@ -46,17 +46,12 @@ class FolderContext:
 
         Returns:
             dict[str, str]: A dictionary containing the appropriate folder
-                header (either folder key or folder path).
-
-        Raises:
-            ValueError: If neither folder key nor folder path is set in
-                the environment.
+                header (either folder key or folder path). If no folder header is
+                set as environment variable, the function returns an empty dictionary.
         """
         if self._folder_key is not None:
             return {HEADER_FOLDER_KEY: self._folder_key}
         elif self._folder_path is not None:
             return {HEADER_FOLDER_PATH: self._folder_path}
         else:
-            raise ValueError(
-                f"Folder key or path is not set ({ENV_FOLDER_KEY} or {ENV_FOLDER_PATH})"
-            )
+            return {}

{uipath-2.0.5 → uipath-2.0.7}/src/uipath/_services/actions_service.py

@@ -7,17 +7,24 @@ from .._config import Config
 from .._execution_context import ExecutionContext
 from .._folder_context import FolderContext
 from .._utils import Endpoint, RequestSpec
-from .._utils.constants import ENV_TENANT_ID, HEADER_TENANT_ID
+from .._utils.constants import (
+    ENV_TENANT_ID,
+    HEADER_FOLDER_KEY,
+    HEADER_FOLDER_PATH,
+    HEADER_TENANT_ID,
+)
 from ..models import Action, ActionSchema
 from ._base_service import BaseService
 
 
 def _create_spec(
-    title: str,
     data: Optional[Dict[str, Any]],
     action_schema: Optional[ActionSchema],
+    title: str,
     app_key: str = "",
     app_version: int = -1,
+    app_folder_key: str = "",
+    app_folder_path: str = "",
 ) -> RequestSpec:
     field_list = []
     outcome_list = []
@@ -97,14 +104,18 @@ def _create_spec(
                 else {},
             }
         ),
+        headers=folder_headers(app_folder_key, app_folder_path),
     )
 
 
-def _retrieve_action_spec(action_key: str) -> RequestSpec:
+def _retrieve_action_spec(
+    action_key: str, app_folder_key: str, app_folder_path: str
+) -> RequestSpec:
     return RequestSpec(
         method="GET",
         endpoint=Endpoint("/orchestrator_/tasks/GenericTasks/GetTaskDataByKey"),
         params={"taskKey": action_key},
+        headers=folder_headers(app_folder_key, app_folder_path),
     )
 
 
@@ -132,6 +143,15 @@ def _retrieve_app_key_spec(app_name: str) -> RequestSpec:
     )
 
 
+def folder_headers(app_folder_key: str, app_folder_path: str) -> Dict[str, str]:
+    headers = {}
+    if app_folder_key:
+        headers[HEADER_FOLDER_KEY] = app_folder_key
+    elif app_folder_path:
+        headers[HEADER_FOLDER_PATH] = app_folder_path
+    return headers
+
+
 class ActionsService(FolderContext, BaseService):
     """Service for managing UiPath Actions.
 
@@ -162,6 +182,8 @@ class ActionsService(FolderContext, BaseService):
         *,
         app_name: str = "",
         app_key: str = "",
+        app_folder_path: str = "",
+        app_folder_key: str = "",
         app_version: int = -1,
         assignee: str = "",
     ) -> Action:
@@ -175,6 +197,8 @@ class ActionsService(FolderContext, BaseService):
             data: Optional dictionary containing input data for the action
             app_name: The name of the application (if creating an app-specific action)
             app_key: The key of the application (if creating an app-specific action)
+            app_folder_path: Optional folder path for the action
+            app_folder_key: Optional folder key for the action
             app_version: The version of the application
             assignee: Optional username or email to assign the task to
 
@@ -195,10 +219,12 @@ class ActionsService(FolderContext, BaseService):
             app_key=key,
             app_version=app_version,
             action_schema=action_schema,
+            app_folder_key=app_folder_key,
+            app_folder_path=app_folder_path,
         )
 
         response = await self.request_async(
-            spec.method, spec.endpoint, content=spec.content
+            spec.method, spec.endpoint, content=spec.content, headers=spec.headers
         )
         json_response = response.json()
         if assignee:
@@ -213,6 +239,8 @@ class ActionsService(FolderContext, BaseService):
         *,
         app_name: str = "",
         app_key: str = "",
+        app_folder_path: str = "",
+        app_folder_key: str = "",
         app_version: int = -1,
         assignee: str = "",
     ) -> Action:
@@ -226,6 +254,8 @@ class ActionsService(FolderContext, BaseService):
             data: Optional dictionary containing input data for the action
             app_name: The name of the application (if creating an app-specific action)
             app_key: The key of the application (if creating an app-specific action)
+            app_folder_path: Optional folder path for the action
+            app_folder_key: Optional folder key for the action
             app_version: The version of the application
             assignee: Optional username or email to assign the task to
 
@@ -244,48 +274,63 @@ class ActionsService(FolderContext, BaseService):
             app_key=key,
             app_version=app_version,
             action_schema=action_schema,
+            app_folder_key=app_folder_key,
+            app_folder_path=app_folder_path,
         )
 
-        response = self.request(spec.method, spec.endpoint, content=spec.content)
+        response = self.request(
+            spec.method, spec.endpoint, content=spec.content, headers=spec.headers
+        )
         json_response = response.json()
         if assignee:
             spec = _assign_task_spec(json_response["id"], assignee)
-            print(spec)
             self.request(spec.method, spec.endpoint, content=spec.content)
         return Action.model_validate(json_response)
 
     def retrieve(
-        self,
-        action_key: str,
+        self, action_key: str, app_folder_path: str = "", app_folder_key: str = ""
     ) -> Action:
         """Retrieves an action by its key synchronously.
 
         Args:
             action_key: The unique identifier of the action to retrieve
+            app_folder_path: Optional folder path for the action
+            app_folder_key: Optional folder key for the action
 
         Returns:
             Action: The retrieved action object
         """
-        spec = _retrieve_action_spec(action_key=action_key)
-        response = self.request(spec.method, spec.endpoint, params=spec.params)
+        spec = _retrieve_action_spec(
+            action_key=action_key,
+            app_folder_key=app_folder_key,
+            app_folder_path=app_folder_path,
+        )
+        response = self.request(
+            spec.method, spec.endpoint, params=spec.params, headers=spec.headers
+        )
 
         return Action.model_validate(response.json())
 
     async def retrieve_async(
-        self,
-        action_key: str,
+        self, action_key: str, app_folder_path: str = "", app_folder_key: str = ""
     ) -> Action:
         """Retrieves an action by its key asynchronously.
 
         Args:
             action_key: The unique identifier of the action to retrieve
+            app_folder_path: Optional folder path for the action
+            app_folder_key: Optional folder key for the action
 
         Returns:
             Action: The retrieved action object
         """
-        spec = _retrieve_action_spec(action_key=action_key)
+        spec = _retrieve_action_spec(
+            action_key=action_key,
+            app_folder_key=app_folder_key,
+            app_folder_path=app_folder_path,
+        )
         response = await self.request_async(
-            spec.method, spec.endpoint, params=spec.params
+            spec.method, spec.endpoint, params=spec.params, headers=spec.headers
         )
 
         return Action.model_validate(response.json())
@@ -311,8 +356,25 @@ class ActionsService(FolderContext, BaseService):
         response = await self.request_org_scope_async(
             spec.method, spec.endpoint, params=spec.params, headers=spec.headers
         )
-        deployed_app = response.json()["deployed"][0]
-        return (deployed_app["systemName"], deployed_app["actionSchema"])
+        try:
+            deployed_app = response.json()["deployed"][0]
+            action_schema = deployed_app["actionSchema"]
+            deployed_app_key = deployed_app["systemName"]
+        except (KeyError, IndexError):
+            raise Exception("Action app not found") from None
+        try:
+            return (
+                deployed_app_key,
+                ActionSchema(
+                    key=action_schema["key"],
+                    in_outs=action_schema["inOuts"],
+                    inputs=action_schema["inputs"],
+                    outputs=action_schema["outputs"],
+                    outcomes=action_schema["outcomes"],
+                ),
+            )
+        except KeyError:
+            raise Exception("Failed to deserialize action schema") from KeyError
 
     def __get_app_key_and_schema(
         self, app_name: str
@@ -326,18 +388,25 @@ class ActionsService(FolderContext, BaseService):
             spec.method, spec.endpoint, params=spec.params, headers=spec.headers
         )
 
-        deployed_app = response.json()["deployed"][0]
-        action_schema = deployed_app["actionSchema"]
-        return (
-            deployed_app["systemName"],
-            ActionSchema(
-                key=action_schema["key"],
-                in_outs=action_schema["inOuts"],
-                inputs=action_schema["inputs"],
-                outputs=action_schema["outputs"],
-                outcomes=action_schema["outcomes"],
-            ),
-        )
+        try:
+            deployed_app = response.json()["deployed"][0]
+            action_schema = deployed_app["actionSchema"]
+            deployed_app_key = deployed_app["systemName"]
+        except (KeyError, IndexError):
+            raise Exception("Action app not found") from None
+        try:
+            return (
+                deployed_app_key,
+                ActionSchema(
+                    key=action_schema["key"],
+                    in_outs=action_schema["inOuts"],
+                    inputs=action_schema["inputs"],
+                    outputs=action_schema["outputs"],
+                    outcomes=action_schema["outcomes"],
+                ),
+            )
+        except KeyError:
+            raise Exception("Failed to deserialize action schema") from KeyError
 
     @property
     def custom_headers(self) -> Dict[str, str]:

{uipath-2.0.5 → uipath-2.0.7}/src/uipath/_services/context_grounding_service.py

@@ -9,6 +9,7 @@ from .._folder_context import FolderContext
 from .._utils import Endpoint, RequestSpec
 from .._utils.constants import (
     HEADER_FOLDER_KEY,
+    HEADER_FOLDER_PATH,
     ORCHESTRATOR_STORAGE_BUCKET_DATA_SOURCE,
 )
 from ..models import IngestionInProgressException
@@ -326,7 +327,9 @@ class ContextGroundingService(FolderContext, BaseService):
         )
 
         if self._folder_key is None:
-            raise ValueError(f"Folder key is not set ({HEADER_FOLDER_KEY})")
+            raise ValueError(
+                f"Neither the folder key nor the folder path is set ({HEADER_FOLDER_KEY}, {HEADER_FOLDER_PATH})"
+            )
 
         return self.folder_headers
 

{uipath-2.0.5 → uipath-2.0.7}/src/uipath/models/interrupt_models.py

@@ -16,12 +16,14 @@ class WaitJob(BaseModel):
 
 
 class CreateAction(BaseModel):
-    name: Optional[str] = None
-    key: Optional[str] = None
     title: str
     data: Optional[Dict[str, Any]] = None
-    app_version: Optional[int] = 1
     assignee: Optional[str] = ""
+    app_name: Optional[str] = None
+    app_folder_path: Optional[str] = None
+    app_folder_key: Optional[str] = None
+    app_key: Optional[str] = None
+    app_version: Optional[int] = 1
 
 
 class WaitAction(BaseModel):

{uipath-2.0.5 → uipath-2.0.7}/uv.lock

@@ -2320,7 +2320,7 @@ wheels = [
 
 [[package]]
 name = "uipath"
-version = "2.0.5"
+version = "2.0.7"
 source = { editable = "." }
 dependencies = [
     { name = "click" },