peak-sdk 1.3.0__tar.gz → 1.5.0__tar.gz

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright © 2023 Peak-AI
+   Copyright © 2024 Peak-AI
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.3.0
+Version: 1.5.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk
 License: Apache-2.0
@@ -94,13 +94,13 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     echo "compinit" >> ~/.zshrc # replace .zshrc with your shell's configuration file
     ```
 
-### Using the SDK/CLI
+### Using the SDK and CLI
 
--   To start using the SDK and CLI, you'll need either an API Key or an Access Token.
--   If you don't have one yet, sign up for an account on the Peak platform to obtain your API key or Access token.
--   To export it, run the following command in your terminal and replace <api_key> with your actual API key:
+-   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:
     ```
-    export API_KEY=<api_key | access_token>
+    export PEAK_AUTH_TOKEN=<peak_auth_token>
     ```
 
 ### Documentation

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/peak/__init__.py

@@ -20,7 +20,7 @@
 #
 """This file is part of the peak-sdk framework.
 
-Copyright © 2023 Peak AI
+Copyright © 2024 Peak AI
 
 Unauthorized copying of this file, via any medium is strictly prohibited.
 """

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/peak/_metadata.py

@@ -241,6 +241,37 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "webappsCount",
         },
     },
+    "list_services": {
+        "table_params": {
+            "output_keys": {
+                "id": {
+                    "label": "ID",
+                },
+                "name": {
+                    "label": "Name",
+                },
+                "serviceType": {
+                    "label": "Service Type",
+                },
+                "status": {
+                    "label": "Status",
+                },
+                "updatedBy": {
+                    "label": "Updated By",
+                },
+                "updatedAt": {
+                    "label": "Updated At (UTC)",
+                },
+                "tags": {
+                    "label": "Tags",
+                    "parser": tag_parser,
+                },
+            },
+            "title": "Services",
+            "data_key": "services",
+            "subheader_key": "servicesCount",
+        },
+    },
     "list_artifacts": {
         "table_params": {
             "output_keys": {
@@ -637,6 +668,18 @@ command_metadata: Dict[str, Any] = {
     "create_or_update_webapp": {
         "request_body_yaml_path": "sample_yaml/resources/webapps/create_or_update_webapp.yaml",
     },
+    "create_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/create_service.yaml",
+    },
+    "update_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/update_service.yaml",
+    },
+    "create_or_update_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/create_or_update_service.yaml",
+    },
+    "test_service": {
+        "request_body_yaml_path": "sample_yaml/resources/services/test_service.yaml",
+    },
     "create_app_spec": {
         "request_body_yaml_path": "sample_yaml/press/apps/specs/create_app_spec.yaml",
     },

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/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.3.0"
+__version__: str = "1.5.0"

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/peak/cli/cli.py

@@ -25,7 +25,7 @@ import peak.config
 import typer
 from peak.cli import args, helpers
 from peak.cli.press import apps, blocks, deployments, specs
-from peak.cli.resources import artifacts, images, tenants, webapps, workflows
+from peak.cli.resources import artifacts, images, services, tenants, users, webapps, workflows
 from peak.constants import Sources
 from peak.output import Writer
 
@@ -37,11 +37,13 @@ typer_app.add_typer(images.app, name="images")
 typer_app.add_typer(artifacts.app, name="artifacts")
 typer_app.add_typer(workflows.app, name="workflows")
 typer_app.add_typer(webapps.app, name="webapps")
+typer_app.add_typer(services.app, name="services")
 typer_app.add_typer(tenants.app, name="tenants")
 typer_app.add_typer(apps.app, name="apps")
 typer_app.add_typer(blocks.app, name="blocks")
 typer_app.add_typer(specs.app, name="specs")
 typer_app.add_typer(deployments.app, name="deployments")
+typer_app.add_typer(users.app, name="users")
 
 
 @typer_app.callback()

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/peak/cli/helpers.py

@@ -189,6 +189,31 @@ def parse_build_arguments(build_arguments: List[str]) -> List[Dict[str, str]]:
     return parsed_build_arguments
 
 
+def parse_envs(env: List[str]) -> Dict[str, str]:
+    """Parses envs provided via cli args to the format {arg1: value1}.
+
+    Args:
+        env (List[str]): List of envs provided via cli args.
+
+    Returns:
+        Dict[str, str]: Envs in the required format.
+
+    Raises:
+        BadParameterException: If a value is invalid.
+    """
+    parsed_envs: Dict[str, str] = {}
+    for env_arg in env:
+        try:
+            key, value = env_arg.split("=", 1)
+        except ValueError as err:
+            raise BadParameterException(
+                env_arg,
+                message="Invalid env format. It should in the --env arg1=value1 format",
+            ) from err
+        parsed_envs[key] = value
+    return parsed_envs
+
+
 def format_logs(logs: List[Dict[str, Any]]) -> str:
     """Formats logs into a readable format.
 
@@ -223,7 +248,9 @@ def get_client(command: str) -> base_client.BaseClient:
         "artifacts": resources.artifacts,
         "images": resources.images,
         "workflows": resources.workflows,
+        "services": resources.services,
         "webapps": resources.webapps,
         "tenants": resources.tenants,
+        "users": resources.users,
     }
     return command_client_map[command].get_client()  # type: ignore[no-any-return]

{peak_sdk-1.3.0 → peak_sdk-1.5.0}/peak/cli/press/blocks/specs.py

@@ -165,7 +165,6 @@ def create(
                 - cron (string | required: false): A valid cron expression.
                   webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
                   webhookId (string | required: false): ID of the webhook.
-                  webhookPolicy (string | required: false): Policy of the webhook to be used. Should be one of "generate" or "preserve". It is "generate" by default.
             watchers (list(map) | required: false):
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.
@@ -430,7 +429,6 @@ def create_release(
                 cron (string | required: false): A valid cron expression.
                 webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
                 webhookId (string | required: false): ID of the webhook.
-                webhookPolicy (string | required: false): Policy of the webhook to be used. Should be one of "generate" or "preserve". It is "generate" by default.
             watchers (list(map) | required: false):
                 - events (map):
                     success (boolean | required: false): Whether to call event on success.