peak-sdk 1.13.0__py3-none-any.whl → 1.15.0__py3-none-any.whl

peak/resources/alerts.py

@@ -23,6 +23,7 @@
 
 from __future__ import annotations
 
+import json
 from typing import Any, Dict, Iterator, List, Literal, Optional, overload
 
 from peak.base_client import BaseClient
@@ -126,6 +127,7 @@ class Alert(BaseClient):
     def send_email(
         self,
         body: Dict[str, Any],
+        attachments: Optional[list[str]] = None,
     ) -> Dict[str, Any]:
         """Send an email to the specified recipients using the specified template.
 
@@ -134,6 +136,8 @@ class Alert(BaseClient):
 
         Args:
             body (Dict[str, Any]): A dictionary containing the details of the email to send.
+            attachments (Optional[list[str]]): A list of file paths to attach to the email.
+                When a directory is provided, a zip is automatically created for the same.
 
         Returns:
             Dict[str, Any]: A dictionary containing the ID of the email sent.
@@ -161,11 +165,15 @@ class Alert(BaseClient):
         """
         method, endpoint = HttpMethods.POST, f"{self.BASE_ENDPOINT}/emails"
 
+        parsed_body = {k: json.dumps(v) if not isinstance(v, str) else v for (k, v) in body.items()}
+
         return self.session.create_request(  # type: ignore[no-any-return]
             endpoint,
             method,
-            body=body,
-            content_type=ContentType.APPLICATION_JSON,
+            body=parsed_body,
+            content_type=ContentType.MULTIPART_FORM_DATA,
+            path=attachments,
+            file_key="attachments",
         )
 
     def describe_email(self, email_id: int) -> Dict[str, Any]:

peak/resources/artifacts.py

@@ -19,12 +19,14 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Artifact client module."""
+
 from __future__ import annotations
 
 from typing import Any, Dict, Iterator, List, Literal, Optional, overload
 
 from peak.base_client import BaseClient
 from peak.constants import ArtifactInfo, ContentType, HttpMethods
+from peak.helpers import parse_body_for_multipart_request
 from peak.session import Session
 
 
@@ -104,6 +106,9 @@ class Artifact(BaseClient):
         name: str,
         artifact: ArtifactInfo,
         description: Optional[str] = None,
+        source: Optional[str] = None,
+        scan: Optional[bool] = None,
+        validate: Optional[bool] = None,
     ) -> Dict[str, Any]:
         """Create a new artifact.
 
@@ -115,6 +120,9 @@ class Artifact(BaseClient):
             artifact (ArtifactInfo):    Mapping of artifact attributes that specifies how the artifact will be generated,
                                         it accepts two keys `path`, which is required and `ignore_files` which is optional, and defaults to `.dockerignore`, it is strongly advised that users use `ignore_files` when generating artifacts to avoid copying any extra files in artifact.
             description (str | None): A brief description of the artifact.
+            source (str | None): The source of the artifact.
+            scan (bool | None): Whether to scan the artifact for vulnerabilities.
+            validate (bool | None): Whether to validate the artifact. Source needs to be provided for the validation to work.
 
         Returns:
             Dict[str, Any]: `Id` and `Version` of the created artifact.
@@ -127,13 +135,27 @@ class Artifact(BaseClient):
             InternalServerErrorException: The server failed to process the request.
         """
         method, endpoint = HttpMethods.POST, f"{self.BASE_ENDPOINT}/artifacts/"
-        body: Dict[str, Any] = {"name": name, "description": description}
+        body: Dict[str, Any] = {
+            "name": name,
+            "description": description,
+        }
+
+        if source is not None:
+            body["source"] = source
+
+        if scan is not None:
+            body["scan"] = scan
+
+        if validate is not None:
+            body["validate"] = validate
+
+        updated_body = parse_body_for_multipart_request(body)
 
         return self.session.create_request(  # type: ignore[no-any-return]
             endpoint,
             method,
             content_type=ContentType.MULTIPART_FORM_DATA,
-            body=body,
+            body=updated_body,
             path=artifact["path"],
             ignore_files=artifact.get("ignore_files"),
         )
@@ -205,6 +227,8 @@ class Artifact(BaseClient):
         self,
         artifact_id: str,
         artifact: ArtifactInfo,
+        scan: Optional[bool] = None,
+        validate: Optional[bool] = None,
     ) -> Dict[str, int]:
         """Create a new version of the artifact.
 
@@ -215,6 +239,8 @@ class Artifact(BaseClient):
             artifact_id (str): ID of the artifact for which a new version is to be created.
             artifact (ArtifactInfo):    Mapping of artifact attributes that specifies how the artifact will be generated,
                                         it accepts two keys `path`, which is required and `ignore_files` which is optional, and defaults to `.dockerignore`, it is strongly advised that users use `ignore_files` when generating artifacts to avoid copying any extra files in artifact.
