peak-sdk 1.2.1__py3-none-any.whl → 1.4.0__py3-none-any.whl

peak/cli/resources/webapps.py

@@ -20,7 +20,14 @@
 #
 
 #
-"""Peak Webapps service commands."""
+
+"""Peak Webapps commands.
+
+.. warning::
+    The ``Web Apps`` commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the ``Service`` commands, which offers all the features of ``Webapp`` along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the ``Service`` commands will ensure easier adoption of its advanced features and future updates.
+
+    For guidance on migrating to the ``Service`` and taking full advantage of its capabilities, please refer to the ``Service`` documentation.
+"""
 
 from typing import Any, Dict, List, Optional
 
@@ -34,7 +41,11 @@ from peak.resources.webapps import Webapp
 from typing_extensions import Annotated
 
 app = typer.Typer(
-    help="Visualize your data and predictions using Webapps. Please note that only generic (EKS-based) webapps are supported with CLI.",
+    help="""Visualize your data and predictions using Webapps.
+    ```yaml
+    NOTE: Please note that only generic (EKS-based) webapps are supported with CLI. **Note** that, the functionalities provided through the `Webapp` feature are deprecated and will eventually be removed. We recommend using the `Service` feature which offers a more comprehensive and flexible solution for managing web applications and API deployments.
+    ```
+    """,
     short_help="Create and Manage Webapps.",
 )
 
