peak-sdk 1.12.0__py3-none-any.whl → 1.14.0__py3-none-any.whl

peak/_metadata.py

@@ -956,6 +956,9 @@ command_metadata: Dict[str, Any] = {
     "blocks>deployments>patch-parameters": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/patch_block_parameters.yaml",
     },
+    "deployments>patch-parameters": {
+        "request_body_yaml_path": "sample_yaml/press/patch_parameters.yaml",
+    },
     "metrics>publish": {
         "request_body_yaml_path": "sample_yaml/metrics/publish.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.12.0"
+__version__: str = "1.14.0"

peak/cli/press/apps/deployments.py

@@ -66,10 +66,13 @@ def create(
             imageUrl (string | required: false): URL of the image to be associated with the app deployment.
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of parameters for the block. Here the key is the name of the block.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -348,10 +351,13 @@ def create_revision(
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
       body (map):
+        appParameters (map | required: false):
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         parameters (map | required: false):
-            <blockName> (map): Dictionary of blocks within the app, for which to provide parameters. Must be a valid block name.
-                <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                    <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            <blockName> (map): Dictionary of parameters specific to each block, where each key represents the block name.
+                build (map | required: false): Dictionary of parameters for the block's 'build' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+                run (map | required: false): Dictionary of parameters for the block's 'run' phase. Keys are parameter names, and values can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the app spec.
         revision (map | required: false):

peak/cli/press/apps/specs.py

@@ -76,6 +76,16 @@ def create(
               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.
+      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.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b
@@ -332,6 +342,16 @@ def create_release(
               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.
+      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.
+            type (string): Type of the parameter. Should be one of "boolean", "string", "string_array", "number", "number_array", "object" and "object_array".
+            required (boolean): Whether the parameter is required.
+            description (string | required: false): Description of the parameter.
+            defaultValue (string | required: false): Default value of the parameter.
+            title (string | required: false): Title of the parameter.
+            options (list(str) | required: false): List of options for the parameter. If provided, it must have at least one object with "title" and "value" field.
+            hideValue(boolean | required: false): Can be optionally provided to parameters of type "string", to mask the parameter's value when it has been set at deployment time.
     ```
 
     \b

peak/cli/press/blocks/deployments.py

@@ -75,8 +75,8 @@ def create(
             tags (list(map) | required: false):
                 - name (string): Name of the tag.
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         revision (map | required: false):
             notes (string | required: false): Notes for the deployment revision.
         spec (map):
@@ -362,8 +362,8 @@ def create_revision(
     ```yaml
       body (map):
         parameters (map | required: false):
-            <parameterType> (map): Dictionary of parameters. Here the key is the type of the parameter. Accepted values are "build" or "run".
-                <parameterName> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+            build (map | required: false): Dictionary of parameters specific to the 'build' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+            run (map | required: false): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
         release (map):
             version (string): A valid semantic release version of the block spec.
         revision (map | required: false):
@@ -550,8 +550,7 @@ def patch_parameters(
     \b
     🧩 ***Input file schema (yaml):***<br/>
     ```yaml
-    body (map):
-        <key> (string | boolean | number | list(string)): Value of the parameter. Here the key is the name of the parameter.
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
     ```
 
     \b

peak/cli/press/deployments.py

@@ -23,9 +23,9 @@
 from typing import List, Optional
 
 import typer
-from peak.cli import args
-from peak.cli.args import OUTPUT_TYPES, PAGING
-from peak.constants import OutputTypes
+from peak.cli import args, helpers
+from peak.cli.args import DRY_RUN, GENERATE_YAML, OUTPUT_TYPES, PAGING
+from peak.constants import OutputTypes, OutputTypesNoTable
 from peak.output import Writer
 from peak.press.deployments import Deployment
 from rich.console import Console
@@ -36,6 +36,8 @@ app = typer.Typer(
 )
 console = Console()
 
+_DEPLOYMENT_ID = typer.Argument(..., help="ID of the Block deployment to be used in this operation")
+
 
 @app.command("list", short_help="List App and Block deployments.")
 def list_deployments(
@@ -123,3 +125,47 @@ def execute_resources(
     with writer.pager():
         response = deployment_client.execute_resources(deployment_id)
         writer.write(response)
+
+
+@app.command(short_help="Update the parameters for a deployment at run time.")
+def patch_parameters(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    paging: Optional[bool] = PAGING,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+    generate: Optional[bool] = GENERATE_YAML,  # noqa: ARG001
+) -> None:
+    """***Update*** the parameters for a deployment at run time.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+    body (map): Dictionary of parameters specific to the 'run' phase. Keys are parameter names, and values are the parameter values, which can be of type string, boolean, number, dictionary or list (string, number, dictionary).
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak deployments patch-parameters <deployment-id> /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {...}
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/Deployment%20Parameters/patch_v1_deployments__deploymentId__parameters_run)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    deployments_client: Deployment = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, deployments_client.patch_parameters)
+    writer: Writer = ctx.obj["writer"]
+
+    with writer.pager():
+        response = deployments_client.patch_parameters(deployment_id, **body)
+        writer.write(response)

peak/cli/resources/alerts/emails.py

@@ -55,6 +55,7 @@ _BCC = typer.Option(None, help="The email addresses of the recipients to be BCC'
 _LIST_TEMPLATE_NAME = typer.Option(None, help="Email Template Name to search for.")
 _LIST_TEMPLATE_SCOPE = typer.Option(None, help="List of type of template to filter the templates by.")
 _DESCRIBE_TEMPLATE_NAME = typer.Argument(None, help="The name of the email template.")
+_ATTACHMENTS = typer.Option(None, help="The path of files to be sent as the mail attachments.")
 
 
 @app.command("list", short_help="List all emails.")
@@ -132,6 +133,7 @@ def send_email(
     subject: Optional[str] = _SUBJECT,
     template_name: Optional[str] = _TEMPLATE_NAME,
     template_parameters: Optional[str] = _TEMPLATE_PARAMETERS,
+    attachments: Optional[List[str]] = _ATTACHMENTS,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
 ) -> None:
@@ -147,9 +149,10 @@ def send_email(
         subject (str | required: true): The subject of the email.
         templateName (str | required: true): The name of the email template.
         templateParameters (map | required: false): The parameters for the email template.
+        attachments (list(str) | required: false): The path of files to be sent as email attachments. A maximum of 3 files can be included, with each file not exceeding 10 MB. Supported file formats are: .pdf, .docx, .doc, .csv, .txt, .xlsx, .xls, and .zip.
     ```
 
-     \b
+    \b
     📝 ***Example usage:***
     ```bash
     peak alerts emails send '/path/to/email.yaml' --params-file '/path/to/values.yaml'
@@ -160,7 +163,7 @@ def send_email(
     \b
     📝 ***Example usage without yaml:***
     ```bash
-    peak alerts emails send --recipients <recipient_email_1> --recipients <recipient_email_2> --subject <email_subject> --template-name <template_name> --template-parameters '{"key": "value"}'
+    peak alerts emails send --recipients <recipient_email_1> --recipients <recipient_email_2> --subject <email_subject> --template-name <template_name> --template-parameters '{"key": "value"}' --attachments model.txt --attachments outputs
     ```
 
     \b
@@ -191,6 +194,7 @@ def send_email(
         body = helpers.remove_unknown_args(body, alert_client.send_email)
 
     updated_body = combine_dictionaries(body.get("body") or {}, user_options)
+    final_attachments = body.get("attachments", attachments)
 
     if recipients:
         updated_body["recipients"] = parse_list_of_strings(recipients)
@@ -209,7 +213,7 @@ def send_email(
         )
 
     with writer.pager():
-        response: Dict[str, Any] = alert_client.send_email(body=updated_body)
+        response: Dict[str, Any] = alert_client.send_email(body=updated_body, attachments=final_attachments)
         writer.write(response)
 
 
@@ -250,7 +254,7 @@ def describe(
             }
         ],
         "subject": "Hello, world!",
-        "templateName": "template_name",
+        "templateName": "template_name"
     }
     ```
 

peak/cli/resources/artifacts.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Peak Artifacts service commands."""
+
 from typing import Any, Dict, List, Optional
 
 import typer
@@ -179,6 +180,9 @@ def create(
     ```yaml
       name (str): Name of the artifact.
       description (str): Description of the artifact.
+      source (str | required: false): Source of the artifact.
+      scan (bool | required: false): Whether to scan the artifact for vulnerabilities.
+      validate (bool | required: false): Whether to validate the artifact. Source needs to be provided for the validation to work.
       artifact (map):
         path (str): Path to the artifact.
         ignore_files (list(str) | required: false): Ignore files to use when creating artifact.
@@ -305,6 +309,8 @@ def create_version(
     \b
     🧩 ***Input file schema(yaml):***<br/>
     ```yaml
+      scan (bool | required: false): Whether to scan the artifact for vulnerabilities.
+      validate (bool | required: false): Whether to validate the artifact. Source needs to be present in the artifact for the validation to work.
       artifact (map):
         path (str): Path to the artifact.
         ignore_files (list(str) | required: false): Ignore files to use when creating artifact.

peak/handler.py

@@ -24,7 +24,11 @@ from __future__ import annotations
 
 import contextlib
 import json
+import mimetypes
 from abc import ABC, ABCMeta, abstractmethod
+from io import BufferedReader
+from pathlib import Path
+from tempfile import SpooledTemporaryFile
 from typing import Any, Callable, ClassVar, Dict, Iterator, List, Optional, Tuple, Type, TypeVar, Union
 
 import requests
@@ -118,9 +122,10 @@ class HandlerUtils(AuthRetrySession):
     @contextlib.contextmanager
     def make_artifact(
         self,
-        path: Optional[str],
+        path: Optional[str | list[str]],
         body: Dict[str, Any],
         ignore_files: Optional[list[str]],
+        file_key: Optional[str] = "artifact",
     ) -> Iterator[MultipartEncoderMonitor]:
         """Create a multipart/form-data encoded file with given body and path as file.
 
@@ -128,23 +133,46 @@ class HandlerUtils(AuthRetrySession):
             path (Optional[str]): path to the file or folder that will be compressed and used as artifact
             ignore_files(Optional[list[str]]): Ignore files to be used when creating artifact
             body (Dict[str, Any]): body content to be sent with artifact
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Yields:
             MultipartEncoderMonitor: MultipartEncoderMonitor generator object
         """
         if path:
-            with compress(path, ignore_files) as fh:
-                check_file_size(fh)
-                encoder = MultipartEncoder(
-                    {
-                        **body,
-                        "artifact": (
+            with contextlib.ExitStack() as stack:
+                files: list[tuple[str, SpooledTemporaryFile[bytes] | BufferedReader, str | None]] = []
+                if isinstance(path, list):
+                    for p in path:
+                        file_path = Path(p)
+                        if file_path.is_dir():
+                            context = compress(p)
+                            compressed_file = stack.enter_context(context)
+                            file_name = f"{file_path.name}.zip"
+                            files.append((file_name, compressed_file, "application/zip"))
+                        else:
+                            fh = open(p, "rb")  # noqa: SIM115, PTH123
+                            stack.push(fh)
+                            file_name = file_path.name
+                            files.append((file_name, fh, mimetypes.guess_type(file_name)[0]))
+                else:
+                    context = compress(path, ignore_files)
+                    file = stack.enter_context(context)
+                    check_file_size(file)
+                    files.append(
+                        (
                             "artifact.zip",
-                            fh,
+                            file,
                             "application/zip",
                         ),
-                    },
+                    )
+
+                files_object = [(file_key, file) for file in files]
+                body_array = list(body.items())
+
+                encoder = MultipartEncoder(
+                    files_object + body_array,
                 )
+
                 callback = self._default_callback(encoder)
                 monitor = MultipartEncoderMonitor(encoder, callback)
                 yield monitor
@@ -226,9 +254,10 @@ class BaseHandler(ABC, HandlerUtils, metaclass=_CombinedMeta):
         headers: Dict[str, str],
         params: Optional[Dict[str, Any]],
         body: Optional[Dict[str, Any]],
-        path: Optional[str],
+        path: Optional[str | list[str]],
         ignore_files: Optional[list[str]],
         request_kwargs: OptionalSerializable,
+        file_key: Optional[str],
     ) -> requests.Response:
         """Placeholder handle method."""
         ...
@@ -244,11 +273,12 @@ class MultipartFormDataHandler(BaseHandler):
         url: str,
         method: HttpMethods,
         *,
-        path: Optional[str],
+        path: Optional[str | list[str]],
         headers: Dict[str, str],
         body: Optional[Dict[str, Any]],
         params: Optional[Dict[str, Any]] = None,  # noqa: ARG002
         ignore_files: Optional[list[str]] = None,
+        file_key: Optional[str] = "artifact",
         request_kwargs: OptionalSerializable = None,
     ) -> requests.Response:
         """Handle multipart/form-data requests.
@@ -262,13 +292,14 @@ class MultipartFormDataHandler(BaseHandler):
             path (Optional[str]): path to the file or folder that will be compressed and used as artifact
             request_kwargs (OptionalSerializable): extra arguments to be passed when making the request, defaults to None
             ignore_files(Optional[list[str]]): Ignore files to be used when creating artifact
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Returns:
             requests.Response: response of the request
         """
         self._add_retries()
 
-        with self.make_artifact(path, self.parse_args(body or {}), ignore_files) as monitor:
+        with self.make_artifact(path, self.parse_args(body or {}), ignore_files, file_key) as monitor:
             headers = {**headers, "Content-Type": monitor.content_type}
             response: Any = getattr(self, method.value)(url, data=monitor, headers=headers, **request_kwargs)
         return self.handle_response(response)
@@ -287,8 +318,9 @@ class ApplicationJsonHandler(BaseHandler):
         headers: Dict[str, str],
         params: Optional[Dict[str, Any]],
         body: Optional[Dict[str, Any]],
-        path: Optional[str] = None,  # noqa: ARG002
+        path: Optional[str | list[str]] = None,  # noqa: ARG002
         ignore_files: Optional[list[str]] = None,  # noqa: ARG002
+        file_key: Optional[str] = "artifact",  # noqa: ARG002
         request_kwargs: OptionalSerializable = None,
     ) -> requests.Response:
         """Handle application/json requests.
@@ -302,6 +334,7 @@ class ApplicationJsonHandler(BaseHandler):
             path (Optional[str]): path to the file or folder that will be compressed and used as artifact, not used in application/json handler
             request_kwargs (OptionalSerializable): extra arguments to be passed when making the request, defaults to None
             ignore_files(Optional[list[str]]): Ignore files to be used when creating artifact
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Returns:
             requests.Response: response of the request.
@@ -328,14 +361,18 @@ class Handler:
     def _pretty_print_request(
         *_: Any,
         content_type: str,
-        path: Optional[str] = None,
+        path: Optional[str | list[str]] = None,
         ignore_files: Optional[list[str]] = None,
         **kwargs: Any,
     ) -> None:
         writer.write(f"\nSample request: {json.dumps(kwargs, indent=2)}\n")
         if content_type == ContentType.MULTIPART_FORM_DATA.value and path is not None:
             writer.write("\nArtifact file tree:")
-            print_file_tree(get_files_to_include(path, ignore_files))
+            if isinstance(path, list):
+                for p in path:
+                    print_file_tree(get_files_to_include(p, ignore_files))
+            else:
+                print_file_tree(get_files_to_include(path, ignore_files))
 
     @telemetry
     def make_request(
@@ -346,9 +383,10 @@ class Handler:
         headers: Optional[Dict[str, str]] = None,
         params: Optional[Dict[str, Any]] = None,
         body: Optional[Dict[str, Any]] = None,
-        path: Optional[str] = None,
+        path: Optional[str | list[str]] = None,
         request_kwargs: Optional[Dict[str, int | bool | str | float]] = None,
         ignore_files: Optional[list[str]] = None,
+        file_key: Optional[str] = "artifact",
     ) -> requests.Response:
         """Redirects the request to the appropriate strategy based on the content type.
 
@@ -362,6 +400,7 @@ class Handler:
             path (Optional[str]): path to the file or folder that will be compressed and used as artifact, defaults to None
             request_kwargs(Dict[str, int | bool | str | float] | None): extra arguments to be passed when making the request.
             ignore_files(Optional[list[str]]): Ignore files to be used when creating artifact
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Returns:
             requests.Response: response json
@@ -395,6 +434,7 @@ class Handler:
             path=path,
             request_kwargs=request_kwargs,
             ignore_files=ignore_files,
+            file_key=file_key,
         )
 
 

peak/metrics/metrics.py

@@ -550,4 +550,4 @@ def get_client(session: Optional[Session] = None) -> Metric:
     return Metric(session)
 
 
-__all__ = ["get_client"]
+__all__: List[str] = ["get_client"]