peak-sdk 1.0.0__py3-none-any.whl

peak/__init__.py

@@ -0,0 +1,36 @@
+#
+# # Copyright © 2023 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>
+#
+"""This file is part of the peak-sdk framework.
+
+Copyright © 2023 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
+from peak.session import Session
+
+from ._version import __version__
+
+__all__: List[str] = ["Session", "press", "resources", "__version__"]

peak/_version.py

@@ -0,0 +1,21 @@
+#
+# # Copyright © 2023 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>
+#
+__version__: str = "1.0.0"

peak/auth.py

@@ -0,0 +1,22 @@
+#
+# # Copyright © 2023 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>
+#
+"""Auth Module."""
+raise NotImplementedError

peak/base_client.py

@@ -0,0 +1,52 @@
+#
+# # Copyright © 2023 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>
+#
+"""Base client class."""
+from __future__ import annotations
+
+from typing import List, Optional
+
+from peak.session import Session, _get_default_session
+
+
+class BaseClient:
+    """Base client class."""
+
+    session: Session
+
+    def __init__(self, session: Optional[Session] = None) -> None:
+        """Assigns a session to the client. If no session is provided, a default session is used.
+
+        Args:
+            session (Optional[Session]): Session object of a tenant. Defaults to None.
+
+        Raises:
+            TypeError: If the session object is invalid.
+        """
+        invalid_session_error = f"Invalid session object, expected Session but got {type(session)}"
+        if session is not None:
+            if not isinstance(session, Session):
+                raise TypeError(invalid_session_error)
+            self.session = session
+        else:
+            self.session = _get_default_session()
+
+
+__all__: List[str] = ["BaseClient"]

peak/cli/__init_.py

@@ -0,0 +1,20 @@
+#
+# # Copyright © 2023 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>
+#

peak/cli/args.py

@@ -0,0 +1,84 @@
+#
+# # Copyright © 2023 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 arguments."""
+import typer
+from peak.cli.version import display_version
+
+VERSION_OPTION = typer.Option(False, "--version", callback=display_version, is_eager=True)
+
+TEMPLATE_PATH = typer.Argument(
+    ...,
+    help="""
+        Path to the file that defines the body for this operation, supports both `yaml` file or a `jinja` template.
+    """,
+)
+
+TEMPLATE_PARAMS_FILE = typer.Option(
+    None,
+    "--params-file",
+    "-v",
+    help="Path to the `yaml` file containing the parameter values map for the template file.",
+)
+
+TEMPLATE_PARAMS = typer.Option(
+    None,
+    "--params",
+    "-p",
+    help="Parameters to be used with the template file. Overrides the parameters in the params file. Parameters should be in the format `key=value`.",
+)
+
+PAGE_NUMBER = typer.Option(None, help="The page number to retrieve.")
+
+PAGE_SIZE = typer.Option(None, help="Number of entities to include per page.")
+
+DATE_FROM = typer.Option(None, help="The date after which the entities should be included (in ISO format).")
+
+DATE_TO = typer.Option(None, help="The date till which the entities should be included (in ISO format).")
+
+IMAGE_ID = typer.Option(..., help="ID of the image to be used in this operation.")
+
+VERSION_ID = typer.Option(..., help="ID of the version to be used in this operation.")
+
+SPEC_ID = typer.Option(..., help="ID of the spec to be used in this operation.")
+
+RELEASE_VERSION = typer.Option(..., help="Release version to be used in this operation.")
+
+SORT_KEYS = typer.Option(
+    None,
+    help="A comma-separated list of fields to order results by, in the format \\<field\\>:\\<order\\>.",
+)
+
+STATUS_FILTER = typer.Option(None, help="A comma-separated list of statuses to filter entities.")
+
+NAME_FILTER = typer.Option(None, help="Only return entities whose names begins with the query string.")
+
+TITLE_FILTER = typer.Option(None, help="Only return entities whose title begins with the query string.")
+
+SCOPES = typer.Option(None, help="A comma-separated list of scopes to only return entities of those scopes.")
+
+FEATURED = typer.Option(None, "--featured", help="Whether to only return featured entities.")
+
+KIND_FILTER = typer.Option(None, help="Only return entities with the kind specified.")
+
+TERM_FILTER = typer.Option(
+    None,
+    help="Only return entities which contain the term in name, title, description or summary.",
+)

