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

peak/__init__.py

@@ -20,7 +20,7 @@
 #
 """This file is part of the peak-sdk framework.
 
-Copyright © 2023 Peak AI
+Copyright © 2024 Peak AI
 
 Unauthorized copying of this file, via any medium is strictly prohibited.
 """

peak/_metadata.py

@@ -241,6 +241,37 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "webappsCount",
         },
     },
+    "list_services": {
+        "table_params": {
+            "output_keys": {
+                "id": {
+                    "label": "ID",
+                },
+                "name": {
+                    "label": "Name",
+                },
+                "serviceType": {
+                    "label": "Service Type",
+                },
+                "status": {
+                    "label": "Status",
+                },
+                "updatedBy": {
+                    "label": "Updated By",
+                },
+                "updatedAt": {
+                    "label": "Updated At (UTC)",
+                },
+                "tags": {
+                    "label": "Tags",
+                    "parser": tag_parser,
+                },
+            },
+            "title": "Services",
+            "data_key": "services",
+            "subheader_key": "servicesCount",
+        },
+    },
     "list_artifacts": {
         "table_params": {
             "output_keys": {
@@ -637,6 +668,18 @@ command_metadata: Dict[str, Any] = {
     "create_or_update_webapp": {
         "request_body_yaml_path": "sample_yaml/resources/webapps/create_or_update_webapp.yaml",
     },
+    "create_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/create_service.yaml",
+    },
+    "update_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/update_service.yaml",
+    },
+    "create_or_update_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/create_or_update_service.yaml",
+    },
+    "test_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/test_service.yaml",
+    },
     "create_app_spec": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/create_app_spec.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.2.1"
+__version__: str = "1.4.0"

peak/cli/args.py

@@ -33,6 +33,15 @@ TEMPLATE_PATH = typer.Argument(
     """,
 )
 
+TEMPLATE_DESCRIPTION_FILE = typer.Option(
+    None,
+    "--desc-file",
+    "-d",
+    help="""
+        Path to the file that defines the description for this operation, supports `md`, and `txt` files only.
+    """,
+)
+
 TEMPLATE_PARAMS_FILE = typer.Option(
     None,
     "--params-file",

peak/cli/cli.py

@@ -25,7 +25,7 @@ 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, tenants, webapps, workflows
+from peak.cli.resources import artifacts, images, services, tenants, webapps, workflows
 from peak.constants import Sources
 from peak.output import Writer
 
@@ -37,6 +37,7 @@ typer_app.add_typer(images.app, name="images")
 typer_app.add_typer(artifacts.app, name="artifacts")
 typer_app.add_typer(workflows.app, name="workflows")
 typer_app.add_typer(webapps.app, name="webapps")
+typer_app.add_typer(services.app, name="services")
 typer_app.add_typer(tenants.app, name="tenants")
 typer_app.add_typer(apps.app, name="apps")
 typer_app.add_typer(blocks.app, name="blocks")

peak/cli/helpers.py

@@ -71,29 +71,52 @@ def parse_params(params: Optional[List[str]]) -> Dict[str, str]:
     return _to_pass
 
 
+def check_file_extension(file_path: str) -> None:
+    """Checks if the file has a .txt or .md extension.
+
+    Args:
+        file_path (str): Path to the file to check.
+
+    Raises:
+        ValueError: If the file extension is not .txt or .md.
+    """
+    file_type = Path(file_path).suffix
+    if file_type not in [".txt", ".md"]:
+        msg = f"Unsupported file type: `{file_type}` Only .txt and .md files are supported."
+        raise ValueError(msg)
+
+
 def template_handler(
     file: str,
     params_file: Optional[str] = None,
     params: Optional[List[str]] = None,
+    description_file: Optional[str] = None,
 ) -> Dict[str, Any]:
     """Loads and returns the rendered template.
 
     Args:
         file (str): Path to the template file.
         params_file (Optional[str]): Path to the params map file.
+        description_file: (Optional[str]): Path to the description markdown/text file
         params (Optional[List[str]]): List of params to override.
 
     Returns:
         Dict[str, Any]: Rendered template with values substituted.
     """
     params_dict: Dict[str, Any] = {}
+    description: str = ""
     if params_file:
         with Path(params_file).open("r") as f:
             params_dict = yaml.safe_load(f.read())
 
+    if description_file:
+        check_file_extension(description_file)
+        with Path(description_file).open("r") as f:
+            description = f.read()
+
     params_dict = remove_none_values({**params_dict, **parse_params(params)})
 
-    return load_template(file, params_dict)
+    return load_template(file, params_dict, description)
 
 
 def remove_unknown_args(args: Dict[str, Any], func: Callable[..., Any]) -> Dict[str, Any]:
@@ -166,6 +189,31 @@ def parse_build_arguments(build_arguments: List[str]) -> List[Dict[str, str]]:
     return parsed_build_arguments
 
 
+def parse_envs(env: List[str]) -> Dict[str, str]:
+    """Parses envs provided via cli args to the format {arg1: value1}.
+
+    Args:
+        env (List[str]): List of envs provided via cli args.
+
+    Returns:
+        Dict[str, str]: Envs in the required format.
+
+    Raises:
+        BadParameterException: If a value is invalid.
+    """
+    parsed_envs: Dict[str, str] = {}
+    for env_arg in env:
+        try:
+            key, value = env_arg.split("=", 1)
+        except ValueError as err:
+            raise BadParameterException(
+                env_arg,
+                message="Invalid env format. It should in the --env arg1=value1 format",
+            ) from err
+        parsed_envs[key] = value
+    return parsed_envs
+
+
 def format_logs(logs: List[Dict[str, Any]]) -> str:
     """Formats logs into a readable format.
 
@@ -200,6 +248,7 @@ def get_client(command: str) -> base_client.BaseClient:
         "artifacts": resources.artifacts,
         "images": resources.images,
         "workflows": resources.workflows,
+        "services": resources.services,
         "webapps": resources.webapps,
         "tenants": resources.tenants,
     }

