peak-sdk 1.5.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

peak/_metadata.py

@@ -24,13 +24,14 @@ The metadata represents the following:
     - table_params: Parameters required for the table output formatting.
     - request_body_yaml_path: File containing the yaml file examples for the command.
 """
+
+from __future__ import annotations
+
 from typing import Any, Dict, List
 
 
 def tag_parser(data: Any) -> str:
-    tag_array = []
-    for tag in data:
-        tag_array.append(tag["name"])
+    tag_array = [tag["name"] for tag in data]
     return ", ".join(tag_array)
 
 
@@ -594,6 +595,26 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "revisionCount",
         },
     },
+    "execute_resources": {
+        "table_params": {
+            "output_keys": {
+                "blockSpecId": {
+                    "label": "Block Spec ID",
+                },
+                "version": {
+                    "label": "Version",
+                },
+                "executionId": {
+                    "label": "Execution ID",
+                },
+                "status": {
+                    "label": "Execution Status",
+                },
+            },
+            "title": "Trigger Resources",
+            "data_key": "executeResponse",
+        },
+    },
     "list_tenant_instance_options": {
         "table_params": {
             "output_keys": {
@@ -623,6 +644,57 @@ command_metadata: Dict[str, Any] = {
             "data_key": "data",
         },
     },
+    "list_emails": {
+        "table_params": {
+            "output_keys": {
+                "id": {
+                    "label": "ID",
+                },
+                "subject": {
+                    "label": "Subject",
+                },
+                "status": {
+                    "label": "Status",
+                },
+                "templateName": {
+                    "label": "Template Name",
+                },
+                "createdAt": {
+                    "label": "Created At",
+                },
+                "createdBy": {
+                    "label": "Created By",
+                },
+            },
+            "title": "Emails",
+            "data_key": "emails",
+            "subheader_key": "emailCount",
+        },
+    },
+    "list_templates": {
+        "table_params": {
+            "output_keys": {
+                "id": {
+                    "label": "ID",
+                },
+                "name": {
+                    "label": "Name",
+                },
+                "scope": {
+                    "label": "Status",
+                },
+                "createdAt": {
+                    "label": "Created At",
+                },
+                "createdBy": {
+                    "label": "Created By",
+                },
+            },
+            "title": "Templates",
+            "data_key": "templates",
+            "subheader_key": "templateCount",
+        },
+    },
     "create_artifact": {
         "request_body_yaml_path": "sample_yaml/resources/artifacts/create_artifact.yaml",
     },
@@ -680,6 +752,9 @@ command_metadata: Dict[str, Any] = {
     "test_service": {
         "request_body_yaml_path": "sample_yaml/resources/services/test_service.yaml",
     },
+    "send_email": {
+        "request_body_yaml_path": "sample_yaml/resources/emails/send_email.yaml",
+    },
     "create_app_spec": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/create_app_spec.yaml",
     },
@@ -699,13 +774,13 @@ command_metadata: Dict[str, Any] = {
         "request_body_yaml_path": "sample_yaml/press/apps/deployments/update_app_deployment_metadata.yaml",
     },
     "create_block_spec": {
-        "request_body_yaml_path": "sample_yaml/press/blocks/specs/create_block_spec.yaml",
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml",
     },
     "update_block_spec_metadata": {
         "request_body_yaml_path": "sample_yaml/press/blocks/specs/update_block_spec_metadata.yaml",
     },
     "create_block_spec_release": {
-        "request_body_yaml_path": "sample_yaml/press/blocks/specs/create_block_spec_release.yaml",
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml",
     },
     "create_block_deployment": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/create_block_deployment.yaml",

peak/_version.py

@@ -18,4 +18,4 @@
 # # You should have received a copy of the APACHE LICENSE, VERSION 2.0
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
-__version__: str = "1.5.0"
+__version__: str = "1.7.0"

peak/cli/args.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """CLI arguments."""
+
 import typer
 from peak.callbacks import dry_run, generate_yaml, handle_output, paging
 from peak.cli.version import display_version

peak/cli/cli.py

@@ -25,15 +25,16 @@ import peak.config
 import typer
 from peak.cli import args, helpers
 from peak.cli.press import apps, blocks, deployments, specs
-from peak.cli.resources import artifacts, images, services, tenants, users, webapps, workflows
+from peak.cli.resources import alerts, artifacts, images, services, tenants, users, webapps, workflows
 from peak.constants import Sources
 from peak.output import Writer
 
-# Hack to not gray out texts after first paragraph
+# Workaround to not gray out texts after first paragraph
 typer.rich_utils.STYLE_HELPTEXT = ""
 
 typer_app = typer.Typer(rich_markup_mode="markdown", help="Create and Manage Peak Resources")
 typer_app.add_typer(images.app, name="images")
+typer_app.add_typer(alerts.app, name="alerts")
 typer_app.add_typer(artifacts.app, name="artifacts")
 typer_app.add_typer(workflows.app, name="workflows")
 typer_app.add_typer(webapps.app, name="webapps")

peak/cli/helpers.py

@@ -252,5 +252,6 @@ def get_client(command: str) -> base_client.BaseClient:
         "webapps": resources.webapps,
         "tenants": resources.tenants,
         "users": resources.users,
+        "alerts": resources.alerts,
     }
     return command_client_map[command].get_client()  # type: ignore[no-any-return]

peak/cli/press/apps/specs.py

@@ -74,6 +74,7 @@ def create(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b
@@ -318,6 +319,7 @@ def create_release(
             - id (string): ID of the block spec.
               release (map):
                 version (string): A valid semantic release version of the block spec.
+              autoRunOnDeploy (bool | required: false): Whether to execute the resource after the app is deployed. By default it is False.
     ```
 
     \b

peak/cli/press/blocks/specs.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak blocks specs commands."""
+
 from typing import Dict, List, Optional
 
 import typer
