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

peak/resources/workflows.py

@@ -19,6 +19,7 @@
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
 """Workflow client module."""
+
 from __future__ import annotations
 
 from typing import Any, Dict, Iterator, List, Literal, Optional, overload
@@ -51,8 +52,7 @@ class Workflow(BaseClient):
         name: Optional[str] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_workflows(
@@ -65,8 +65,7 @@ class Workflow(BaseClient):
         name: Optional[str] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_workflows(
         self: Workflow,
@@ -166,10 +165,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -295,10 +314,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -382,7 +421,7 @@ class Workflow(BaseClient):
             ForbiddenException: The user does not have permission to perform the operation.
             InternalServerErrorException: The server failed to process the request.
         """
-        workflow_name = body["name"] if "name" in body else ""
+        workflow_name = body.get("name", "")
         response = (
             {}
             if not len(workflow_name)
@@ -463,10 +502,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -624,10 +683,30 @@ class Workflow(BaseClient):
                                 "runtimeExceeded": "number"
                             },
                             "user": "string",
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
                             "webhook": {
                                 "name": "string(required)",
                                 "url": "string(required)",
-                                "payload": "string(required)",
+                                "payload": "string(required)"
+                            }
+                        },
+                        {
+                            "events": {
+                                "success": "boolean",
+                                "fail": "boolean",
+                                "runtimeExceeded": "number"
+                            },
+                            "email": {
+                                "name": "string",
+                                "recipients": {
+                                    "to": ["string"]
+                                }
                             }
                         }
                     ],
@@ -961,12 +1040,13 @@ class Workflow(BaseClient):
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[False],
-    ) -> Dict[str, Any]:
-        ...
+    ) -> Dict[str, Any]: ...
 
     @overload
     def list_executions(
@@ -974,18 +1054,21 @@ class Workflow(BaseClient):
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
         return_iterator: Literal[True] = True,
-    ) -> Iterator[Dict[str, Any]]:
-        ...
+    ) -> Iterator[Dict[str, Any]]: ...
 
     def list_executions(
         self: Workflow,
         workflow_id: int,
         date_from: Optional[str] = None,
         date_to: Optional[str] = None,
+        status: Optional[List[str]] = None,
+        count: Optional[int] = None,
         page_size: Optional[int] = None,
         page_number: Optional[int] = None,
         *,
@@ -1000,6 +1083,11 @@ class Workflow(BaseClient):
             workflow_id (int): ID of the workflow to fetch executions.
             date_from (str | None): The date after which the executions should be included (in ISO format). Defaults to None
             date_to (str | None): The date till which the executions should be included (in ISO format). Defaults to None
+            status (List[str] | None): The status of the executions to filter by.
+                Valid values are `Success`, `Running`, `Stopped`, `Stopping` and `Failed`.
+            count (int | None): Number of executions required in the provided time range or 90 days (Ordered by latest to earliest).
+                For example, if 5 is provided, it will return last 5 workflow executions.
+                By default, it will return all the executions.
             page_size (int | None): Number of executions per page.
             page_number (int | None): Page number to fetch. Only used when return_iterator is False.
             return_iterator (bool): Whether to return an iterator object or list of executions for a specified page number, defaults to True.
@@ -1011,7 +1099,7 @@ class Workflow(BaseClient):
             Set `return_iterator` to True if you want automatic client-side pagination, or False if you want server-side pagination.
 
         Raises:
-            BadRequestException: BadRequestException: The given request parameters are invalid.
+            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 workflow does not exist.
@@ -1021,6 +1109,8 @@ class Workflow(BaseClient):
         method, endpoint = HttpMethods.GET, f"{self.BASE_ENDPOINT}/workflows/executions/{workflow_id}"
 
         params: Dict[str, Any] = {
+            "count": count,
+            "statuses": status,
             "dateTo": date_to,
             "dateFrom": date_from,
             "pageSize": page_size,
@@ -1068,7 +1158,7 @@ class Workflow(BaseClient):
             Dict[str, Any]: A dictionary containing the logs for the given execution.
 
         Raises:
-            BadRequestException: BadRequestException: The given request parameters are invalid.
+            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 workflow does not exist.
@@ -1123,7 +1213,7 @@ class Workflow(BaseClient):
             Dict[str, Any]: A dictionary containing the logs for the given execution.
 
         Raises:
-            BadRequestException: BadRequestException: The given request parameters are invalid.
+            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 workflow does not exist.

peak/sample_yaml/resources/emails/send_email.yaml

@@ -0,0 +1,15 @@
+# send_email.yaml
+
+body:
+  recipients:
+    - person1@peak.ai
+    - person2@peak.ai
+  cc:
+    - person3@peak.ai
+  bcc:
+    - person4@peak.ai
+  subject: Hello from Peak
+  templateName: my-email-template
+  templateParameters:
+    name: John
+    company: Peak

peak/sample_yaml/resources/services/create_or_update_service.yaml

@@ -22,3 +22,4 @@ body:
     python
     app.py
   healthCheckURL: /health
+  minInstances: 1

peak/sample_yaml/resources/services/create_service.yaml

@@ -22,3 +22,4 @@ body:
     python
     app.py
   healthCheckURL: /health
+  minInstances: 1

peak/sample_yaml/resources/services/update_service.yaml

@@ -20,3 +20,4 @@ body:
     python
     app.py
   healthCheckURL: /health
+  minInstances: 1

peak/sample_yaml/resources/workflows/create_or_update_workflow.yaml

@@ -4,6 +4,34 @@ body:
   name: my-new-workflow
   triggers:
     - webhook: true
+  watchers:
+    - user: abc@peak.ai
+      events:
+        success: false
+        fail: true
+    - webhook:
+        name: info
+        url: "https://abc.com/post"
+        payload: '{ "pingback-url": "https:/workflow/123" }'
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+    - email:
+        name: "email-watcher-1"
+        recipients:
+          to:
+            - user1@peak.ai
+            - user2@peak.ai
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+  retryOptions:
+    duration: 5
+    exitCodes: [1, 2]
+    exponentialBackoff: true
+    numberOfRetries: 3
   tags:
     - name: CLI
   steps:

peak/sample_yaml/resources/workflows/create_workflow.yaml

@@ -17,6 +17,16 @@ body:
         success: false
         fail: true
         runtimeExceeded: 10
+    - email:
+        name: "email-watcher-1"
+        recipients:
+          to:
+            - user1@peak.ai
+            - user2@peak.ai
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
   retryOptions:
     duration: 5
     exitCodes: [1, 2]

peak/sample_yaml/resources/workflows/patch_workflow.yaml

@@ -4,6 +4,34 @@ body:
   name: "updated-workflow"
   triggers:
     - {}
+  watchers:
+    - user: abc@peak.ai
+      events:
+        success: false
+        fail: true
+    - webhook:
+        name: info
+        url: "https://abc.com/post"
+        payload: '{ "pingback-url": "https:/workflow/123" }'
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+    - email:
+        name: "email-watcher-1"
+        recipients:
+          to:
+            - user1@peak.ai
+            - user2@peak.ai
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+  retryOptions:
+    duration: 5
+    exitCodes: [1, 2]
+    exponentialBackoff: true
+    numberOfRetries: 3
   steps:
     step1:
       imageId: 100

peak/sample_yaml/resources/workflows/update_workflow.yaml

@@ -4,6 +4,34 @@ body:
   name: updated-workflow
   triggers:
     - webhook: true
+  watchers:
+    - user: abc@peak.ai
+      events:
+        success: false
+        fail: true
+    - webhook:
+        name: info
+        url: "https://abc.com/post"
+        payload: '{ "pingback-url": "https:/workflow/123" }'
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+    - email:
+        name: "email-watcher-1"
+        recipients:
+          to:
+            - user1@peak.ai
+            - user2@peak.ai
+      events:
+        success: false
+        fail: true
+        runtimeExceeded: 10
+  retryOptions:
+    duration: 5
+    exitCodes: [1, 2]
+    exponentialBackoff: true
+    numberOfRetries: 3
   tags:
     - name: CLI
   steps:

peak/session.py

@@ -70,7 +70,7 @@ class Session:
 
         Args:
             auth_token (str | None): Authentication token. Both API Key and Bearer tokens are supported.
-                Picks up from `API_KEY` environment variable if not provided.
+                Picks up from `PEAK_AUTH_TOKEN` or `API_KEY` environment variable if not provided.
             stage (str | None): Name of the stage where tenant is created. Default is `prod`.
         """
         self.base_domain: str = ""
@@ -238,9 +238,12 @@ class Session:
             self.auth_token = auth_token
             return
 
-        logger.info("auth_token not given, searching for API_KEY in env variables")
-        if not os.environ.get("API_KEY"):
-            raise exceptions.MissingEnvironmentVariableException(env_var="API_KEY")
+        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")
+        if os.environ.get("PEAK_AUTH_TOKEN"):
+            self.auth_token = os.environ["PEAK_AUTH_TOKEN"]
+            return
         self.auth_token = os.environ["API_KEY"]
 
     def _set_stage(self, stage: Optional[str]) -> None:

peak/telemetry.py

@@ -80,7 +80,7 @@ def telemetry(make_request: F) -> F:
         """
         stage = Stage.PROD
         if session_meta:
-            stage = session_meta["stage"] if "stage" in session_meta else Stage.PROD
+            stage = session_meta.get("stage", Stage.PROD)
         base_domain = get_base_domain(stage.value, "service")
         return f"{base_domain}/resource-usage/api/v1/telemetry"
 

peak/template.py

@@ -38,10 +38,12 @@ from peak.helpers import remove_none_values
 def _parse_jinja_template(template_path: Path, params: Dict[str, Any]) -> str:
     """Read, parse and render the Jinja template text."""
     jinja_loader = _CustomJinjaLoader()
-    jinja_env = jinja2.Environment(  # TODO: show warning if variable not found in params  # noqa: TD002, TD003, RUF100
-        loader=jinja_loader,
-        autoescape=False,  # noqa: S701
-        extensions=[_IncludeWithIndentation],
+    jinja_env = (
+        jinja2.Environment(  # TODO: show warning if variable not found in params  # noqa: TD002, TD003, RUF100, FIX002
+            loader=jinja_loader,
+            autoescape=False,  # noqa: S701
+            extensions=[_IncludeWithIndentation],
+        )
     )
     jinja_template: jinja2.Template = jinja_env.get_template(str(template_path))
     return jinja_template.render(params, os_env=os.environ)