peak-sdk 1.0.0__py3-none-any.whl

peak/cli/resources/webapps.py

@@ -0,0 +1,356 @@
+#
+# # 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 Webapps service commands."""
+
+from typing import Any, Dict, List, Optional
+
+import typer
+from peak.cli import args, helpers
+from peak.helpers import combine_dictionaries, map_user_options, parse_list_of_strings, variables_to_dict
+from peak.resources.webapps import Webapp
+from rich.console import Console
+from typing_extensions import Annotated
+
+app = typer.Typer(
+    help="Visualize your data and predictions using Webapps. Please note that only generic (EKS-based) webapps are supported with CLI.",
+    short_help="Create and Manage Webapps.",
+)
+
+console = Console()
+
+_WEBAPP_ID = typer.Argument(..., help="ID of the webapp to be used in this operation")
+
+_LIST_STATUS = typer.Option(None, help="A list of webapp status to filter the list by.")
+
+_LIST_NAME = typer.Option(None, help="Webapp name to search for")
+
+FILE_HELP_STRING = (
+    "Path to the file that defines the body for this operation, supports both `yaml` file or a `jinja` template."
+)
+
+NAME = typer.Option(None, help="Name of the webapp")
+
+DESCRIPTION = typer.Option(None, help="Description of the webapp")
+
+TITLE = typer.Option(None, help="Title of the webapp")
+
+IMAGE_ID = typer.Option(None, help="ID of the image to be used in this operation.")
+
+VERSION_ID = typer.Option(
+    None,
+    help="ID of the version to be used in this operation. If version-id is not passed, webapp will be created using latest ready version of the image.",
+)
+
+MAPPING = {"imageId": "imageDetails", "versionId": "imageDetails"}
+
+
+@app.command("list", short_help="List webapps.")
+def list_webapps(
+    ctx: typer.Context,
+    page_size: Optional[int] = args.PAGE_SIZE,
+    page_number: Optional[int] = args.PAGE_NUMBER,
+    status: Optional[List[str]] = _LIST_STATUS,
+    name: Optional[str] = _LIST_NAME,
+) -> None:
+    """***List*** all webapps that exist for the tenant.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak webapps list --page-size 10 --page-number 1 --status CREATING --name test
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "webappsCount": 1,
+        "webapps": [...],
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 25
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/list-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+    response = webapp_client.list_webapps(
+        page_size=page_size,
+        page_number=page_number,
+        return_iterator=False,
+        status=parse_list_of_strings(status),
+        name=name,
+    )
+    console.print(response)
+
+
+@app.command(short_help="Create a new webapp.")
+def create(
+    ctx: typer.Context,
+    file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
+    params_file: str = args.TEMPLATE_PARAMS_FILE,
+    params: List[str] = args.TEMPLATE_PARAMS,
+    name: str = NAME,
+    title: str = TITLE,
+    description: str = DESCRIPTION,
+    image_id: str = IMAGE_ID,
+    version_id: str = VERSION_ID,
+) -> None:
+    """***Create*** a new webapp and start its deployment.
+
+    \b
+    🧩 ***Input file schema(yaml):***<br/>
+    ```yaml
+      body (map):
+        name (string): Name of the webapp.
+        title (string | required: false): Title of the webapp.
+        description (string | required: false): Description of the webapp.
+        imageDetails (map):
+            imageId (number): ID of the image.
+            versionId (number | required: false): ID of the image version. If versionId is not passed, webapp will be created using latest ready version of the image.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak webapps create '/path/to/file.yml' -v '/path/to/params.yml'
+    ```
+
+    \b
+    📝 ***Example usage without yaml:***
+    ```bash
+    peak webapps create --name <name> --title <title> --description <description> --image-id <image-id> --version-id <version-id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "db88c21d-1add-45dd-a72e-8c6b83b68dee"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/create-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+
+    user_options: Dict[str, Any] = variables_to_dict(name, description, title, image_id, version_id)
+    user_options = map_user_options(user_options, MAPPING)
+
+    body: Dict[str, Any] = {}
+    if file:
+        body = helpers.template_handler(file=file, params_file=params_file, params=params)
+        body = helpers.remove_unknown_args(body, webapp_client.create_webapp)
+
+    body = combine_dictionaries(body.get("body") or {}, user_options)
+
+    response = webapp_client.create_webapp(body=body)
+    console.print(response)
+
+
+@app.command(short_help="Update an existing webapp.")
+def update(
+    ctx: typer.Context,
+    webapp_id: str = _WEBAPP_ID,
+    file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
+    params_file: str = args.TEMPLATE_PARAMS_FILE,
+    params: List[str] = args.TEMPLATE_PARAMS,
+    title: str = TITLE,
+    description: str = DESCRIPTION,
+    image_id: str = IMAGE_ID,
+    version_id: str = VERSION_ID,
+) -> None:
+    """***Update*** an existing webapp.
+
+    \b
+    🧩 ***Input file schema(yaml):***<br/>
+    ```yaml
+      body (map):
+        title (string | required: false): Title of the webapp.
+        description (string | required: false): Description of the webapp.
+        imageDetails (map | required: false):
+            imageId (number): ID of the image.
+            versionId (number | required: false): ID of the image version. If versionId is not passed, webapp will be created using latest ready version of the image.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak webapps update "ab11c21d-1add-45dd-a72e-8c6b83b68dee" '/path/to/file.yml' -v '/path/to/params.yml'
+    ```
+
+     \b
+    📝 ***Example usage without yaml:***
+    ```bash
+    peak webapps update "ab11c21d-1add-45dd-a72e-8c6b83b68dee" --title <title> --description <description> --image-id <image-id> --version-id <version-id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "ab11c21d-1add-45dd-a72e-8c6b83b68dee"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/update-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+
+    user_options: Dict[str, Any] = variables_to_dict(description, title, image_id, version_id)
+    user_options = map_user_options(user_options, MAPPING)
+
+    body: Dict[str, Any] = {}
+    if file:
+        body = helpers.template_handler(file=file, params_file=params_file, params=params)
+        body = helpers.remove_unknown_args(body, webapp_client.update_webapp)
+    body = combine_dictionaries(body.get("body") or {}, user_options)
+
+    response = webapp_client.update_webapp(webapp_id=webapp_id, body=body)
+    console.print(response)
+
+
+@app.command(short_help="Create a new webapp or Update an existing webapp.")
+def create_or_update(
+    ctx: typer.Context,
+    file: Annotated[Optional[str], typer.Argument(..., help=FILE_HELP_STRING)] = None,
+    params_file: str = args.TEMPLATE_PARAMS_FILE,
+    params: List[str] = args.TEMPLATE_PARAMS,
+    name: str = NAME,
+    title: str = TITLE,
+    description: str = DESCRIPTION,
+    image_id: str = IMAGE_ID,
+    version_id: str = VERSION_ID,
+) -> None:
+    """***Create*** a new webapp or ***Update*** an existing webapp based on webapp name and start its deployment.
+
+    \b
+    🧩 ***Input file schema(yaml):***<br/>
+    ```yaml
+      body (map):
+        name (string): Name of the webapp.
+        title (string | required: false): Title of the webapp.
+        description (string | required: false): Description of the webapp.
+        imageDetails (map):
+            imageId (number): ID of the image.
+            versionId (number | required: false): ID of the image version. If versionId is not passed, webapp will be created using latest ready version of the image.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak webapps create-or-update '/path/to/file.yml' -v '/path/to/params.yml'
+    ```
+
+    \b
+    📝 ***Example usage without yaml:***
+    ```bash
+    peak webapps create-or-update --name <name> --title <title> --description <description> --image-id <image-id> --version-id <version-id>
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "db88c21d-1add-45dd-a72e-8c6b83b68dee"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/create-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+
+    user_options: Dict[str, Any] = variables_to_dict(name, description, title, image_id, version_id)
+    user_options = map_user_options(user_options, MAPPING)
+
+    body: Dict[str, Any] = {}
+    if file:
+        body = helpers.template_handler(file=file, params_file=params_file, params=params)
+        body = helpers.remove_unknown_args(body, webapp_client.create_or_update_webapp)
+
+    body = combine_dictionaries(body.get("body") or {}, user_options)
+
+    response = webapp_client.create_or_update_webapp(body=body)
+    console.print(response)
+
+
+@app.command(short_help="Delete an existing webapp.")
+def delete(ctx: typer.Context, webapp_id: str = _WEBAPP_ID) -> None:
+    """***Delete*** an existing webapp.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak webapps delete "ab11c21d-1add-45dd-a72e-8c6b83b68dee"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "ab11c21d-1add-45dd-a72e-8c6b83b68dee"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/delete-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+    response = webapp_client.delete_webapp(webapp_id=webapp_id)
+    console.print(response)
+
+
+@app.command(short_help="Describe details of a webapp.")
+def describe(ctx: typer.Context, webapp_id: str = _WEBAPP_ID) -> None:
+    """***Describe*** details for the specific webapp.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak webapps describe "ab11c21d-1add-45dd-a72e-8c6b83b68dee"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "id": "ab11c21d-1add-45dd-a72e-8c6b83b68dee",
+        "name": "awesome-webapp",
+        "status": "AVAILABLE",
+        "imageDetails": {
+            "imageId": 1,
+            "versionId": 1
+        },
+        "createdAt": "2020-01-01T18:00:00.000Z",
+        "createdBy": "someone@peak.ai",
+        "updatedAt": "2020-01-01T18:00:00.000Z",
+        "updatedBy": "someone@peak.ai",
+        "tags": [...]
+    }
+    ```
+
+    🔗 [**API Documentation**](https://service.peak.ai/webapps/api-docs/index.htm#/Webapps/get-webapp)
+    """
+    webapp_client: Webapp = ctx.obj["client"]
+    response = webapp_client.describe_webapp(webapp_id=webapp_id)
+    console.print(response)