peak/cli/press/apps/deployments.py

@@ -19,6 +19,8 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak apps deployments commands."""
+from __future__ import annotations
+
 from typing import Dict, List, Optional
 
 import typer
@@ -39,6 +41,7 @@ _DEPLOYMENT_ID = typer.Argument(..., help="ID of the App deployment to be used i
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -92,7 +95,7 @@ def create(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, app_client.create_deployment)
 
     with writer.pager():
@@ -222,6 +225,7 @@ def update_metadata(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -268,7 +272,7 @@ def update_metadata(
     app_client = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, app_client.update_deployment_metadata)
 
     with writer.pager():

peak/cli/press/apps/specs.py

@@ -39,6 +39,7 @@ _SPEC_ID = typer.Argument(..., help="ID of the App spec to be used in this opera
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -94,7 +95,7 @@ def create(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, app_client.create_spec)
 
     with writer.pager():
@@ -199,6 +200,7 @@ def update_metadata(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -251,7 +253,7 @@ def update_metadata(
     app_client: App = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    data = helpers.template_handler(file, params_file, params)
+    data = helpers.template_handler(file, params_file, params, description_file)
     data = helpers.remove_unknown_args(data, app_client.update_spec_metadata)
 
     with writer.pager():

peak/cli/press/blocks/deployments.py

@@ -19,6 +19,8 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak blocks deployments commands."""
+from __future__ import annotations
+
 from typing import Dict, List, Optional
 
 import typer
@@ -37,12 +39,17 @@ _FALLBACK_PARAMS_FILE = typer.Option(
     None,
     help="File containing parameters to be used when deployment id is not present",
 )
+_FALLBACK_DETAILS_FILE = typer.Option(
+    None,
+    help="File containing details to be used when deployment id is not present",
+)
 
 
 @app.command(short_help="Create a Block deployment.", options_metavar="create_block_deployment")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -95,7 +102,7 @@ def create(
     blocks_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, blocks_client.create_deployment)
 
     with writer.pager():
@@ -200,6 +207,7 @@ def update_metadata(
     ctx: typer.Context,
     deployment_id: str = _DEPLOYMENT_ID,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -246,7 +254,7 @@ def update_metadata(
     blocks_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, blocks_client.update_deployment_metadata)
 
     with writer.pager():
@@ -515,3 +523,36 @@ def patch_parameters(
     with writer.pager():
         response = blocks_client.patch_parameters(deployment_id, **body)
         writer.write(response)
+
+
+@app.command(short_help="Get the info for related blocks within an app.", options_metavar="get_related_block_details")
+def get_related_block_details(
+    ctx: typer.Context,
+    deployment_id: Optional[str] = _DEPLOYMENT_ID_OPTION,
+    fallback_details_file: Optional[str] = _FALLBACK_DETAILS_FILE,
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Get*** the info for related blocks within an app.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak blocks deployments get_related_block_details --deployment-id=<deployment-id> --fallback-details-file=<path/to/fallback/details/file>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {...}
+    ```
+    """
+    blocks_client: Block = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = blocks_client.get_related_block_details(
+            deployment_id=deployment_id,
+            fallback_details_file=fallback_details_file,
+        )
+        writer.write(response)

peak/cli/press/blocks/specs.py

@@ -93,6 +93,7 @@ def list_block_specs(
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -164,7 +165,6 @@ def create(
                 - cron (string | required: false): A valid cron expression.
                   webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
                   webhookId (string | required: false): ID of the webhook.
-                  webhookPolicy (string | required: false): Policy of the webhook to be used. Should be one of "generate" or "preserve". It is "generate" by default.
             watchers (list(map) | required: false):
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.
@@ -222,7 +222,7 @@ def create(
     block_client: Block = ctx.obj["client"]
     writer: Writer = ctx.obj["writer"]
 
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     body = helpers.remove_unknown_args(body, block_client.create_spec)
 
     with writer.pager():
@@ -274,6 +274,7 @@ def update_metadata(
     ctx: typer.Context,
     spec_id: str = _SPEC_ID,
     file: str = args.TEMPLATE_PATH,
+    description_file: Optional[str] = args.TEMPLATE_DESCRIPTION_FILE,
     params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
     params: Optional[List[str]] = args.TEMPLATE_PARAMS,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -323,7 +324,7 @@ def update_metadata(
 
     🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Block%20Specs/patch_v1_blocks_specs__specId_)
     """
-    body = helpers.template_handler(file, params_file, params)
+    body = helpers.template_handler(file, params_file, params, description_file)
     writer: Writer = ctx.obj["writer"]
 
     block_client: Block = ctx.obj["client"]
@@ -428,7 +429,6 @@ def create_release(
                 cron (string | required: false): A valid cron expression.
                 webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
                 webhookId (string | required: false): ID of the webhook.
-                webhookPolicy (string | required: false): Policy of the webhook to be used. Should be one of "generate" or "preserve". It is "generate" by default.
             watchers (list(map) | required: false):
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.