peak-sdk 1.11.0__tar.gz → 1.13.0__tar.gz

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.11.0
+Version: 1.13.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
 Author: Peak
 Author-email: support@peak.ai
-Requires-Python: >=3.8.1,<3.12
+Requires-Python: >=3.8.1,<3.13
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Typing :: Typed
@@ -28,7 +29,7 @@ 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.2.0,<25.0.0)
-Requires-Dist: typer (>=0.12.3,<0.13.0)
+Requires-Dist: typer (>=0.12.4,<0.13.0)
 Requires-Dist: urllib3 (<2)
 Project-URL: Documentation, https://docs.peak.ai/sdk/latest/
 Description-Content-Type: text/markdown
@@ -93,6 +94,37 @@ 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
     ```
 
+### Checking Package Version
+
+-   As mentioned above, the Peak SDK ships with a CLI as well. You can check the version of both the CLI and the SDK quite easily.
+-   You can check the version for the `peak-cli` using the following command
+
+    ```bash
+    peak --version
+    ```
+
+    This should return a response of the following format
+
+    ```bash
+    peak-cli==1.13.0
+    Python==3.12.3
+    System==Darwin(23.6.0)
+    ```
+
+-   To check the version of the `peak-sdk`, the following code snippet can be used
+
+    ```python
+    import peak
+
+    print(peak.__version__)
+    ```
+
+    This should print the version of the SDK
+
+    ```
+    1.13.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).
@@ -135,13 +167,13 @@ Here are some quick links to help you navigate easily:
           <tr>
             <td>3.8</td>
             <td>🟢</td>
-            <td>🟡</td>
+            <td>🟢</td>
             <td>🟤</td>
           </tr>
           <tr>
             <td>3.9</td>
             <td>🟢</td>
-            <td>🟡</td>
+            <td>🟢</td>
             <td>🟤</td>
           </tr>
           <tr>
@@ -152,8 +184,14 @@ Here are some quick links to help you navigate easily:
           </tr>
           <tr>
             <td>3.11</td>
-            <td>🟡</td>
-            <td>🟡</td>
+            <td>🟢</td>
+            <td>🟢</td>
+            <td>🟤</td>
+          </tr>
+          <tr>
+            <td>3.12</td>
+            <td>🟢</td>
+            <td>🟢</td>
             <td>🟤</td>
           </tr>
         </tbody>

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/peak/__init__.py

@@ -24,13 +24,14 @@ Copyright © 2024 Peak AI
 
 Unauthorized copying of this file, via any medium is strictly prohibited.
 """
+
 from __future__ import annotations
 
 from typing import List
 
-from peak import press, resources, tools
+from peak import metrics, press, resources, tools
 from peak.session import Session
 
 from ._version import __version__
 
-__all__: List[str] = ["Session", "press", "resources", "tools", "__version__"]
+__all__: List[str] = ["Session", "metrics", "press", "resources", "tools", "__version__"]

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/peak/_metadata.py

@@ -695,6 +695,168 @@ command_metadata: Dict[str, Any] = {
             "subheader_key": "templateCount",
         },
     },
+    "metrics>list": {
+        "table_params": {
+            "output_keys": {
+                "name": {
+                    "label": "Name",
+                },
+                "type": {
+                    "label": "Type",
+                },
+                "description": {
+                    "label": "Description",
+                },
+                "collectionId": {
+                    "label": "Collection ID",
+                },
+                "publicationId": {
+                    "label": "Publication ID",
+                },
+                "metadata": {
+                    "label": "Metadata",
+                },
+            },
+            "title": "Metrics",
+            "data_key": "data",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>list>measure": {
+        "table_params": {
+            "output_keys": {
+                "name": {
+                    "label": "Name",
+                },
+                "type": {
+                    "label": "Type",
+                },
+                "aggType": {
+                    "label": "Aggregation Type",
+                },
+                "cube": {
+                    "label": "Cube",
+                },
+                "description": {
+                    "label": "Description",
+                },
+                "collectionId": {
+                    "label": "Collection ID",
+                },
+                "publicationId": {
+                    "label": "Publication ID",
+                },
+                "metadata": {
+                    "label": "Metadata",
+                },
+            },
+            "title": "Measures",
+            "data_key": "data",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>list>dimension": {
+        "table_params": {
+            "output_keys": {
+                "name": {
+                    "label": "Name",
+                },
+                "type": {
+                    "label": "Type",
+                },
+                "primaryKey": {
+                    "label": "Primary Key",
+                },
+                "cube": {
+                    "label": "Cube",
+                },
+                "description": {
+                    "label": "Description",
+                },
+                "collectionId": {
+                    "label": "Collection ID",
+                },
+                "publicationId": {
+                    "label": "Publication ID",
+                },
+                "metadata": {
+                    "label": "Metadata",
+                },
+            },
+            "title": "Dimensions",
+            "data_key": "data",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>list>segment": {
+        "table_params": {
+            "output_keys": {
+                "name": {
+                    "label": "Name",
+                },
+                "cube": {
+                    "label": "Cube",
+                },
+                "description": {
+                    "label": "Description",
+                },
+                "collectionId": {
+                    "label": "Collection ID",
+                },
+                "publicationId": {
+                    "label": "Publication ID",
+                },
+                "metadata": {
+                    "label": "Metadata",
+                },
+            },
+            "title": "Segments",
+            "data_key": "data",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>list-collections": {
+        "table_params": {
+            "output_keys": {
+                "id": {
+                    "label": "ID",
+                },
+                "name": {
+                    "label": "Name",
+                },
+                "description": {
+                    "label": "Description",
+                },
+                "scope": {
+                    "label": "Scope",
+                },
+                "createdAt": {
+                    "label": "Created At",
+                },
+                "createdBy": {
+                    "label": "Created By",
+                },
+            },
+            "title": "Collections",
+            "data_key": "collections",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>list-namespaces": {
+        "table_params": {
+            "output_keys": {
+                "name": {
+                    "label": "Name",
+                },
+                "models": {
+                    "label": "Models",
+                },
+            },
+            "title": "Namespaces",
+            "data_key": "namespaces",
+            "subheader_key": "totalCount",
+        },
+    },
     "artifacts>create": {
         "request_body_yaml_path": "sample_yaml/resources/artifacts/create_artifact.yaml",
     },
@@ -794,6 +956,28 @@ command_metadata: Dict[str, Any] = {
     "blocks>deployments>patch-parameters": {
         "request_body_yaml_path": "sample_yaml/press/blocks/deployments/patch_block_parameters.yaml",
     },
+    "deployments>patch-parameters": {
+        "request_body_yaml_path": "sample_yaml/press/patch_parameters.yaml",
+    },
+    "metrics>publish": {
+        "request_body_yaml_path": "sample_yaml/metrics/publish.yaml",
+    },
+    "metrics>query": {
+        "request_body_yaml_path": "sample_yaml/metrics/query.yaml",
+        "table_params": {
+            "output_keys": {},
+            "title": "Query Data",
+            "data_key": "data",
+            "subheader_key": "totalCount",
+        },
+    },
+    "metrics>create-collection": {
+        "request_body_yaml_path": "sample_yaml/metrics/create_collection.yaml",
+    },
+}
+
+command_parameter: Dict[str, str] = {
+    "metrics>list": "type",
 }
 
-__all__: List[str] = ["command_metadata"]
+__all__: List[str] = ["command_metadata", "command_parameter"]

{peak_sdk-1.11.0 → peak_sdk-1.13.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.11.0"
+__version__: str = "1.13.0"

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/peak/callbacks.py

@@ -27,7 +27,7 @@ import click
 import typer
 
 import peak.config
-from peak._metadata import command_metadata
+from peak._metadata import command_metadata, command_parameter
 from peak.constants import OutputTypes
 from peak.output import Writer
 
@@ -44,6 +44,20 @@ def paging(*, enable_paging: bool) -> None:
     peak.config.ENABLE_PAGING = enable_paging
 
 
+def update_command(ctx: typer.Context, command: str) -> str:
+    """Callback to update the command based on the command parameter."""
+    if not ctx or not hasattr(ctx, "params") or command not in command_parameter:
+        return command
+
+    param = command_parameter[command]
+    param_value = ctx.params.get(param)
+    if param_value:
+        command_with_params = f"{command}>{param_value}"
+        if command_with_params in command_metadata and "table_params" in command_metadata[command_with_params]:
+            return command_with_params
+    return command
+
+
 def get_full_command_name(ctx: typer.Context | click.core.Context | None) -> str:
     """Callback to get the full command name."""
     if ctx:
@@ -66,6 +80,7 @@ def handle_output(output_type: OutputTypes, ctx: typer.Context) -> None:
     peak.config.OUTPUT_TYPE = output_type
 
     command = get_command_name(ctx)
+    command = update_command(ctx, command)
 
     if (command not in command_metadata) or ("table_params" not in command_metadata[command]):
         return
@@ -76,8 +91,13 @@ def handle_output(output_type: OutputTypes, ctx: typer.Context) -> None:
 def generate_yaml(ctx: typer.Context, generate_yaml: bool) -> None:  # noqa: FBT001 # pragma: no cover
     """Callback to generate yaml file."""
     command = get_command_name(ctx)
+    output_type = peak.config.OUTPUT_TYPE
 
-    if (command not in command_metadata) or ("request_body_yaml_path" not in command_metadata[command]):
+    if (
+        (command not in command_metadata)
+        or ("request_body_yaml_path" not in command_metadata[command])
+        or output_type == "table"
+    ):
         return
 
     if generate_yaml:

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/peak/cli/cli.py

@@ -24,6 +24,7 @@ import sys
 import peak.config
 import typer
 from peak.cli import args, helpers
+from peak.cli.metrics import metrics
 from peak.cli.press import apps, blocks, deployments, specs
 from peak.cli.resources import alerts, artifacts, images, services, tenants, users, webapps, workflows
 from peak.constants import Sources
@@ -34,6 +35,7 @@ typer.rich_utils.STYLE_HELPTEXT = ""
 
 typer_app = typer.Typer(rich_markup_mode="markdown", help="Create and Manage Peak Resources")
 typer_app.add_typer(images.app, name="images")
+typer_app.add_typer(metrics.app, name="metrics")
 typer_app.add_typer(alerts.app, name="alerts")
 typer_app.add_typer(artifacts.app, name="artifacts")
 typer_app.add_typer(workflows.app, name="workflows")

{peak_sdk-1.11.0 → peak_sdk-1.13.0}/peak/cli/helpers.py

@@ -31,6 +31,7 @@ import yaml
 from peak import base_client, press, resources
 from peak.exceptions import BadParameterException
 from peak.helpers import format_date, remove_none_values
+from peak.metrics import metrics
 from peak.template import load_template
 from rich.console import Console
 
@@ -257,5 +258,6 @@ def get_client(command: str) -> base_client.BaseClient:
         "tenants": resources.tenants,
         "users": resources.users,
         "alerts": resources.alerts,
+        "metrics": metrics,
     }
     return command_client_map[command].get_client()  # type: ignore[no-any-return]

peak_sdk-1.13.0/peak/cli/metrics/__init__.py

@@ -0,0 +1,21 @@
+#
+# # Copyright © 2024 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
+# # the License is located at:
+# #
+# # https://github.com/PeakBI/peak-sdk/blob/main/LICENSE
+# #
+# # or in the "license" file accompanying this file. This file is
+# # distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# # ANY KIND, either express or implied. See the License for the specific
+# # language governing permissions and limitations under the License.
+# #
+# # This file is part of the peak-sdk.
+# # see (https://github.com/PeakBI/peak-sdk)
+# #
+# # 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>
+#
+"""CLI module for Peak Metrics."""