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

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

@@ -0,0 +1,88 @@
+# block_spec_release.yaml
+
+body:
+  release:
+    version: 2.0.0
+    notes: This is a new release
+  config:
+    serviceType: api
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 20
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.125CPU, 0.125GB RAM)
+          value: 20
+        - title: Nano (0.25CPU, 0.5GB RAM)
+          value: 21
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 22
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"

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

@@ -0,0 +1,103 @@
+body:
+  version: 1
+  kind: service
+  metadata:
+    name: webapp-service-block
+    title: Web App Service Block
+    summary: Web App Service Block
+    description: Creating a new service block spec of type web-app.
+    descriptionContentType: text/markdown
+    imageUrl: https://my-block-pics.com/image-0.jpg
+    tags:
+      - name: CLI
+  release:
+    version: 1.0.0
+    notes: This is the original release
+  config:
+    serviceType: web-app
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    sessionStickiness: false
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 43
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.25CPU, 0.5GB RAM)
+          value: 43
+        - title: Nano (0.25CPU, 1GB RAM)
+          value: 44
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 45
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"
+featured: true
+scope: shared
+tenants:
+  - tenant1
+  - tenant2

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

@@ -0,0 +1,89 @@
+# block_spec_release.yaml
+
+body:
+  release:
+    version: 2.0.0
+    notes: This is a new release
+  config:
+    serviceType: web-app
+    image:
+      dockerfile: Dockerfile
+      context: "."
+      version: 0.0.1
+    parameters:
+      env:
+        param1: value1
+        param2: value2
+      secrets:
+        - secret1
+        - secret2
+    resources:
+      instanceTypeId: "@param:instance_type_id"
+    healthCheckURL: "@param:health_check_url"
+    sessionStickiness: false
+    entrypoint: |
+      python
+      app.py
+    minInstances: 1
+parameters:
+  build:
+    - defaultValue: /health
+      description: Enter the health check URL
+      name: health_check_url
+      required: true
+      title: Health Check URL
+      type: string
+      hideValue: false
+    - defaultValue: 43
+      description: Select an instance type
+      name: instance_type_id
+      options:
+        - title: Pico (0.25CPU, 0.5GB RAM)
+          value: 43
+        - title: Nano (0.25CPU, 1GB RAM)
+          value: 44
+        - title: Micro (0.5CPU, 1GB RAM)
+          value: 45
+      required: true
+      title: Instance Type ID
+      type: number
+  run:
+    - defaultValue: AVG
+      description: Select an aggregation function (e.g., AVG, SUM, COUNT)
+      name: agg_type
+      required: false
+      title: Agg Type
+      type: string
+      hideValue: true
+    - defaultValue: false
+      description: Enable email notifications
+      name: email_notifications
+      required: false
+      title: Email Notifications
+      type: boolean
+    - defaultValue: 10
+      description: Select the number of iterations
+      name: num_iterations
+      options:
+        - title: Low
+          value: 10
+        - title: Medium
+          value: 50
+        - title: High
+          value: 100
+      required: false
+      title: Number of Iterations
+      type: number
+    - defaultValue:
+        - input.csv
+        - output.csv
+      description: Specify input and output file names
+      name: file_names
+      required: true
+      title: File Names
+      type: string_array
+artifact:
+  path: "."
+  ignore_files:
+    - ".gitignore"
+    - ".dockerignore"

peak/sample_yaml/press/blocks/specs/{create_block_spec.yaml → workflow/create_block_spec.yaml}

@@ -38,7 +38,25 @@ body:
       - webhook:
           name: info
           url: https://abc.com/post
-          payload: '{ "pingback-url": "https:/workflow/123" }'
+          payload: |
+            {
+              "system": "external_system",
+              "action": "update",
+              "data": {
+                "field": "value",
+                "timestamp": "2024-05-20T12:00:00Z"
+              }
+            }
+        events:
+          success: false
+          fail: true
+          runtimeExceeded: "@param:runtime_exceeded"
+      - email:
+          name: "email-watcher-1"
+          recipients:
+            to:
+              - "user1@peak.ai"
+              - "user2@peak.ai"
         events:
           success: false
           fail: true