peak/cli/cli.py

@@ -0,0 +1,56 @@
+#
+# # Copyright © 2023 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 entrypoint."""
+import sys
+
+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, webapps, workflows
+from peak.constants import Sources
+
+# Hack to not gray out texts after first paragraph
+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(artifacts.app, name="artifacts")
+typer_app.add_typer(workflows.app, name="workflows")
+typer_app.add_typer(webapps.app, name="webapps")
+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.callback()
+def main(ctx: typer.Context, version: bool = args.VERSION_OPTION) -> None:  # noqa: ARG001
+    """Add global version option and add client to context only if any command is invoked."""
+    peak.config.SOURCE = Sources.CLI
+    if "--help" not in sys.argv and ctx.invoked_subcommand:
+        ctx.obj = {
+            "client": helpers.get_client(ctx.invoked_subcommand),
+        }
+
+
+if __name__ == "__main__":
+    typer_app()

peak/cli/helpers.py

@@ -0,0 +1,187 @@
+#
+# # Copyright © 2023 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>
+#
+"""Helper functions for Peak `cli`."""
+from __future__ import annotations
+
+import inspect
+from pathlib import Path
+from types import ModuleType
+from typing import Any, Callable, Dict, List, Optional
+
+import yaml
+from peak import base_client, press, resources
+from peak.exceptions import BadParameterException
+from peak.template import load_template
+from rich.console import Console
+
+console = Console()
+
+
+def parse_params(params: Optional[List[str]]) -> Dict[str, str]:
+    """Parse parameters into key-value pairs.
+
+    Args:
+        params (Optional[List[str]]): List of key-value pairs
+
+    Returns:
+        Dict[str, str]: Dictionary of key-value pairs
+
+    Raises:
+        BadParameterException: If a value is invalid
+
+    >>> params = ["foo=1", "bar=2"]
+    >>> vals = parse_params(params)
+    >>> vals
+    {'foo': '1', 'bar': '2'}
+
+    Raises an error if a value is invalid
+    >>> parse_params(["bar==foo"]) #doctest: +IGNORE_EXCEPTION_DETAIL
+    Traceback (most recent call last):
+    ...
+    BadParameterException: Unable to parse: bar==foo
+    """
+    if params is None:
+        return {}
+
+    _to_pass: Dict[str, Any] = {}
+    for keyval in params:
+        if keyval.count("=") != 1:
+            raise BadParameterException(keyval)
+        s: List[str] = keyval.split("=", 1)  # split on first '='
+        _to_pass[s[0]] = s[-1]
+    return _to_pass
+
+
+def template_handler(
+    file: str,
+    params_file: Optional[str] = None,
+    params: Optional[List[str]] = None,
+) -> Dict[str, Any]:
+    """Loads and returns the rendered template.
+
+    Args:
+        file (str): Path to the template file.
+        params_file (Optional[str]): Path to the params map file.
+        params (Optional[List[str]]): List of params to override.
+
+    Returns:
+        Dict[str, Any]: Rendered template with values substituted.
+    """
+    params_dict: Dict[str, Any] = {}
+    if params_file:
+        with Path(params_file).open("r") as f:
+            params_dict = yaml.safe_load(f.read())
+
+    params_dict = {**params_dict, **parse_params(params)}
+
+    return load_template(file, params_dict)
+
+
+def remove_unknown_args(args: Dict[str, Any], func: Callable[..., Any]) -> Dict[str, Any]:
+    """Filters keys from dictionary which are not accepted by the function.
+
+    Args:
+        args (Dict[str, Any]): dictionary to filter
+        func (Callable): function to filter for
+
+    Returns:
+        Dict[str, Any]: filtered dictionary
+    """
+    func_params = inspect.signature(func).parameters
+    return {k: v for k, v in args.items() if k in func_params}
+
+
+def get_updated_artifacts(
+    body: Dict[str, Any],
+    artifact_path: str | None,
+    artifact_ignore_files: List[str] | None,
+) -> Dict[str, Any]:
+    """Returns updated artifacts by replacing artifact path and ignore files by the ones provided via cli args.
+
+    Args:
+        body (Dict[str, Any]): Dictionary containing request body generated from user provided yaml file
+        artifact_path (str | None): Path to the artifact.
+        artifact_ignore_files (List[str] | None): Ignore files to use when creating artifact.
+
+    Returns:
+        Dict[str, Any]: Dictionary containing updated artifacts
+    """
+    artifact: Dict[str, Any] = {}
+
+    if artifact_path:
+        artifact["path"] = artifact_path
+    elif "artifact" in body and "path" in body["artifact"]:
+        artifact["path"] = body["artifact"]["path"]
+
+    if artifact_ignore_files:
+        artifact["ignore_files"] = artifact_ignore_files
+    elif "artifact" in body and "ignore_files" in body["artifact"]:
+        artifact["ignore_files"] = body["artifact"]["ignore_files"]
+
+    return artifact
+
+
+def parse_build_arguments(build_arguments: List[str]) -> List[Dict[str, str]]:
+    """Parses build arguments provided via cli args to the format {name: arg1, value: value1}.
+
+    Args:
+        build_arguments (List[str]): List of build arguments provided via cli args
+
+    Returns:
+        List[Dict[str, str]]: List of build arguments in the required format
+
+    Raises:
+        BadParameterException: If a value is invalid
+    """
+    parsed_build_arguments: List[Dict[str, str]] = []
+    for build_argument in build_arguments:
+        try:
+            key, value = build_argument.split("=", 1)
+        except ValueError as err:
+            raise BadParameterException(
+                build_argument,
+                message="Invalid build argument format. It should in the --build-arguments arg1=value1 format",
+            ) from err
+        key, value = build_argument.split("=", 1)
+        parsed_build_arguments.append({"name": key, "value": value})
+    return parsed_build_arguments
+
+
+def get_client(command: str) -> base_client.BaseClient:
+    """Create a client for the invoked command.
+
+    Args:
+        command (str): Invoked CLI command
+
+    Returns:
+        BaseClient: client class for the invoked command
+    """
+    command_client_map: Dict[str, ModuleType] = {
+        "apps": press.apps,
+        "blocks": press.blocks,
+        "specs": press.specs,
+        "deployments": press.deployments,
+        "artifacts": resources.artifacts,
+        "images": resources.images,
+        "workflows": resources.workflows,
+        "webapps": resources.webapps,
+    }
+    return command_client_map[command].get_client()  # type: ignore[no-any-return]

peak/cli/press/__init__.py

@@ -0,0 +1,21 @@
+#
+# # Copyright © 2023 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 modules for Press resources."""

peak/cli/press/apps/__init__.py

@@ -0,0 +1,40 @@
+#
+# # Copyright © 2023 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>
+#
+"""Apps Module."""
+import typer
+from peak.cli.press.apps import deployments, specs
+
+app = typer.Typer(
+    help="Create and manage App specs and deployments.",
+    short_help="Create and manage App specs and deployments.",
+)
+app.add_typer(
+    specs.app,
+    name="specs",
+    help="Create and manage App specs which are blueprint for Peak Apps.",
+    short_help="Create and manage App Specs.",
+)
+app.add_typer(
+    deployments.app,
+    name="deployments",
+    help="Create and manage App deployments which are the actual instance of the App.",
+    short_help="Create and manage App Deployments.",
+)