@@ -70,6 +81,8 @@ SESSION_STICKINESS = typer.Option(None, help="Enable session stickiness for the
 
 MAPPING = {"imageId": "imageDetails", "versionId": "imageDetails", "instanceTypeId": "resources"}
 
+DEPRECATION_MESSAGE = "The Web App commands are deprecated and will eventually be removed. We recommend using the Service feature which offers a more comprehensive and flexible solution for managing web applications and API deployments.\n"
+
 
 @app.command("list", short_help="List webapps.", options_metavar="list_webapps")
 def list_webapps(
@@ -83,6 +96,14 @@ def list_webapps(
 ) -> None:
     """***List*** all webapps that exist for the tenant.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     📝 ***Example usage:***<br/>
     ```bash
@@ -101,7 +122,7 @@ def list_webapps(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/list-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/list-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
@@ -114,7 +135,7 @@ def list_webapps(
             status=parse_list_of_strings(status),
             name=name,
         )
-        writer.write(response)
+        writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
 @app.command(short_help="Create a new webapp.", options_metavar="create_webapp")
@@ -137,6 +158,14 @@ def create(
 ) -> None:
     """***Create*** a new webapp and start its deployment.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     🧩 ***Input file schema(yaml):***<br/>
     ```yaml
@@ -172,7 +201,7 @@ def create(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/create-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/create-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
@@ -197,7 +226,7 @@ def create(
 
     with writer.pager():
         response = webapp_client.create_webapp(body=body)
-        writer.write(response)
+        writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
 @app.command(short_help="Update an existing webapp.", options_metavar="update_webapp")
@@ -220,6 +249,14 @@ def update(
 ) -> None:
     """***Update*** an existing webapp.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     When updating the webapp, it will trigger a redeployment only under specific conditions.
     Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId or sessionStickiness.
@@ -259,7 +296,7 @@ def update(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/update-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/update-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
@@ -282,7 +319,7 @@ def update(
 
     with writer.pager():
         response = webapp_client.update_webapp(webapp_id=webapp_id, body=body)
-        writer.write(response)
+        writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
 @app.command(short_help="Create a new webapp or Update an existing webapp.", options_metavar="create_or_update_webapp")
@@ -303,6 +340,14 @@ def create_or_update(
 ) -> None:
     """***Create*** a new webapp or ***Update*** an existing webapp based on webapp name and start its deployment.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     When updating the webapp, it will trigger a redeployment only under specific conditions.
     Redeployment is triggered if you make changes to any of the following parameters: imageId, versionId, instanceTypeId or sessionStickiness.
@@ -343,7 +388,7 @@ def create_or_update(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/create-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/create-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
@@ -367,7 +412,7 @@ def create_or_update(
     body = combine_dictionaries(body.get("body") or {}, user_options)
 
     response = webapp_client.create_or_update_webapp(body=body)
-    writer.write(response)
+    writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
 @app.command(short_help="Delete an existing webapp.", options_metavar="delete_webapp")
@@ -380,6 +425,14 @@ def delete(
 ) -> None:
     """***Delete*** an existing webapp.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     📝 ***Example usage:***<br/>
     ```bash
@@ -394,14 +447,14 @@ def delete(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/delete-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/delete-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
     with writer.pager():
         response = webapp_client.delete_webapp(webapp_id=webapp_id)
-        writer.write(response)
+        writer.write(response, deprecation_message=DEPRECATION_MESSAGE)
 
 
 @app.command(short_help="Describe details of a webapp.", options_metavar="describe_webapp")
@@ -413,6 +466,14 @@ def describe(
 ) -> None:
     """***Describe*** details for the specific webapp.
 
+    \b
+     ```yaml
+    NOTE: The Web Apps commands are deprecated and will eventually be removed. It is recommended that users begin transitioning to the Service commands, which offers all the features of Webapp along with the added capability of API deployment and other significant updates for enhanced functionality. Transitioning early to the Service commands will ensure easier adoption of its advanced features and future updates.
+    ```
+
+    \b
+    For more information on Services, please refer to the [**Service**](https://docs.peak.ai/sdk/latest/cli/reference.html#peak-services) documentation.
+
     \b
     📝 ***Example usage:***<br/>
     ```bash
@@ -442,11 +503,11 @@ def describe(
     }
     ```
 
-    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/get-webapp)
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Services/get-service)
     """
     webapp_client: Webapp = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
     with writer.pager():
         response = webapp_client.describe_webapp(webapp_id=webapp_id)
-        writer.write(response)
+        writer.write(response, deprecation_message=DEPRECATION_MESSAGE)

peak/cli/resources/workflows.py

@@ -106,7 +106,6 @@ def create(
         triggers (list(map) | required: false):
             - cron (string | required: false): A valid cron expression.
               webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
-              webhookPolicy (string | required: false): Policy of the webhook to be used. Should be "generate" when creating new worklfow.
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
@@ -219,7 +218,6 @@ def update(
         triggers (list(map) | required: false):
             - cron (string | required: false): A valid cron expression.
               webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
-              webhookPolicy (string | required: false): Policy of the webhook to be used. Should be "generate" or "preserve".
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
@@ -332,7 +330,6 @@ def create_or_update(
         triggers (list(map) | required: false):
             - cron (string | required: false): A valid cron expression.
               webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
-              webhookPolicy (string | required: false): Policy of the webhook to be used. Should be "generate" when creating new worklfow.
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.
@@ -475,7 +472,6 @@ def patch(
         triggers (list(map) | required: false):
             - cron (string | required: false): A valid cron expression.
               webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
-              webhookPolicy (string | required: false): Policy of the webhook to be used. Should be "generate" or "preserve".
         watchers (list(map) | required: false):
             - events (map):
                 success (boolean | required: false): Whether to call event on success.

peak/output.py

@@ -24,6 +24,7 @@ from __future__ import annotations
 
 import contextlib
 import json
+import sys
 from typing import Any, List
 
 import yaml
@@ -54,17 +55,21 @@ class Writer:
     def write(
         self,
         data: Any,
+        deprecation_message: str | None = None,
     ) -> None:
         """Write logs to the terminal.
 
         Args:
             data (Any): Data to be printed on the terminal.
                 This handles dry-run, debug mode and exit code for the CLI.
+            deprecation_message (str, optional): Deprecation message to be printed on the terminal.
         """
         output_type = config.OUTPUT_TYPE
         table_params = config.TABLE_PARAMS
 
         if not config.DEBUG_MODE or self.ignore_debug_mode:
+            if deprecation_message:
+                self._print_deprecation_warning(deprecation_message)
             if output_type == OutputTypes.yaml.value:
                 self.__yaml(data)
             elif output_type == OutputTypes.table.value:
@@ -178,5 +183,9 @@ class Writer:
             return console.pager(styles=True)
         return contextlib.nullcontext()
 
+    def _print_deprecation_warning(self, deprecation_message: str) -> None:
+        """Prints a deprecation warning message."""
+        print(f"\nNote: {deprecation_message}", file=sys.stderr)  # noqa: T201
+
 
 __all__: List[str] = ["Writer"]

peak/press/blocks.py

@@ -250,9 +250,6 @@ class Block(BaseClient):
                             {
                                 "webhook": "boolean"
                             },
-                            {
-                                "webhookPolicy": "string"
-                            }
                         ],
                         "watchers": [
                             {
@@ -342,7 +339,7 @@ class Block(BaseClient):
             🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/Block%20Specs/get_v1_blocks_specs__specId_>`__
 
         Args:
-            spec_id (str): The ID of the workflow spec to retrieve.
+            spec_id (str): The ID of the block spec to retrieve.
 
         Returns:
             Dict[str, Any]: Dictionary containing the details of the spec.
@@ -351,7 +348,7 @@ class Block(BaseClient):
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
             ForbiddenException: The user does not have permission to perform the operation.
-            NotFoundException: The given workflow spec does not exist.
+            NotFoundException: The given block spec does not exist.
             InternalServerErrorException: The server encountered an unexpected condition that
                 prevented it from fulfilling the request.
         """
@@ -406,7 +403,7 @@ class Block(BaseClient):
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
             ForbiddenException: The user does not have permission to perform the operation.
-            NotFoundException: The given Workflow spec does not exist.
+            NotFoundException: The given block spec does not exist.
             UnprocessableEntityException: The server was unable to process the request.
             InternalServerErrorException: The server encountered an unexpected condition that
                 prevented it from fulfilling the request.
@@ -527,9 +524,6 @@ class Block(BaseClient):
                             },
                             {
                                 "webhook": "boolean"
-                            },
-                            {
-                                "webhookPolicy": "string"
                             }
                         ],
                         "watchers": [
@@ -754,7 +748,7 @@ class Block(BaseClient):
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
             ForbiddenException: The user does not have permission to perform the operation.
-            NotFoundException: The given workflow spec release does not exist.
+            NotFoundException: The given block spec release does not exist.
             UnprocessableEntityException: The server was unable to process the request.
             InternalServerErrorException: The server encountered an unexpected condition that
                 prevented it from fulfilling the request.
@@ -935,7 +929,7 @@ class Block(BaseClient):
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
             ForbiddenException: The user does not have permission to perform the operation.
-            NotFoundException: The given Workflow spec does not exist.
+            NotFoundException: The given block spec does not exist.
             UnprocessableEntityException: The server was unable to process the request.
             InternalServerErrorException: The server encountered an unexpected condition that
                 prevented it from fulfilling the request.
@@ -1250,15 +1244,113 @@ class Block(BaseClient):
             subdomain="press",
         )
 
+    def get_related_block_details(
+        self,
+        deployment_id: Optional[str] = None,
+        fallback_details_file: Optional[str] = None,
+    ) -> List[Dict[str, Any]]:
+        """Get the info for related blocks within an app.
+
+        Args:
+            deployment_id (str | None): The ID of the deployment.
+            fallback_details_file (str | None): Path of the YAML file to be used when deployment_id is not present. should be a List of Dicts
+
+        Returns:
+            A list of dictionaries, where each dictionary represents a block with the following keys:
+            - "id" (str): The unique identifier of the block
+            - "resource_id" (str | None): The unique identifier of the block's main platform resource.
+                May be None if resource has been manually deleted or is awaiting creation
+            - "kind" (str): The type or category of the resource.
+            - "name" (str): The name of the resource.
+            - "status" (str): The current status of the block. The platform resource status can be inferred from this.
+
+        Example return value:
+            .. code-block:: json
+
+                [
+                    {   "id": "12345",
+                        "resource_id": "6789",
+                        "kind": "workflow",
+                        "name": "my-workflow",
+                        "status": "deployed",
+                    },
+                ]
+
+        Raises:
+            BadRequestException: The given parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given deployment does not exist.
+            InternalServerErrorException: The server encountered an unexpected condition that
+                prevented it from fulfilling the request.
+            TypeError: The YAML file is invalid.
+            ValueError: The YAML file is empty.
+            FileNotFoundError: File specified in fallback_details_file is not present.
+        """
+        final_deployment_id = os.getenv("PRESS_DEPLOYMENT_ID", deployment_id)
+
+        if not final_deployment_id:
+            if not fallback_details_file:
+                msg = "Please pass in a fallback details file when deployment id is not present"
+                raise TypeError(msg) from None
+
+            file_path = Path(fallback_details_file)
+            if not file_path.is_file():
+                msg = f"File - {fallback_details_file} does not exist. Please check the path again."
+                raise FileNotFoundError(msg) from None
+
+            with file_path.open() as file:
+                file_content = file.read().strip()
+                if not file_content:
+                    msg = f"{fallback_details_file} is an empty YAML file."
+                    raise ValueError(msg)
+
+                try:
+                    return list(yaml.safe_load(file_content))
+
+                except yaml.YAMLError:
+                    msg = f"{fallback_details_file} is not a valid YAML. Please validate the file content."
+                    raise TypeError(msg) from None
+
+        this_block = self.session.create_request(
+            f"v1/blocks/deployments/{final_deployment_id}",
+            HttpMethods.GET,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
+        if not isinstance(this_block, dict) or this_block.get("parent") is None:
+            return []
+
+        parent_id = this_block["parent"].get("id")
+
+        this_app = self.session.create_request(
+            f"v1/apps/deployments/{parent_id}",
+            HttpMethods.GET,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
+        return [
+            {
+                "id": block["deploymentId"],
+                "resource_id": block["platformId"],
+                "kind": block["kind"],
+                "name": block["name"],
+                "status": block["status"],
+            }
+            for block in this_app["latestRevision"]["blocks"]
+        ]
+
 
 def get_client(session: Optional[Session] = None) -> Block:
-    """Returns a Workflow Block client.
+    """Returns a Block client.
 
     Args:
         session (Optional[Session]): A Session Object. If no session is provided, a default session is used.
 
     Returns:
-        Block: the Workflow Block client object
+        Block: the Block client object
     """
     return Block(session)
 

peak/resources/__init__.py

@@ -23,6 +23,6 @@ from __future__ import annotations
 
 from typing import List
 
-from peak.resources import artifacts, images, tenants, webapps, workflows
+from peak.resources import artifacts, images, services, tenants, webapps, workflows
 
-__all__: List[str] = ["workflows", "images", "artifacts", "webapps", "tenants"]
+__all__: List[str] = ["workflows", "images", "artifacts", "webapps", "tenants", "services"]