@@ -112,6 +130,7 @@ artifact:
     - ".gitignore"
     - ".dockerignore"
 featured: true
+autoRunOnDeploy: true
 scope: shared
 tenants:
   - tenant1

peak/sample_yaml/press/blocks/specs/{create_block_spec_release.yaml → workflow/create_block_spec_release.yaml}

@@ -27,7 +27,25 @@ body:
       - webhook:
           name: info
           url: https://abc.com/post
-          payload: '{ "pingback-url": "https:/workflow/123" }'
+          payload: |
+            {
+              "system": "external_system",
+              "action": "update",
+              "data": {
+                "field": "value",
+                "timestamp": "2024-05-20T12:00:00Z"
+              }
+            }
+        events:
+          success: false
+          fail: true
+          runtimeExceeded: "@param:runtime_exceeded"
+      - email:
+          name: "email-watcher-1"
+          recipients:
+            to:
+              - "user1@peak.ai"
+              - "user2@peak.ai"
         events:
           success: false
           fail: true
@@ -100,3 +118,4 @@ artifact:
   ignore_files:
     - ".gitignore"
     - ".dockerignore"
+autoRunOnDeploy: true

peak/sample_yaml/resources/images/dockerfile/create_image.yaml

@@ -13,4 +13,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     dockerfile: "FROM nginx"

peak/sample_yaml/resources/images/dockerfile/create_image_version.yaml

@@ -11,4 +11,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     dockerfile: "FROM nginx"

peak/sample_yaml/resources/images/dockerfile/update_version.yaml

@@ -10,4 +10,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     dockerfile: "FROM nginx"

peak/sample_yaml/resources/images/github/create_image.yaml

@@ -16,4 +16,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true

peak/sample_yaml/resources/images/github/create_image_version.yaml

@@ -14,4 +14,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true

peak/sample_yaml/resources/images/github/update_version.yaml

@@ -13,4 +13,7 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true

peak/sample_yaml/resources/images/upload/create_image.yaml

@@ -13,6 +13,9 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     context: .
 artifact:
   path: "."

peak/sample_yaml/resources/images/upload/create_image_version.yaml

@@ -12,6 +12,9 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true
 artifact:
   path: "."

peak/sample_yaml/resources/images/upload/create_or_update_image.yaml

@@ -13,6 +13,9 @@ body:
         value: param1
       - name: PARAM2
         value: param2
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true
 artifact:
   path: "."

peak/sample_yaml/resources/images/upload/update_version.yaml

@@ -9,6 +9,9 @@ body:
     buildArguments:
       - name: PARAM1
         value: param1
+    secrets:
+      - SECRET1
+      - SECRET2
     useCache: true
 artifact:
   path: "."

peak/sample_yaml/resources/workflows/create_or_update_workflow.yaml

@@ -12,7 +12,15 @@ body:
     - webhook:
         name: info
         url: "https://abc.com/post"
-        payload: '{ "pingback-url": "https:/workflow/123" }'
+        payload: |
+          {
+            "system": "external_system",
+            "action": "update",
+            "data": {
+              "field": "value",
+              "timestamp": "2024-05-20T12:00:00Z"
+            }
+          }
       events:
         success: false
         fail: true

peak/sample_yaml/resources/workflows/create_workflow.yaml

@@ -12,7 +12,15 @@ body:
     - webhook:
         name: info
         url: "https://abc.com/post"
-        payload: '{ "pingback-url": "https:/workflow/123" }'
+        payload: |
+          {
+            "system": "external_system",
+            "action": "update",
+            "data": {
+              "field": "value",
+              "timestamp": "2024-05-20T12:00:00Z"
+            }
+          }
       events:
         success: false
         fail: true

peak/sample_yaml/resources/workflows/patch_workflow.yaml

@@ -12,7 +12,15 @@ body:
     - webhook:
         name: info
         url: "https://abc.com/post"