+            scan (bool | None): Whether to scan the artifact for vulnerabilities.
+            validate (bool | None): Whether to validate the artifact. Source needs to be present in the artifact for the validation to work.
 
         Returns:
             Dict[str, int]: version number.
@@ -229,11 +255,21 @@ class Artifact(BaseClient):
         """
         method, endpoint = HttpMethods.PUT, f"{self.BASE_ENDPOINT}/artifacts/{artifact_id}"
 
+        body = {}
+
+        if scan is not None:
+            body["scan"] = scan
+
+        if validate is not None:
+            body["validate"] = validate
+
+        updated_body = parse_body_for_multipart_request(body)
+
         return self.session.create_request(  # type: ignore[no-any-return]
             endpoint,
             method,
             content_type=ContentType.MULTIPART_FORM_DATA,
-            body={},
+            body=updated_body,
             path=artifact["path"],
             ignore_files=artifact.get("ignore_files"),
         )

peak/sample_yaml/press/apps/specs/create_app_spec.yaml

@@ -87,6 +87,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 featured: true
 scope: shared
 tenants:

peak/sample_yaml/press/apps/specs/create_app_spec_release.yaml

@@ -76,3 +76,34 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3

peak/sample_yaml/press/blocks/specs/service/api/create_block_spec.yaml

@@ -90,6 +90,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/service/api/create_block_spec_release.yaml

@@ -81,6 +81,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec.yaml

@@ -92,6 +92,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/service/webapp/create_block_spec_release.yaml

@@ -83,6 +83,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/workflow/create_block_spec.yaml

@@ -172,6 +172,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/blocks/specs/workflow/create_block_spec_release.yaml

@@ -161,6 +161,37 @@ parameters:
       defaultValue:
         - input.csv
         - output.csv
+    - name: max_retries
+      type: number
+      required: false
+      title: Maximum Retries
+      description: Set maximum number of retry attempts
+      defaultValue: 3
+    - description: "specify the method to aggregate the data"
+      hideValue: true
+      required: true
+      title: "Aggregation Method"
+      name: "aggregation_method"
+      type: "string"
+      conditions:
+        - conditionType: "AND"
+          conditions:
+            - dependsOn: "max_retries"
+              operator: "equals"
+              value: 3
+            - dependsOn: "agg_type"
+              operator: "equals"
+              value: "AVG"
+    - description: "Specify the filtering criteria for data processing"
+      hideValue: true
+      required: true
+      title: "Filter Condition"
+      name: "filter_condition"
+      type: "string"
+      conditions:
+        - dependsOn: "max_retries"
+          operator: "equals"
+          value: 3
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/press/deployments/patch_app_parameters_v2.yaml

@@ -0,0 +1,15 @@
+# parameters.yaml
+
+body:
+  appParameters:
+    agg_type: "MAX"
+    num_iterations: 50
+    email_notifications: true
+    file_names:
+      - input.csv
+      - output.csv
+  parameters:
+    block1:
+      email_notifications: false
+    block2:
+      num_iterations: 10

peak/sample_yaml/press/deployments/patch_block_parameters_v2.yaml

@@ -0,0 +1,10 @@
+# parameters.yaml
+
+body:
+  parameters:
+    agg_type: "MAX"
+    num_iterations: 50
+    email_notifications: true
+    file_names:
+      - input.csv
+      - output.csv

peak/sample_yaml/resources/artifacts/create_artifact.yaml

@@ -2,6 +2,9 @@
 
 name: new-artifact
 description: Creating a new artifact
+source: "email"
+scan: True
+validate: True
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/resources/artifacts/create_artifact_version.yaml

@@ -1,5 +1,7 @@
 # artifact_version.yaml
 
+scan: True
+validate: False
 artifact:
   path: "."
   ignore_files:

peak/sample_yaml/resources/emails/send_email.yaml

@@ -13,3 +13,6 @@ body:
   templateParameters:
     name: John
     company: Peak
+attachments:
+  - model.txt
+  - outputs

peak/session.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 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
@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Session module for Peak API."""
+
 from __future__ import annotations
 
 import os
@@ -87,9 +88,10 @@ class Session:
         *,
         params: Optional[Dict[str, Any]] = None,
         body: Optional[Dict[str, Any]] = None,
-        path: Optional[str] = None,
+        path: Optional[str | list[str]] = None,
         ignore_files: Optional[list[str]] = None,
         subdomain: Optional[str] = "service",
