peak-sdk 1.6.0__py3-none-any.whl → 1.8.0__py3-none-any.whl

peak/_metadata.py

@@ -36,7 +36,7 @@ def tag_parser(data: Any) -> str:
 
 
 command_metadata: Dict[str, Any] = {
-    "list_images": {
+    "images>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -73,7 +73,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "imageCount",
         },
     },
-    "list_image_versions": {
+    "images>list-versions": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -104,7 +104,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "versionCount",
         },
     },
-    "list_image_builds": {
+    "images>list-builds": {
         "table_params": {
             "output_keys": {
                 "buildId": {
@@ -131,7 +131,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "buildCount",
         },
     },
-    "list_workflows": {
+    "workflows>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -162,7 +162,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "workflowsCount",
         },
     },
-    "list_workflow_executions": {
+    "workflows>list-executions": {
         "table_params": {
             "output_keys": {
                 "executionId": {
@@ -183,7 +183,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "executionsCount",
         },
     },
-    "get_execution_details": {
+    "workflows>get-execution-details": {
         "table_params": {
             "output_keys": {
                 "name": {
@@ -214,7 +214,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "status",
         },
     },
-    "list_webapps": {
+    "webapps>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -242,7 +242,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "webappsCount",
         },
     },
-    "list_services": {
+    "services>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -273,7 +273,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "servicesCount",
         },
     },
-    "list_artifacts": {
+    "artifacts>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -297,7 +297,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "artifactCount",
         },
     },
-    "list_specs": {
+    "specs>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -325,7 +325,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "specCount",
         },
     },
-    "list_release_deployments": {
+    "specs>list-release-deployments": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -356,7 +356,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "deploymentCount",
         },
     },
-    "list_deployments": {
+    "deployments>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -387,7 +387,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "deploymentCount",
         },
     },
-    "list_app_specs": {
+    "apps>specs>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -415,7 +415,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "specCount",
         },
     },
-    "list_app_spec_releases": {
+    "apps>specs>list-releases": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -439,7 +439,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "releaseCount",
         },
     },
-    "list_app_deployments": {
+    "apps>deployments>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -470,7 +470,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "deploymentCount",
         },
     },
-    "list_app_deployment_revisions": {
+    "apps>deployments>list-revisions": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -491,7 +491,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "revisionCount",
         },
     },
-    "list_block_specs": {
+    "blocks>specs>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -519,7 +519,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "specCount",
         },
     },
-    "list_block_spec_releases": {
+    "blocks>specs>list-releases": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -543,7 +543,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "releaseCount",
         },
     },
-    "list_block_deployments": {
+    "blocks>deployments>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -574,7 +574,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "deploymentCount",
         },
     },
-    "list_block_deployment_revisions": {
+    "blocks>deployments>list-revisions": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -595,7 +595,27 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "revisionCount",
         },
     },
-    "list_tenant_instance_options": {
+    "deployments>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",
+        },
+    },
+    "tenants>list-instance-options": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -624,7 +644,7 @@ command_metadata: Dict[str, Any] = {
             "data_key": "data",
         },
     },
-    "list_emails": {
+    "alerts>emails>list": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -651,7 +671,7 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "emailCount",
         },
     },