-        payload: '{ "pingback-url": "https:/workflow/123" }'
+        payload: |
+          {
+            "system": "external_system",
+            "action": "update",
+            "data": {
+              "field": "value",
+              "timestamp": "2024-05-20T12:00:00Z"
+            }
+          }
       events:
         success: false
         fail: true

peak/sample_yaml/resources/workflows/update_workflow.yaml

@@ -12,7 +12,15 @@ body:
     - webhook:
         name: info
         url: "https://abc.com/post"
-        payload: '{ "pingback-url": "https:/workflow/123" }'
+        payload: |
+          {
+            "system": "external_system",
+            "action": "update",
+            "data": {
+              "field": "value",
+              "timestamp": "2024-05-20T12:00:00Z"
+            }
+          }
       events:
         success: false
         fail: true

peak/session.py

@@ -179,7 +179,7 @@ class Session:
             page_count = response["pageCount"]
             yield from response[response_key]
             page_number += 1
-        return f"No more {response_key} to list"
+        return f"No more {response_key} to list"  # type: ignore[return-value]
 
     def create_download_request(
         self,

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.6.0.dist-info → peak_sdk-1.8.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.6.0
+Version: 1.8.0
 Summary: Python SDK for interacting with the Peak platform
-Home-page: https://docs.peak.ai/sdk
+Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
 Author: Peak
 Author-email: support@peak.ai
@@ -21,23 +21,23 @@ 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/
+Project-URL: Documentation, https://docs.peak.ai/sdk/latest/
 Description-Content-Type: text/markdown
 
 # Peak SDK
 
 [![PyPI](https://img.shields.io/pypi/v/peak-sdk.svg)](https://pypi.org/project/peak-sdk/)
-[![Python Version](https://img.shields.io/pypi/pyversions/peak-sdk)](https://docs.peak.ai/sdk/#platform-support)
-[![License](https://img.shields.io/pypi/l/peak-sdk)](https://docs.peak.ai/sdk/license.html)
+[![Python Version](https://img.shields.io/pypi/pyversions/peak-sdk)](https://docs.peak.ai/sdk/latest/#platform-support)
+[![License](https://img.shields.io/pypi/l/peak-sdk)](https://docs.peak.ai/sdk/latest/license.html)
 
 ## What is Peak SDK?
 
@@ -104,15 +104,15 @@ Follow these steps to create a virtual environment using Python's built-in `venv
 
 ### Documentation
 
-You can access the documentation for the SDK and CLI at [https://docs.peak.ai/sdk/](https://docs.peak.ai/sdk/).
+You can access the documentation for the SDK and CLI at [https://docs.peak.ai/sdk/latest/](https://docs.peak.ai/sdk/latest/).
 Here are some quick links to help you navigate easily:
 
--   [SDK Reference](https://docs.peak.ai/sdk/reference.html)
--   [CLI Reference](https://docs.peak.ai/sdk/cli/reference.html)
--   [Usage](https://docs.peak.ai/sdk/usage.html)
--   [CLI Usage](https://docs.peak.ai/sdk/cli/usage.html)
--   [Migration Guide](https://docs.peak.ai/sdk/migration-guide.html)
--   [FAQ](https://docs.peak.ai/sdk/faq.html)
+-   [SDK Reference](https://docs.peak.ai/sdk/latest/reference.html)
+-   [CLI Reference](https://docs.peak.ai/sdk/latest/cli/reference.html)
+-   [Usage](https://docs.peak.ai/sdk/latest/usage.html)
+-   [CLI Usage](https://docs.peak.ai/sdk/latest/cli/usage.html)
+-   [Migration Guide](https://docs.peak.ai/sdk/latest/migration-guide.html)
+-   [FAQ](https://docs.peak.ai/sdk/latest/faq.html)
 
 ### Platform Support
 
@@ -194,6 +194,6 @@ Here are some quick links to help you navigate easily:
 
 ## More Resources
 
--   [License](https://docs.peak.ai/sdk/license.html)
--   [Changelog](https://docs.peak.ai/sdk/changelog.html)
+-   [License](https://docs.peak.ai/sdk/latest/license.html)
+-   [Changelog](https://docs.peak.ai/sdk/latest/changelog.html)