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

peak/cli/resources/workflows.py

@@ -93,7 +93,7 @@ _COUNT = typer.Option(
 )
 
 
-@app.command(short_help="Create a new workflow.", options_metavar="create_workflow")
+@app.command(short_help="Create a new workflow.")
 def create(
     ctx: typer.Context,
     file: str = args.TEMPLATE_PATH,
@@ -216,7 +216,7 @@ def create(
         writer.write(response)
 
 
-@app.command(short_help="Update an existing workflow.", options_metavar="update_workflow")
+@app.command(short_help="Update an existing workflow.")
 def update(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -342,7 +342,6 @@ def update(
 
 @app.command(
     short_help="Create a new workflow or Update an existing workflow.",
-    options_metavar="create_or_update_workflow",
 )
 def create_or_update(
     ctx: typer.Context,
@@ -464,7 +463,7 @@ def create_or_update(
         writer.write(response)
 
 
-@app.command(short_help="Update required fields of an existing workflow.", options_metavar="patch_workflow")
+@app.command(short_help="Update required fields of an existing workflow.")
 def patch(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -640,7 +639,7 @@ def patch(
         writer.write(response)
 
 
-@app.command("list", short_help="List workflows.", options_metavar="list_workflows")
+@app.command("list", short_help="List workflows.")
 def list_workflows(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
@@ -690,7 +689,7 @@ def list_workflows(
         writer.write(response)
 
 
-@app.command(short_help="Describe details of a workflow.", options_metavar="describe_workflow")
+@app.command(short_help="Describe details of a workflow.")
 def describe(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -734,7 +733,7 @@ def describe(
         writer.write(response)
 
 
-@app.command(short_help="Delete a workflow.", options_metavar="delete_workflow")
+@app.command(short_help="Delete a workflow.")
 def delete(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -766,7 +765,7 @@ def delete(
         writer.write(response)
 
 
-@app.command(short_help="Start a workflow run.", options_metavar="execute_workflow")
+@app.command(short_help="Start a workflow run.")
 def execute(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -828,7 +827,7 @@ def execute(
         writer.write(response)
 
 
-@app.command(short_help="List all available resources.", options_metavar="list_workflow_resources")
+@app.command(short_help="List all available resources.")
 def list_resources(
     ctx: typer.Context,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
@@ -866,7 +865,7 @@ def list_resources(
         writer.write(response)
 
 
-@app.command(short_help="List default resources.", options_metavar="list_workflow_default_resources")
+@app.command(short_help="List default resources.")
 def list_default_resources(
     ctx: typer.Context,
     paging: Optional[bool] = PAGING,  # noqa: ARG001
@@ -899,7 +898,7 @@ def list_default_resources(
         writer.write(response)
 
 
-@app.command(short_help="List executions for the given workflow.", options_metavar="list_workflow_executions")
+@app.command(short_help="List executions for the given workflow.")
 def list_executions(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID,
@@ -951,7 +950,7 @@ def list_executions(
         writer.write(response)
 
 
-@app.command(short_help="Get workflow execution logs.", options_metavar="get_execution_logs")
+@app.command(short_help="Get workflow execution logs.")
 def get_execution_logs(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID_OPTION,
@@ -1039,7 +1038,7 @@ def get_execution_logs(
             next_token = response.get("nextToken", None)
 
 
-@app.command(short_help="Get workflow execution details.", options_metavar="get_execution_details")
+@app.command(short_help="Get workflow execution details.")
 def get_execution_details(
     ctx: typer.Context,
     workflow_id: int = _WORKFLOW_ID_OPTION,

peak/compression.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Compression module to create zip file to be used as artifact."""
+
 from __future__ import annotations
 
 import contextlib
@@ -26,7 +27,7 @@ import os
 import tempfile
 import zipfile
 from pathlib import Path
-from typing import Iterable, Iterator, Optional, Set
+from typing import Any, Dict, Iterable, Iterator, Optional, Set
 
 from pathspec import PathSpec
 
@@ -163,7 +164,7 @@ def _load_ignore_patterns(path_obj: Path, ignore_files: Optional[list[str]]) ->
 
 
 def print_file_tree(files: Iterable[str]) -> None:
-    """Prints list of files in tree format.
+    """Prints list of files in tree format with specific limits per level.
 
     Args:
         files (list[str]): List of file paths
@@ -171,33 +172,47 @@ def print_file_tree(files: Iterable[str]) -> None:
     writer = output.Writer(ignore_debug_mode=True)
     files_dict = _build_files_dict(files)
 
-    def _print_tree(files_dict: dict[str, dict], indent: str) -> None:  # type: ignore[type-arg]
+    limits = {1: 100, 2: 100, 3: 50}
+    default_limit = 25
+
+    def _print_tree(files_dict: Dict[str, Any], indent: str, level: int) -> None:
+        limit = limits.get(level, default_limit)
+        count = 0
+
+        for key, value in files_dict.items():
+            if isinstance(value, dict):
+                writer.write(f"{indent}{key}/")
+                new_indent = indent + ("|   " if indent else "├── ")
+                _print_tree(value, new_indent, level + 1)
+
         for key, value in files_dict.items():
-            writer.write(f"{indent}{key}")
-            if value:
-                new_indent = "|   " if indent else "├── "
-                _print_tree(value, new_indent + indent)
+            if not isinstance(value, dict):
+                if count >= limit:
+                    writer.write(f"{indent}...")
+                    break
+                writer.write(f"{indent}{key}")
+                count += 1
 
-    _print_tree(files_dict, "")
+    _print_tree(files_dict, "", 1)
 
 
-def _build_files_dict(files: Iterable[str]) -> dict[str, dict]:  # type: ignore[type-arg]
+def _build_files_dict(files: Iterable[str]) -> Dict[str, Any]:
     """Builds a nested dictionary from list of files.
 
     Args:
         files (list[str]): List of file paths to process.
 
     Returns:
-        dict[str, dict]: Nested dict file tree structure.
+        dict[str, Any]: Nested dict file tree structure.
     """
-    files_dict: dict[str, dict] = {}  # type: ignore[type-arg]
+    files_dict: Dict[str, Any] = {}
     for f in files:
         components = Path(os.path.normpath(f)).parts
         current_dir = files_dict
         for directory in components[:-1]:
-            if directory not in current_dir:
+            if directory not in current_dir or current_dir[directory] is None:
                 current_dir[directory] = {}
             current_dir = current_dir[directory]
         if components[-1] not in current_dir:
-            current_dir[components[-1]] = {}
+            current_dir[components[-1]] = None
     return files_dict

peak/exceptions.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Exceptions for the Peak API."""
+
 from __future__ import annotations
 
 from collections import defaultdict
@@ -103,6 +104,17 @@ class PayloadTooLargeException(BaseHttpException):
 
     STATUS_CODE = 413
 
+    def __init__(self, message: str = "") -> None:
+        """Throw exception with custom message.
+
+        Args:
+            message (str): Additional message to add to exception.
+        """
+        error_message: str = (
+            "Please use '--dry-run' with your command to preview the file tree and optimize the file contents."
+        )
+        super().__init__(f"{message}. {error_message}")
+
 
 class UnprocessableEntityException(BaseHttpException):
     """The server understands the request, but it was unable to process the contained instructions."""
@@ -154,7 +166,9 @@ class FileLimitExceededException(PeakBaseException):
             message (str): Additional message to add to exception.
             units (str): Units of the maximum size.
         """
-        error_message: str = f"Compressed directory size is over {max_size}{units}."
+        error_message: str = (
+            f"Compressed directory size is over {max_size}{units}. Please use '--dry-run' with your command to preview the file tree and optimize the file contents."
+        )
         super().__init__(f"{error_message} {message}")
 
 

peak/handler.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Handler for sending requests to the API."""
+
 from __future__ import annotations
 
 import contextlib
@@ -35,7 +36,7 @@ from urllib3.util import Retry
 import peak.config
 from peak.compression import compress, get_files_to_include, print_file_tree
 from peak.constants import ContentType, HttpMethods
-from peak.exceptions import BaseHttpException
+from peak.exceptions import BaseHttpException, PayloadTooLargeException
 from peak.output import Writer
 from peak.telemetry import telemetry
 from peak.validators import check_file_size
@@ -200,6 +201,9 @@ class HandlerUtils(AuthRetrySession):
         if 200 <= response.status_code < 300:  # noqa: PLR2004
             return response
 
+        if response.status_code == 413:  # noqa: PLR2004
+            raise PayloadTooLargeException(response.json().get("detail", ""))
+
         raise BaseHttpException.REGISTRY[response.status_code](response.json())
 
 

peak/helpers.py

@@ -20,10 +20,12 @@
 #
 
 """Collection of basic helper functions."""
+
 from __future__ import annotations
 
 import inspect
 import json
+import re
 from datetime import datetime, timezone
 from types import FrameType
 from typing import Any, Dict, List, Optional
@@ -205,6 +207,42 @@ def remove_none_values(data: Any) -> Dict[str, Any]:
     return data  # type: ignore[no-any-return]
 
 
+def convert_to_snake_case(s: str) -> str:
+    """Converts a given string from camelCase or TitleCase to snake case.
+
+    Args:
+        s (str): The string to be converted.
+
+    Returns:
+        str: The converted string in snake case.
+    """
+    return re.sub(r"(?<!^)(?=[A-Z])", "_", s).lower()
+
+
+def convert_keys_to_snake_case(data: Dict[str, Any], *, convert_nested: bool = False) -> Dict[str, Any]:
+    """Converts keys of a dictionary to snake case.
+
+    Args:
+        data (Dict[str, Any]): Dictionary to be converted.
+        convert_nested (bool): Whether to convert nested keys as well. Default is False.
+
+    Returns:
+        Dict[str, Any]: Dictionary with keys converted to snake case.
+    """
+
+    def convert_dict(d: Dict[str, Any]) -> Dict[str, Any]:
+        new_dict = {}
+        for k, v in d.items():
+            new_key = convert_to_snake_case(k)
+            if convert_nested and isinstance(v, dict):
+                new_dict[new_key] = convert_dict(v)
+            else:
+                new_dict[new_key] = v
+        return new_dict
+
+    return convert_dict(data)
+
+
 def format_date(timestamp: str, time_format: str = "%Y/%m/%d %H:%M:%S") -> str:
     """Format a timestamp to a given format.
 

peak/output.py

@@ -56,6 +56,7 @@ class Writer:
         self,
         data: Any,
         deprecation_message: str | None = None,
+        output_type: OutputTypes | None = None,
     ) -> None:
         """Write logs to the terminal.
 
@@ -63,27 +64,33 @@ class Writer:
             data (Any): Data to be printed on the terminal.
                 This handles dry-run, debug mode and exit code for the CLI.
             deprecation_message (str, optional): Deprecation message to be printed on the terminal.
+            output_type (OutputTypes, optional): Override for the output type set in the config.
         """
-        output_type = config.OUTPUT_TYPE
+        output_type_parsed = output_type or config.OUTPUT_TYPE
         table_params = config.TABLE_PARAMS
 
         if not config.DEBUG_MODE or self.ignore_debug_mode:
             if deprecation_message:
                 self._print_deprecation_warning(deprecation_message)
-            if output_type == OutputTypes.yaml.value:
+            if output_type_parsed == OutputTypes.yaml.value:
                 self.__yaml(data)
-            elif output_type == OutputTypes.table.value:
+            elif output_type_parsed == OutputTypes.table.value:
                 self.__table(data, table_params)
             else:
-                self.__json(data)
+                self.__json(data, output_type)
 
-    def __json(self, data: Any) -> None:
+    def __json(self, data: Any, output_type: OutputTypes | None = None) -> None:
         """Write logs to the terminal in JSON format.
 
         Args:
             data (Any): Data to be printed on the terminal.
+            output_type (OutputTypes): If passed, JSON parser would be used to print output
+                even if the data is not a dictionary.
         """
-        console.print(data)
+        if isinstance(data, dict) or output_type == OutputTypes.json:
+            console.print_json(data=data)
+        else:
+            console.print(data)
 
     def __table(self, data: dict[Any, Any], params: dict[str, Any]) -> None:
         """Write logs to the terminal in a tabular format.

peak/press/apps.py

@@ -709,6 +709,39 @@ class App(BaseClient):
             subdomain="press",
         )
 
+    def redeploy(self, deployment_id: str) -> Dict[str, Any]:
+        """Redeploy latest revision of an existing App deployment.
+
+        This function allows you to redeploy an App deployment that is in a `failed` or `warning` state, provided at least one of its block deployments is also in a `failed` or `warning` state.
+
+        REFERENCE:
+            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/App%20Deployments/post_v1_apps_deployments__deploymentId__redeploy>`__
+
+        Args:
+            deployment_id (str): The ID of the App deployment to redeploy.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing details of the deployment.
+
+        Raises:
+            BadRequestException: The given parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given App deployment or its revisions do not exist.
+            ConflictException: There is a conflict with the current state of the target resource.
+            UnprocessableEntityException: The server was unable to process the request.
+            InternalServerErrorException: the server encountered an unexpected condition that
+                prevented it from fulfilling the request.
+        """
+        method, endpoint = HttpMethods.POST, f"{self.DEPLOYMENTS_BASE_ENDPOINT}/{deployment_id}/redeploy"
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
     def delete_deployment(self, deployment_id: str) -> Dict[None, None]:
         """Deletes an App deployment.
 

peak/press/blocks.py

@@ -397,6 +397,8 @@ class Block(BaseClient):
                         }
 
         SCHEMA(Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
             .. code-block:: json
 
                 {   "build": [
@@ -790,6 +792,35 @@ class Block(BaseClient):
                             }
                         }
 
+        SCHEMA(Parameters):
+            The valid types for parameters are `boolean`, `string`, `string_array`, `number`, `number_array`, `object` and `object_array`.
+
+            .. code-block:: json
+
+                {   "build": [
+                        {
+                            "defaultValue": "string(required)",
+                            "description": "string",
+                            "hideValue": "boolean",
+                            "name": "string(required)",
+                            "required": "boolean(required)",
+                            "title": "string",
+                            "type": "string(required)",
+                        }
+                    ],
+                    "run": [
+                        {
+                            "defaultValue": "string(required)",
+                            "description": "string",
+                            "hideValue": "boolean",
+                            "name": "string(required)",
+                            "required": "boolean(required)",
+                            "title": "string",
+                            "type": "string(required)",
+                        }
+                    ]
+                }
+
         Raises:
             BadRequestException: The given parameters are invalid.
             UnauthorizedException: The credentials are invalid.
@@ -1187,6 +1218,38 @@ class Block(BaseClient):
             subdomain="press",
         )
 
+    def redeploy(self, deployment_id: str) -> Dict[str, Any]:
+        """Redeploy latest revision of an existing Block deployment.
+
+        This function allows you to redeploy a Block deployment that is in `failed` or `warning` state.
+
+        REFERENCE:
+            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/Block%20Deployments/post_v1_blocks_deployments__deploymentId__redeploy>`__
+
+        Args:
+            deployment_id (str): The ID of the Block deployment to redeploy.
+
+        Returns:
+            Dict[str, Any]: A dictionary containing details of the deployment.
+
+        Raises:
+            BadRequestException: The given parameters are invalid.
+            ConflictException: There is a conflict with the current state of the target resource.
+            ForbiddenException: The user does not have permission to perform the operation.
+            InternalServerErrorException: The server encountered an unexpected condition that
+                prevented it from fulfilling the request.
+            NotFoundException: The given block deployment or its revisions do not exist.
+            UnauthorizedException: The credentials are invalid.
+        """
+        method, endpoint = HttpMethods.POST, f"{self.DEPLOYMENTS_BASE_ENDPOINT}/{deployment_id}/redeploy"
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            subdomain="press",
+        )
+
     def delete_deployment(self, deployment_id: str) -> Dict[None, None]:
         """Deletes the Block deployment.
 

peak/press/deployments.py

@@ -132,9 +132,6 @@ class Deployment(BaseClient):
     def execute_resources(self, deployment_id: str) -> Dict[str, Any]:
         """Trigger the resources of an app or block deployment. This will execute the resources of the latest revision of the deployment.
 
-        REFERENCE:
-            🔗 `API Documentation <https://press.peak.ai/api-docs/index.htm#/Deployments/post_v1_deployments__deploymentId__trigger>`__
-
         Args:
             deployment_id (str): ID of the app or block deployment to trigger resources for.
 

peak/resources/tenants.py

@@ -31,7 +31,8 @@ from peak.session import Session
 class Tenant(BaseClient):
     """Tenant client class."""
 
-    BASE_ENDPOINT = "quota/api/v1"
+    QUOTA_BASE_ENDPOINT = "quota/api/v1"
+    CONNECTIONS_BASE_ENDPOINT = "connections/api/v1"
 
     def list_instance_options(
         self,
@@ -56,7 +57,7 @@ class Tenant(BaseClient):
             NotFoundException: The given image does not exist.
             InternalServerErrorException: The server failed to process the request.
         """
-        method, endpoint = HttpMethods.GET, f"{self.BASE_ENDPOINT}/settings/tenant-instance-options"
+        method, endpoint = HttpMethods.GET, f"{self.QUOTA_BASE_ENDPOINT}/settings/tenant-instance-options"
         params = {"entityType": entity_type}
 
         return self.session.create_request(  # type: ignore[no-any-return]
@@ -66,6 +67,40 @@ class Tenant(BaseClient):
             params=params,
         )
 
+    def get_credentials(
+        self,
+        data_store_type: Optional[str] = None,
+    ) -> Dict[str, Any]:
+        """Retrieve credentials for a given data store type.
+
+        REFERENCE:
+            🔗 `API Documentation <https://service.peak.ai/connections/api-docs/index.htm#/connections/get_api_v1_connections_credentials>`__
+
+        Args:
+            data_store_type (str): The type of the data store.
+                Allowed values are - data-warehouse.
+                Default - data-warehouse
+
+        Returns:
+            Dict[str, Any]: a dictionary containing the credentials for the data store.
+
+        Raises:
+            BadRequestException: The given request parameters are invalid.
+            UnauthorizedException: The credentials are invalid.
+            ForbiddenException: The user does not have permission to perform the operation.
+            NotFoundException: The given image does not exist.
+            InternalServerErrorException: The server failed to process the request.
+        """
+        method, endpoint = HttpMethods.GET, f"{self.CONNECTIONS_BASE_ENDPOINT}/connections/credentials"
+        params = {"type": data_store_type}
+
+        return self.session.create_request(  # type: ignore[no-any-return]
+            endpoint,
+            method,
+            content_type=ContentType.APPLICATION_JSON,
+            params=params,
+        )
+
 
 def get_client(session: Optional[Session] = None) -> Tenant:
     """Returns a Tenant client, If no session is provided, a default session is used.

peak/template.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Template module which handles all things related to templates."""
+
 from __future__ import annotations
 
 import os
@@ -32,7 +33,7 @@ from jinja2 import Environment
 from jinja2.ext import Extension
 
 from peak import exceptions
-from peak.helpers import remove_none_values
+from peak.helpers import convert_keys_to_snake_case, remove_none_values
 
 
 def _parse_jinja_template(template_path: Path, params: Dict[str, Any]) -> str:
@@ -53,6 +54,9 @@ def load_template(
     file: Union[Path, str],
     params: Optional[Dict[str, Any]] = None,
     description: Optional[str] = None,
+    markdown_data: Optional[Dict[str, str]] = None,
+    *,
+    convert_to_snake_case: Optional[bool] = False,
 ) -> Dict[str, Any]:
     """Load a template file through `Jinja` into a dictionary.
 
@@ -66,7 +70,10 @@ def load_template(
     Args:
         file (Union[Path, str]): Path to the templated `YAML` file to be loaded.
         params (Dict[str, Any] | None, optional): Named parameters to be passed to Jinja. Defaults to `{}`.
-        description ([str]): The description from the file extracted and added to the payload.
+        description (str, optional): Description of press entities in markdown format. Defaults to `None`. Note that this parameter will soon be deprecated. Use `markdown_data` instead.
+        markdown_data (Dict[str, str] | None, optional): Dictionary containing the markdown data to be inserted into the template.
+            The key is a colon-separated string representing the nested key path (e.g., "body:metadata:description"), and the value is the markdown content.
+        convert_to_snake_case (Optional[bool], optional): Convert the keys of the dictionary to snake_case. Defaults to `False`.
 
     Returns:
         Dict[str, Any]: Dictionary containing the rendered YAML file
@@ -75,9 +82,21 @@ def load_template(
     file = Path(file)
     template: str = _parse_jinja_template(file, params)
     parsed_data: Dict[str, Any] = yaml.safe_load(template)
+
+    if convert_to_snake_case:
+        parsed_data = convert_keys_to_snake_case(parsed_data)
+
     if description:
         parsed_data["body"]["metadata"]["description"] = description
 
+    if markdown_data:
+        for key, markdown_content in markdown_data.items():
+            keys = key.split(":")
+            target_dict = parsed_data
+            for k in keys[:-1]:
+                target_dict = target_dict.setdefault(k, {})
+            target_dict[keys[-1]] = markdown_content
+
     return remove_none_values(parsed_data)
 
 

{peak_sdk-1.7.0.dist-info → peak_sdk-1.9.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.7.0
+Version: 1.9.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
@@ -21,14 +21,14 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Typing :: Typed
 Requires-Dist: certifi (>=2024.2.2)
 Requires-Dist: jinja2 (>=3.1,<4.0)
-Requires-Dist: orjson (>=3.9.15,<4.0.0)
+Requires-Dist: orjson (>=3.10,<4.0)
 Requires-Dist: pathspec
 Requires-Dist: pyyaml (>=6.0,<7.0)
-Requires-Dist: requests (>=2.31,<3.0)
+Requires-Dist: requests (>=2.32,<3.0)
 Requires-Dist: requests-toolbelt (>=1.0,<2.0)
 Requires-Dist: shellingham (<1.5.4)
-Requires-Dist: structlog (>=24.1.0,<25.0.0)
-Requires-Dist: typer[all] (>=0.9,<0.10)
+Requires-Dist: structlog (>=24.2.0,<25.0.0)
+Requires-Dist: typer (>=0.12.3,<0.13.0)
 Requires-Dist: urllib3 (<2)
 Project-URL: Documentation, https://docs.peak.ai/sdk/latest/
 Description-Content-Type: text/markdown