@@ -109,6 +110,7 @@ def create(
     featured (bool | required: false): Boolean specifying whether to feature this spec.
     scope (str | required: false): Specify what tenants can discover and deploy this spec.
     tenants (list(str) | required: false): Given a shared scope, specify what other tenants can discover and deploy this spec.
+    autoRunOnDeploy (bool | required: false): Whether to execute the resource after the block is deployed. By default it is False.
     body (map):
         version (int): Version of the spec.
         kind (string): Specifies the type of spec.
@@ -124,8 +126,8 @@ def create(
         release (map):
             version (string): A valid semantic release version of the spec.
             notes (string | required: false): Notes for the release version.
-        config (map):
-            images(map | required: false):  # To be used only in case of workflow block.
+        config (map):   # For Workflow Block
+            images(map | required: false):
                 image-name (map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
                     dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -133,7 +135,7 @@ def create(
                     useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                     buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                     secrets (list(str)) | required: false): List of secret names to be passed.
-            steps (map | required: false):   # To be used only in case of workflow block.
+            steps (map | required: false):
                 <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
@@ -169,25 +171,45 @@ def create(
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.
                     fail (boolean | required: false): Whether to call event on failure.
-                    runtimeExceeded (int | required: false): The runtime after which event is called.
-                  user (string | required: false): User to be notified. To be added in case of user watcher.
-                  webhook (map | required: false): To be added in case of webhook watcher.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  user (string): User to be notified.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  webhook (map):
                     name (string): Name of the webhook.
                     url (string): URL of the webhook.
                     payload (string): Webhook payload.
-            image (map | required: false):  # To be used only in case of webapp block.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  email (map):
+                    name (string): Name of the email watcher.
+                    recipients (map):
+                        to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
+        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+            serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
+            image (map | required: false):
                 version (string | required: false): A valid semantic image version.
                 dockerfile (string | required: false): Path to the Dockerfile inside artifact.
                 context (string | required: false): The path within the artifact where the code to be executed by the Dockerfile is located.
                 useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                 buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                 secrets (list(str)) | required: false): List of secret names to be passed.
-            imageDetails (map | required: false):  # To be used only in case of webapp block.
+            imageDetails (map | required: false):
                 id (int): ID of the existing image.
-                versionId: (int): ID of the existing image version.
-            resources (map | required: false): To be used only in case of webapp block.
-                instanceTypeId (int): ID of the instance type to be used in the webapp.
-            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the webapp. It is false by default. To be used only in case of webapp block.
+                versionId: (int | required: false): ID of the existing image version. If not provided, the latest version will be used.
+            resources (map | required: false): To be used only in case of service block.
+                instanceTypeId (int): ID of the instance type to be used in the service block.
+            parameters (map | required: false):
+                env (map | required: false): Key-Value pair where key is the name of the env.
+                secrets (list(str) | required: false): List of secret names to be passed.
+            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            entrypoint (string | required: false): Entry point for the service.
+            healthCheckURL (string | required: false): URL to check the health of the service.
+            minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     parameters (map | required: false):
         <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
             name (string): Name of the parameter.
@@ -388,8 +410,8 @@ def create_release(
         release (map):
             version (string): A valid semantic release version of the spec. Must be greater than previous release version.
             notes (string | required: false): Notes for the release version.
-        config (map):
-            images(map | required: false):  # To be used only in case of workflow block.
+        config (map):   # For Workflow Block
+            images(map | required: false):
                 image-name(map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
                     dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -397,7 +419,7 @@ def create_release(
                     useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                     buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                     secrets (list(str)) | required: false): List of secret names to be passed.
-            steps(map | required: false):   # To be used only in case of workflow block.
+            steps(map | required: false):
                 <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
@@ -433,25 +455,45 @@ def create_release(
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.
                     fail (boolean | required: false): Whether to call event on failure.
-                    runtimeExceeded (int | required: false): The runtime after which event is called.
-                  user (string | required: false): User to be notified. To be added in case of user watcher.
-                  webhook (map | required: false): To be added in case of webhook watcher.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  user (string): User to be notified.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  webhook (map):
                     name (string): Name of the webhook.
                     url (string): URL of the webhook.
                     payload (string): Webhook payload.
-            image (map | required: false):  # To be used only in case of webapp block.
+                - events (map):
+                    success (boolean | required: false): Whether to call event on success.
+                    fail (boolean | required: false): Whether to call event on failure.
+                    runtimeExceeded (int | required: false): The runtime in minutes after which event is called.
+                  email (map):
+                    name (string): Name of the email watcher.
+                    recipients (map):
+                        to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
+        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+            serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
+            image (map | required: false):
                 version (string | required: false): A valid semantic image version.
                 dockerfile (string | required: false): Path to the Dockerfile inside artifact.
                 context (string | required: false): The path within the artifact where the code to be executed by the Dockerfile is located.
                 useCache (boolean | required: false): Whether to enable image caching to reduce build time, is enabled by default.
                 buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                 secrets (list(str)) | required: false): List of secret names to be passed.
-            imageDetails (map | required: false):  # To be used only in case of webapp block.
+            imageDetails (map | required: false):
                 id (int): ID of the existing image.
-                versionId: (int): ID of the existing image version.
-            resources (map | required: false): To be used only in case of webapp block.
-                instanceTypeId (int): ID of the instance type to be used in the webapp.
-            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the webapp. It is false by default. To be used only in case of webapp block.
+                versionId: (int | required: false): ID of the existing image version. If not provided, the latest version will be used.
+            resources (map | required: false):
+                instanceTypeId (int): ID of the instance type to be used in the service block.
+            parameters (map | required: false):
+                env (map | required: false): Key-Value pair where key is the name of the env.
+                secrets (list(str) | required: false): List of secret names to be passed.
+            sessionStickiness (boolean | required: false): Whether to enable session stickiness for the service. It is false by default. To be used only in case of service block of type web-app.
+            entrypoint (string | required: false): Entry point for the service.
+            healthCheckURL (string | required: false): URL to check the health of the service.
+            minInstances (number | required: false): Minimum number of instances that would run for a service. Default value is 1 and maximum value allowed is 2.
     parameters (map | required: false):
         <parameterType> (list(map)): List containing the parameter objects. Here the key is the type of the parameter. Accepted values are "build" or "run".
             name (string): Name of the parameter.
@@ -464,6 +506,7 @@ def create_release(
     artifact (map | required: false):
         path (str): Path to the artifact.
         ignore_files (list(str) | required: false) : Ignore files to use when creating artifact.
+    autoRunOnDeploy (bool | required: false): Whether to execute the resource after the block is deployed. By default it is False.
     ```
 
     \b
@@ -534,6 +577,7 @@ def describe_release(
         "createdBy": "someoneh@peak.ai",
         "id": "df113d64-ff44-4aa0-9278-edb03dae7a3f",
         "notes": "This is the original release",
+        "autoRunOnDeploy": false,
         "parameters": {...},
     }
     ```

peak/cli/press/deployments.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak deployments commands."""
+
 from typing import List, Optional
 
 import typer
@@ -84,3 +85,43 @@ def list_deployments(
             return_iterator=False,
         )
         writer.write(response)
+
+
+@app.command(short_help="Execute the resources of an app or block deployment", options_metavar="execute_resources")
+def execute_resources(
+    ctx: typer.Context,
+    deployment_id: str = typer.Argument(..., help="ID of the app or block deployment to execute resources for."),
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Execute*** the resources of an app or block deployment. This will execute the resources of the latest revision of the deployment for which `autoRunOnDeploy` property is enabled.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak deployments execute-resources <deployment_id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "executeResponse": [
+            {
+                "blockSpecId": "0bddb4c6-40c5-45c3-b477-fceb2c051609",
+                "version": "1.0.0",
+                "executionId": "a3e77006-86f3-4829-8c43-f21ad462dbbd",
+                "status": "executed"
+            }
+        ]
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployments/post_v1_deployments__deploymentId__trigger)
+    """
+    deployment_client: Deployment = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployment_client.execute_resources(deployment_id)
+        writer.write(response)

peak/cli/press/specs.py

@@ -35,6 +35,8 @@ app = typer.Typer(
 )
 console = Console()
 
+RELEASE_VERSION = typer.Option(None, help="The release version of the spec in valid semantic versioning format.")
+
 
 @app.command("list", short_help="List App and Block specs.", options_metavar="list_specs")
 def list_specs(
@@ -94,7 +96,7 @@ def list_specs(
 def list_release_deployments(
     ctx: typer.Context,
     spec_id: str = args.SPEC_ID,
-    version: str = args.RELEASE_VERSION,
+    version: Optional[str] = RELEASE_VERSION,
     page_size: Optional[int] = args.PAGE_SIZE,
     page_number: Optional[int] = args.PAGE_NUMBER,
     status: Optional[List[str]] = args.STATUS_FILTER_SPEC_RELEASES,
@@ -104,7 +106,7 @@ def list_release_deployments(
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
 ) -> None:
-    """***List*** all the deployments for a given spec release.
+    """***List*** all the deployments for a given spec. Version is optional and if not provided, all deployments for the spec will be returned.
 
     \b
     📝 ***Example usage:***<br/>

peak/cli/resources/alerts/__init__.py

@@ -0,0 +1,35 @@
+#
+# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# #
+# # Licensed under the Apache License, Version 2.0 (the "License"). You
+# # may not use this file except in compliance with the License. A copy of
+# # the License is located at:
+# #
+# # https://github.com/PeakBI/peak-sdk/blob/main/LICENSE
+# #
+# # or in the "license" file accompanying this file. This file is
+# # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# # ANY KIND, either express or implied. See the License for the specific
+# # language governing permissions and limitations under the License.
+# #
+# # This file is part of the peak-sdk.
+# # see (https://github.com/PeakBI/peak-sdk)
+# #
+# # You should have received a copy of the APACHE LICENSE, VERSION 2.0
+# # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
+#
+"""Alerts Module."""
+
+import typer
+from peak.cli.resources.alerts import emails
+
+app = typer.Typer(
+    help="Create and manage peak alerts.",
+    short_help="Create and manage peak alerts.",
+)
+app.add_typer(
+    emails.app,
+    name="emails",
+    help="Create and manage peak emails.",
+    short_help="Create and manage peak emails.",
+)