+        file_key: Optional[str] = "artifact",
     ) -> Any:
         """Prepares a request to be sent over the network.
 
@@ -105,6 +107,7 @@ class Session:
             path (Optional[str] optional): path to the file or folder that will be compressed and used as artifact, required for multipart requests.
             ignore_files(Optional[list[str]]): Ignore files to be used when creating artifact, used only for multipart requests.
             subdomain (Optional[str]): Subdomain for the endpoint. Defaults to `service`.
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Returns:
             Any: response dict object.
@@ -124,6 +127,7 @@ class Session:
             session_meta={
                 "stage": self.stage,
             },
+            file_key=file_key,
         ).json()
 
     def create_generator_request(
@@ -240,7 +244,7 @@ class Session:
 
         logger.info("auth_token not given, searching for 'PEAK_AUTH_TOKEN' or 'API_KEY' in env variables")
         if not os.environ.get("API_KEY") and not os.environ.get("PEAK_AUTH_TOKEN"):
-            raise exceptions.MissingEnvironmentVariableException(env_var="PEAK_AUTH_TOKEN or API_KEY")
+            raise exceptions.MissingEnvironmentVariableException(env_var="PEAK_AUTH_TOKEN")
         if os.environ.get("PEAK_AUTH_TOKEN"):
             self.auth_token = os.environ["PEAK_AUTH_TOKEN"]
             return
@@ -251,12 +255,12 @@ class Session:
             self.stage = Stage(stage)
             return
 
-        logger.info("stage not given, searching for STAGE in env variables")
-        if not os.environ.get("STAGE"):
-            logger.info("STAGE environment variable is not set, defaulting to PROD")
+        logger.info("stage not given, searching for PEAK__STAGE in env variables")
+        if not os.environ.get("PEAK__STAGE"):
+            logger.info("PEAK__STAGE environment variable is not set, defaulting to PROD")
             self.stage = Stage.PROD
             return
-        self.stage = Stage(os.environ["STAGE"])
+        self.stage = Stage(os.environ["PEAK__STAGE"])
 
 
 __all__: List[str] = ["Session", "_get_default_session"]

peak/telemetry.py

@@ -103,10 +103,11 @@ def telemetry(make_request: F) -> F:
         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,
         session_meta: Optional[Dict[str, Any]] = None,
+        file_key: Optional[str] = "artifact",
     ) -> requests.Response:
         """A decorator that wraps over the make_request function to send telemetry requests as required.
 
@@ -122,6 +123,7 @@ def telemetry(make_request: F) -> F:
             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
             session_meta(Dict[str, Any]): Metadata about the session object, like - stage
+            file_key (Optional[str]): the field in which the files must be uploaded
 
         Returns:
             requests.Response: response json
@@ -192,6 +194,7 @@ def telemetry(make_request: F) -> F:
                 path=path,
                 ignore_files=ignore_files,
                 request_kwargs=request_kwargs,
+                file_key=file_key,
             )
 
             trigger_usage_collection(res=res)

peak/tools/logging/logger.py

@@ -1,5 +1,5 @@
 #
-# # Copyright © 2024 Peak AI Limited. or its affiliates. All Rights Reserved.
+# # Copyright © 2025 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
@@ -84,7 +84,7 @@ def peak_contexts_processor(
         "press_deployment_id": os.getenv("PRESS_DEPLOYMENT_ID"),
         "run_id": os.getenv("PEAK_RUN_ID"),
         "exec_id": os.getenv("PEAK_EXEC_ID"),
-        "stage": os.getenv("STAGE"),
+        "stage": os.getenv("PEAK__STAGE"),
         "tenant_name": os.getenv("TENANT_NAME", os.getenv("TENANT")),
         "tenant_id": os.getenv("TENANT_ID"),
         "api_name": os.getenv("PEAK_API_NAME"),

{peak_sdk-1.13.0.dist-info → peak_sdk-1.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.13.0
+Version: 1.15.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
@@ -106,7 +106,7 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should return a response of the following format
 
     ```bash
-    peak-cli==1.13.0
+    peak-cli==1.15.0
     Python==3.12.3
     System==Darwin(23.6.0)
     ```
@@ -122,14 +122,14 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should print the version of the SDK
 
     ```
-    1.13.0
+    1.15.0
     ```
 
 ### Using the SDK and CLI
 
--   To start using the SDK and CLI, you'll need either an API Key or a Personal Access Token (PAT).
--   If you don't have one yet, sign up for an account on the Peak platform to obtain your API key or Personal Access token (PAT).
--   To export it, run the following command in your terminal and replace <peak_auth_token> with your actual API key or PAT:
+-   To start using the SDK and CLI, you'll need a Personal Access Token (PAT).
+-   If you don't have one yet, sign up for an account on the Peak platform to obtain your Personal Access token (PAT).
+-   To export it, run the following command in your terminal and replace <peak_auth_token> with your actual PAT:
     ```
     export PEAK_AUTH_TOKEN=<peak_auth_token>
     ```