-    "list_templates": {
+    "alerts>emails>list-templates": {
         "table_params": {
             "output_keys": {
                 "id": {
@@ -675,103 +695,103 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "templateCount",
         },
     },
-    "create_artifact": {
+    "artifacts>create": {
         "request_body_yaml_path": "sample_yaml/resources/artifacts/create_artifact.yaml",
     },
-    "update_artifact_metadata": {
+    "artifacts>update-metadata": {
         "request_body_yaml_path": "sample_yaml/resources/artifacts/update_artifact_metadata.yaml",
     },
-    "create_artifact_version": {
+    "artifacts>create-version": {
         "request_body_yaml_path": "sample_yaml/resources/artifacts/create_artifact_version.yaml",
     },
-    "create_image": {
+    "images>create": {
         "request_body_yaml_path": "sample_yaml/resources/images/upload/create_image.yaml",
     },
-    "create_image_version": {
+    "images>create-version": {
         "request_body_yaml_path": "sample_yaml/resources/images/upload/create_image_version.yaml",
     },
-    "update_version": {
+    "images>update-version": {
         "request_body_yaml_path": "sample_yaml/resources/images/upload/update_version.yaml",
     },
-    "create_or_update_image": {
+    "images>create-or-update": {
         "request_body_yaml_path": "sample_yaml/resources/images/upload/create_or_update_image.yaml",
     },
-    "create_workflow": {
+    "workflows>create": {
         "request_body_yaml_path": "sample_yaml/resources/workflows/create_workflow.yaml",
     },
-    "update_workflow": {
+    "workflows>update": {
         "request_body_yaml_path": "sample_yaml/resources/workflows/update_workflow.yaml",
     },
-    "create_or_update_workflow": {
+    "workflows>create-or-update": {
         "request_body_yaml_path": "sample_yaml/resources/workflows/create_or_update_workflow.yaml",
     },
-    "patch_workflow": {
+    "workflows>patch": {
         "request_body_yaml_path": "sample_yaml/resources/workflows/patch_workflow.yaml",
     },
-    "execute_workflow": {
+    "workflows>execute": {
         "request_body_yaml_path": "sample_yaml/resources/workflows/execute_workflow.yaml",
     },
-    "create_webapp": {
+    "webapps>create": {
         "request_body_yaml_path": "sample_yaml/resources/webapps/create_webapp.yaml",
     },
-    "update_webapp": {
+    "webapps>update": {
         "request_body_yaml_path": "sample_yaml/resources/webapps/update_webapp.yaml",
     },
-    "create_or_update_webapp": {
+    "webapps>create-or-update": {
         "request_body_yaml_path": "sample_yaml/resources/webapps/create_or_update_webapp.yaml",
     },
-    "create_service": {
+    "services>create": {
         "request_body_yaml_path": "sample_yaml/resources/services/create_service.yaml",
     },
-    "update_service": {
+    "services>update": {
         "request_body_yaml_path": "sample_yaml/resources/services/update_service.yaml",
     },
-    "create_or_update_service": {
+    "services>create-or-update": {
         "request_body_yaml_path": "sample_yaml/resources/services/create_or_update_service.yaml",
     },
-    "test_service": {
+    "services>test": {
         "request_body_yaml_path": "sample_yaml/resources/services/test_service.yaml",
     },
-    "send_email": {
+    "alerts>emails>send": {
         "request_body_yaml_path": "sample_yaml/resources/emails/send_email.yaml",
     },
-    "create_app_spec": {
+    "apps>specs>create": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/create_app_spec.yaml",
     },
-    "update_app_spec_metadata": {
+    "apps>specs>update-metadata": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/update_app_spec_metadata.yaml",
     },
-    "create_app_spec_release": {
+    "apps>specs>create-release": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/create_app_spec_release.yaml",
     },
-    "create_app_deployment": {
+    "apps>deployments>create": {
         "request_body_yaml_path": "sample_yaml/press/apps/deployments/create_app_deployment.yaml",
     },
-    "create_app_deployment_revision": {
+    "apps>deployments>create-revision": {
         "request_body_yaml_path": "sample_yaml/press/apps/deployments/create_app_deployment_revision.yaml",
     },
-    "update_app_deployment_metadata": {
+    "apps>deployments>update-metadata": {
         "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",
+    "blocks>specs>create": {
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml",
     },
-    "update_block_spec_metadata": {
+    "blocks>specs>update-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",
+    "blocks>specs>create-release": {
+        "request_body_yaml_path": "sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml",
     },
-    "create_block_deployment": {
+    "blocks>deployments>create": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/create_block_deployment.yaml",
     },
-    "create_block_deployment_revision": {
+    "blocks>deployments>create-revision": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/create_block_deployment_revision.yaml",
     },
-    "update_block_deployment_metadata": {
+    "blocks>deployments>update-metadata": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/update_block_deployment_metadata.yaml",
     },
-    "patch_block_parameters": {
+    "blocks>deployments>patch-parameters": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/patch_block_parameters.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.6.0"
+__version__: str = "1.8.0"

peak/callbacks.py

@@ -19,8 +19,11 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """All the Typer callbacks."""
+from __future__ import annotations
+
 from pathlib import Path
 
+import click
 import typer
 
 import peak.config
@@ -41,11 +44,28 @@ def paging(*, enable_paging: bool) -> None:
     peak.config.ENABLE_PAGING = enable_paging
 
 
+def get_full_command_name(ctx: typer.Context | click.core.Context | None) -> str:
+    """Callback to get the full command name."""
+    if ctx:
+        parent = get_full_command_name(ctx.parent)
+        if parent:
+            return f"{parent}>{ctx.info_name}"
+        return str(ctx.info_name)
+
+    return ""
+
+
+def get_command_name(ctx: typer.Context) -> str:
+    """Callback to get the parsed command name with first part removed."""
+    command = get_full_command_name(ctx)
+    return ">".join(command.split(">")[1:])
+
+
 def handle_output(output_type: OutputTypes, ctx: typer.Context) -> None:
     """Callback to handle CLI output type and set all the required parameters for Table output."""
     peak.config.OUTPUT_TYPE = output_type
 
-    command = ctx.command.options_metavar
+    command = get_command_name(ctx)
 
     if (command not in command_metadata) or ("table_params" not in command_metadata[command]):
         return
@@ -55,7 +75,7 @@ def handle_output(output_type: OutputTypes, ctx: typer.Context) -> None:
 
 def generate_yaml(ctx: typer.Context, generate_yaml: bool) -> None:  # noqa: FBT001 # pragma: no cover
     """Callback to generate yaml file."""
-    command = ctx.command.options_metavar
+    command = get_command_name(ctx)
 
     if (command not in command_metadata) or ("request_body_yaml_path" not in command_metadata[command]):
         return

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
@@ -159,3 +160,21 @@ FILE_NAME = typer.Option(
     None,
     help="Name or path of the file to save the logs.",
 )
+
+RELEASE_NOTES_FILE = typer.Option(
+    None,
+    "--release-notes-file",
+    "-n",
+    help="""
+        Path to the file that defines the release notes for this operation, supports `md`, and `txt` files only.
+    """,
+)
+
+REVISION_NOTES_FILE = typer.Option(
+    None,
+    "--revision-notes-file",
+    "-n",
+    help="""
+        Path to the file that defines the revision notes for this operation, supports `md`, and `txt` files only.
+    """,
+)

peak/cli/helpers.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Helper functions for Peak `cli`."""
+
 from __future__ import annotations
 
 import inspect
@@ -90,33 +91,36 @@ def template_handler(
     file: str,
     params_file: Optional[str] = None,
     params: Optional[List[str]] = None,
-    description_file: Optional[str] = None,
+    markdown_files: Optional[Dict[str, 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.
+        markdown_files (Optional[Dict[str, str]]): Dictionary of markdown files to load.
+            The key is a colon-separated string representing the nested key path (e.g., "body:metadata:description"), and the value is the path to the markdown file.
 
     Returns:
         Dict[str, Any]: Rendered template with values substituted.
     """
     params_dict: Dict[str, Any] = {}
-    description: str = ""
+    markdown_data: Dict[str, 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()
+    if markdown_files:
+        for key, value in markdown_files.items():
+            check_file_extension(value)
+            with Path(value).open("r") as f:
+                markdown_data[key] = f.read()
 
     params_dict = remove_none_values({**params_dict, **parse_params(params)})
 
-    return load_template(file, params_dict, description)
+    return load_template(file, params_dict, markdown_data=markdown_data, convert_to_snake_case=True)
 
 
 def remove_unknown_args(args: Dict[str, Any], func: Callable[..., Any]) -> Dict[str, Any]: