peak-sdk 1.16.1__tar.gz → 1.18.0__tar.gz

{peak_sdk-1.16.1 → peak_sdk-1.18.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: peak-sdk
-Version: 1.16.1
+Version: 1.18.0
 Summary: Python SDK for interacting with the Peak platform
 Home-page: https://docs.peak.ai/sdk/latest/
 License: Apache-2.0
@@ -31,6 +31,7 @@ Requires-Dist: shellingham (<1.5.4)
 Requires-Dist: structlog (>=24.2.0,<25.0.0)
 Requires-Dist: typer (>=0.12.4,<0.13.0)
 Requires-Dist: urllib3 (<2)
+Requires-Dist: valkey (>=6.0.0,<7.0.0)
 Project-URL: Documentation, https://docs.peak.ai/sdk/latest/
 Description-Content-Type: text/markdown
 
@@ -106,7 +107,7 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should return a response of the following format
 
     ```bash
-    peak-cli==1.16.1
+    peak-cli==1.18.0
     Python==3.12.3
     System==Darwin(23.6.0)
     ```
@@ -122,7 +123,7 @@ Follow these steps to create a virtual environment using Python's built-in `venv
     This should print the version of the SDK
 
     ```
-    1.16.1
+    1.18.0
     ```
 
 ### Using the SDK and CLI

{peak_sdk-1.16.1 → peak_sdk-1.18.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.16.1"
+__version__: str = "1.18.0"

{peak_sdk-1.16.1 → peak_sdk-1.18.0}/peak/cli/cli.py

@@ -26,7 +26,7 @@ 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.cli.resources import alerts, artifacts, cache, images, services, tenants, users, webapps, workflows
 from peak.constants import Sources
 from peak.output import Writer
 
@@ -38,6 +38,7 @@ 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(cache.app, name="cache")
 typer_app.add_typer(workflows.app, name="workflows")
 typer_app.add_typer(webapps.app, name="webapps")
 typer_app.add_typer(services.app, name="services")

{peak_sdk-1.16.1 → peak_sdk-1.18.0}/peak/cli/helpers.py

@@ -251,6 +251,7 @@ def get_client(command: str) -> base_client.BaseClient:
         "specs": press.specs,
         "deployments": press.deployments,
         "artifacts": resources.artifacts,
+        "cache": resources.cache,
         "images": resources.images,
         "workflows": resources.workflows,
         "services": resources.services,

{peak_sdk-1.16.1 → peak_sdk-1.18.0}/peak/cli/metrics/metrics.py

@@ -50,6 +50,16 @@ _NAMESPACE = typer.Option(
     None,
     help="The namespace associated with the metrics. If not provided, the default namespace is used.",
 )
+
+_NAMESPACE_DESCRIPTION = typer.Option(
+    None,
+    help="A description of the namespace.",
+)
+
+_NAMESPACE_METADATA = typer.Option(
+    None,
+    help="Key-value metadata associated with the namespace. Provide them in stringified JSON format.",
+)
 _GENERATE_SQL = typer.Option(
     None,
     help="Indicates whether to return the SQL query instead of data. If `true`, the response will include the SQL query used to retrieve the metrics. Default is `false`.",
@@ -70,6 +80,10 @@ _TIME_DIMENSIONS = typer.Option(
     None,
     help="An array of time dimensions to include in the query. Time dimensions allow querying over specific time ranges with optional granularity (e.g., day, month, year). Provide them in stringified JSON format.",
 )
+_SEARCH_TERM = typer.Option(
+    None,
+    help="A search term to filter the metrics. This can be used to search for specific metrics by name.",
+)
 _SEGMENTS = typer.Option(
     None,
     help="An array of segments to include in the query. Segments represent pre-defined filters that can be applied to metrics. Provide them in stringified JSON format.",
@@ -145,6 +159,7 @@ def publish(
     params_file: str = args.TEMPLATE_PARAMS_FILE,
     params: List[str] = args.TEMPLATE_PARAMS,
     namespace: Optional[str] = _PUBLISH_NAMESPACE,
+    namespace_description: Optional[str] = _NAMESPACE_DESCRIPTION,
     artifact_path: Optional[str] = _ARTIFACT_PATH,
     collection_id: Optional[str] = _COLLECTION_ID,
     dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
@@ -156,6 +171,7 @@ def publish(
     The metrics can be published either by passing artifact and namespace,
     or by passing collection_id and namespace. If both artifact and collection_id
     are provided, artifact takes priority. If the namespace is not provided, the 'default' namespace is used.
+    Namespace metadata and Namespace description are optional.
 
     \b
     🧩 ***Input file schema(yaml):***<br/>
@@ -164,6 +180,9 @@ def publish(
     ```yaml
       body (map):
         namespace (str): The namespace associated with the metrics.
+        namespaceMetadata (map | required: false): Key-value metadata associated with the namespace.
+        namespaceDescription (str | required: false): A description of the namespace.
+
       artifact (map):
         path (str): Path to the artifact.
     ```
@@ -171,6 +190,9 @@ def publish(
     ```yaml
       body (map):
         namespace (str): The namespace associated with the metrics.
+        namespaceMetadata (map | required: false): Key-value metadata associated with the namespace.
+        namespaceDescription (str | required: false): A description of the namespace.
+
       collectionId (str): The ID of the collection to publish the metrics.
     ```
 
@@ -186,9 +208,10 @@ def publish(
     📝 ***Example usage without yaml:***
     ```bash
     # Publish metrics using artifact and namespace
-    peak metrics publish --artifact-path <path> --namespace <namespace>
+    peak metrics publish --artifact-path <path> --namespace <namespace> --namespace-description "Metrics for pricing"
+
     # Publish metrics using collection id and namespace
-    peak metrics publish --collection-id <collection-id> --namespace <namespace>
+    peak metrics publish --collection-id <collection-id> --namespace <namespace> --namespace-description "Metrics for pricing"
     ```
 
     \b
@@ -208,6 +231,7 @@ def publish(
 
     user_options: Dict[str, Any] = variables_to_dict(
         namespace,
+        namespace_description,
     )
 
     body: Dict[str, Any] = {}
@@ -358,7 +382,9 @@ def list_metrics(
     ctx: typer.Context,
     page_size: Optional[int] = args.PAGE_SIZE,
     page_number: Optional[int] = args.PAGE_NUMBER,
+    publication_id: Optional[str] = _PUBLICATION_ID,
     namespace: Optional[str] = _NAMESPACE,
+    search_term: Optional[str] = _SEARCH_TERM,
     type: Optional[str] = _METRIC_TYPES,  # noqa: A002
     paging: Optional[bool] = PAGING,  # noqa: ARG001
     output_type: Optional[OutputTypes] = OUTPUT_TYPES,  # noqa: ARG001
@@ -368,7 +394,7 @@ def list_metrics(
     \b
     📝 ***Example usage:***<br/>
     ```bash
-    peak metrics list --page-size 25 --page-number 1 --namespace <namespace> --type <type>
+    peak metrics list --page-size 25 --page-number 1 --namespace <namespace> --type <type> --search-term <search_term> --publication-id <publication_id>
     ```
 
     \b
@@ -429,11 +455,12 @@ def list_metrics(
         response = metric_client.list(
             page_size=page_size,
             page_number=page_number,
+            publication_id=publication_id,
             namespace=namespace,
+            search_term=search_term,
             type=type,
             return_iterator=False,
         )
-
         writer.write(response)
 
 
@@ -676,6 +703,11 @@ def list_namespaces(
     {
         "namespaces": [
             {
+                "description": "Default namespace",
+                "metadata": {
+                    "owner": "abc",
+                    "environment": "development"
+                },
                 "name": "default",
                 "models": [
                     {
@@ -705,3 +737,71 @@ def list_namespaces(
             return_iterator=False,
         )
         writer.write(response)
+
+
+@app.command(short_help="Update a namespace.")
+def update_namespace(
+    ctx: typer.Context,
+    file: Annotated[
+        Optional[str],
+        typer.Argument(
+            ...,
+            help="Path to the file that defines the body for this operation, supports both `yaml` file or a `jinja` template.",
+        ),
+    ] = None,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+    namespace: Optional[str] = typer.Option(None, help="The name of the namespace to update."),
+    description: Optional[str] = _NAMESPACE_DESCRIPTION,
+    dry_run: Optional[bool] = DRY_RUN,  # noqa: ARG001
+    output_type: Optional[OutputTypesNoTable] = OUTPUT_TYPES,  # noqa: ARG001
+) -> None:
+    """***Update*** a namespace with a new description and metadata.
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak metrics update-namespace update-namespace.yaml --namespace new_namespace --description "Updated description"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "namespace": "new_namespace",
+        "description": "Updated description",
+        "message": "Updated namespace new_namespace",
+        "metadata": {
+            "key": "value"
+        }
+    }
+    ```
+    """
+    metrics_client: Metric = ctx.obj["client"]
+    writer: Writer = ctx.obj["writer"]
+
+    body: Dict[str, Any] = {}
+    if file:
+        body = helpers.template_handler(file=file, params_file=params_file, params=params)
+
+    cli_options: Dict[str, Any] = variables_to_dict(
+        namespace,
+        description,
+    )
+
+    updated_body = combine_dictionaries(body or {}, cli_options)
+
+    if not updated_body.get("namespace") and not namespace:
+        error_message = "Namespace must be provided either through file or CLI option."
+        raise typer.BadParameter(error_message)
+
+    final_namespace = updated_body.pop("namespace", namespace)
+    metadata = updated_body.get("metadata")
+
+    with writer.pager():
+        response = metrics_client.update_namespace(
+            namespace=final_namespace,
+            description=updated_body.get("description"),
+            metadata=metadata,
+        )
+        writer.write(response)