peak-sdk 1.0.0__py3-none-any.whl

peak/cli/press/apps/deployments.py

@@ -0,0 +1,238 @@
+#
+# # 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 apps deployments commands."""
+from typing import Dict, List, Optional
+
+import typer
+from peak.cli import args, helpers
+from peak.press.apps import App
+from rich.console import Console
+
+app = typer.Typer()
+console = Console()
+
+_DEPLOYMENT_ID = typer.Argument(..., help="ID of the App deployment to be used in this operation.")
+
+
+@app.command(short_help="Create an App deployment.")
+def create(
+    ctx: typer.Context,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+) -> None:
+    """***Create*** an App deployment. This creates all the resources (Example - Workflow, Webapps, etc) described in the App Spec.
+
+    \b
+    🧩 ***Input file schema (yaml):***
+    ```yaml
+    body (map):
+        metadata (map):
+            name (string | required: false): Name of the deployment. Must be unique within the tenant.
+            title (string | required: false): Title of the deployment.
+            summary (string | required: false): Summary of the deployment.
+            description (string | required: false): Description of the deployment.
+            descriptionContentType (string | required: false): Content type of the description. Should be one of "text/plain" or "text/markdown".
+            imageUrl (string | required: false): URL of the image to be associated with the app deployment.
+            tags (list(map) | required: false):
+                - name (string): Name of the tag.
+        revision (map | required: false):
+            notes (string | required: false): Notes for the deployment revision.
+        spec (map):
+            id (string): ID of the app spec to be deployed.
+            release (map | required: false):
+                version (string): A valid semantic release version of the app spec.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak apps deployments create /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/post_v1_apps_deployments)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    app_client: App = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, app_client.create_deployment)
+    response: Dict[str, str] = app_client.create_deployment(**body)
+
+    console.print(response)
+
+
+@app.command("list", short_help="List App deployments.")
+def list_app_deployments(
+    ctx: typer.Context,
+    page_size: Optional[int] = args.PAGE_SIZE,
+    page_number: Optional[int] = args.PAGE_NUMBER,
+    status: Optional[List[str]] = args.STATUS_FILTER,
+    name: Optional[str] = args.NAME_FILTER,
+    sort: Optional[List[str]] = args.SORT_KEYS,
+) -> None:
+    """***List*** all the App deployments that have been created for the tenant.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps deployments list --sort createdBy:asc,name --page-size 10 --page-number 1
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "deploymentCount": 1,
+        "deployments": [...],
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 10
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/get_v1_apps_deployments)
+    """
+    app_client = ctx.obj["client"]
+    response = app_client.list_deployments(
+        status=status,
+        name=name,
+        sort=sort,
+        page_size=page_size,
+        page_number=page_number,
+        return_iterator=False,
+    )
+    console.print(response)
+
+
+@app.command(short_help="Describe an App deployment.")
+def describe(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+) -> None:
+    """***Describe*** an App deployment with details of its latest revision.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps deployments describe "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb",
+        "kind": "app",
+        "latestRevision": {...},
+        "metadata": {...},
+        "spec": {...}
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/get_v1_apps_deployments__deploymentId_)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.describe_deployment(deployment_id)
+    console.print(response)
+
+
+@app.command(short_help="Delete an App deployment.")
+def delete(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+) -> None:
+    """***Delete*** an App deployment. This deletes all the resources that were created as a part of the deployment.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps deployments delete "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {}
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/delete_v1_apps_deployments__deploymentId_)
+    """
+    app_client = ctx.obj["client"]
+    response = app_client.delete_deployment(deployment_id)
+    console.print(response)
+
+
+@app.command(short_help="Update the App deployment metadata.")
+def update_metadata(
+    ctx: typer.Context,
+    deployment_id: str = _DEPLOYMENT_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+) -> None:
+    """***Update*** the App deployment metadata.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+      body (map):
+        name (string | required: false): Name of the deployment. Must be unique within the tenant.
+        title (string | required: false): Title of the deployment.
+        summary (string | required: false): Summary of the deployment.
+        description (string | required: false): Description of the deployment.
+        descriptionContentType (string | required: false): Content type of the description. Should be one of "text/plain" or "text/markdown".
+        imageUrl (string | required: false): URL of the image to be associated with the app deployment.
+        tags (list(map) | required: false):
+            - name (string): Name of the tag.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak apps deployments update-metadata "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+        "kind": "app",
+        "latestRevision": {...},
+        "metadata": {...},
+        "spec": {...}
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Deployments/patch_v1_apps_deployments__deploymentId_)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    app_client = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, app_client.update_deployment_metadata)
+    response = app_client.update_deployment_metadata(deployment_id, **body)
+    console.print(response)

peak/cli/press/apps/specs.py

@@ -0,0 +1,387 @@
+#
+# # 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 apps specs commands."""
+from typing import Dict, List, Optional
+
+import typer
+from peak.cli import args, helpers
+from peak.press.apps import App
+from rich.console import Console
+
+app = typer.Typer()
+console = Console()
+
+_SPEC_ID = typer.Argument(..., help="ID of the App spec to be used in this operation.")
+
+
+@app.command(short_help="Create an App spec.")
+def create(
+    ctx: typer.Context,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+) -> None:
+    """***Create*** an App spec. A Spec is just a blueprint for an App and defines all the resources that need to be created for the App. This creates a version of the spec also known as ***Release***.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+      featured (bool | required: false): Boolean specifying whether to feature this spec.
+      scope (str | required: false): Specify what tenants can discover and deploy this spec.
+      tenants (list(str) | required: false): Given a shared scope, specify what other tenants can discover and deploy this spec.
+      body (map):
+        version (int): Version of the spec.
+        kind (string): Specifies the type of spec. Should be "app" in case of app spec.
+        metadata (map):
+            name (string): Name of the spec. Must be unique within the tenant.
+            title (string | required: false): Title of the spec.
+            summary (string): Summary of the spec.
+            description (string | required: false): Description of the spec.
+            descriptionContentType (string | required: false): Content type of the description. Should be one of "text/plain" or "text/markdown".
+            imageUrl (string | required: false): URL of the image to be associated with the app spec.
+            tags (list(map) | required: false):
+                - name (string): Name of the tag.
+        release (map):
+            version (string): A valid semantic release version of the spec.
+            notes (string | required: false): Notes for the release version.
+        config (list(map)):
+            - id (string): ID of the block spec.
+              release (map):
+                version (string): A valid semantic release version of the block spec.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak apps specs create /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs_)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    app_client: App = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, app_client.create_spec)
+    response: Dict[str, str] = app_client.create_spec(**body)
+
+    console.print(response)
+
+
+@app.command("list", short_help="List App specs.")
+def list_app_specs(
+    ctx: typer.Context,
+    page_size: Optional[int] = args.PAGE_SIZE,
+    page_number: Optional[int] = args.PAGE_NUMBER,
+    status: Optional[List[str]] = args.STATUS_FILTER,
+    name: Optional[str] = args.NAME_FILTER,
+    title: Optional[str] = args.TITLE_FILTER,
+    sort: Optional[List[str]] = args.SORT_KEYS,
+    scope: Optional[List[str]] = args.SCOPES,
+    featured: Optional[bool] = args.FEATURED,
+) -> None:
+    """***List*** all App specs that have been created for the tenant along with the public-scoped ones.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps specs list --sort name:asc,title --page-size 10 --page-number 1
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "specCount": 1,
+        "specs": [...],
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 10
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/get_v1_apps_specs_)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.list_specs(
+        status=status,
+        featured=featured,
+        name=name,
+        title=title,
+        sort=sort,
+        scope=scope,
+        page_size=page_size,
+        page_number=page_number,
+        return_iterator=False,
+    )
+    console.print(response)
+
+
+@app.command(short_help="Describe an App spec.")
+def describe(
+    ctx: typer.Context,
+    spec_id: str = _SPEC_ID,
+) -> None:
+    """***Describe*** an App spec with details of its latest release.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps specs describe "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "featured": true,
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+        "kind": "app",
+        "latestRelease": {...},
+        "metadata": {...},
+        "scope": "private"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/get_v1_apps_specs__specId_)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.describe_spec(spec_id)
+    console.print(response)
+
+
+@app.command(short_help="Update the App spec metadata.")
+def update_metadata(
+    ctx: typer.Context,
+    spec_id: str = _SPEC_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+) -> None:
+    """***Update*** the App spec metadata.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+      body (map):
+        featured (bool | required: false): Boolean specifying whether to feature this spec.
+        scope (str | required: false): Specify what tenants can discover and deploy this spec.
+        tenants (list(str) | required: false): Given a shared scope, specify what other tenants can discover and deploy this spec.
+        metadata (map):
+            name (string | required: false): Name of the spec. Must be unique within the tenant.
+            title (string | required: false): Title of the spec.
+            summary (string | required: false): Summary of the spec.
+            description (string | required: false): Description of the spec.
+            descriptionContentType (string | required: false): Content type of the description. Should be one of "text/plain" or "text/markdown".
+            imageUrl (string | required: false): URL of the image to be associated with the app spec.
+            status (string | required: false): Status of the app spec.
+            tags (list(map) | required: false):
+                - name (string): Name of the tag.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak apps specs update-metadata "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "featured": false,
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+        "kind": "app",
+        "latestRelease": {...},
+        "metadata": {...},
+        "scope": "private"
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/patch_v1_apps_specs__specId_)
+    """
+    data = helpers.template_handler(file, params_file, params)
+    app_client: App = ctx.obj["client"]
+    data = helpers.remove_unknown_args(data, app_client.update_spec_metadata)
+    response: Dict[None, None] = app_client.update_spec_metadata(spec_id, **data)
+    console.print(response)
+
+
+@app.command(short_help="Delete an App spec.")
+def delete(
+    ctx: typer.Context,
+    spec_id: str = _SPEC_ID,
+) -> None:
+    """***Delete*** an App spec.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps specs delete "632a4e7c-ab86-4ecb-8f34-99b5da531ceb"
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {}
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/delete_v1_apps_specs__specId_)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.delete_spec(spec_id)
+    console.print(response)
+
+
+@app.command(short_help="Create a new release of the App spec.")
+def create_release(
+    ctx: typer.Context,
+    spec_id: str = _SPEC_ID,
+    file: str = args.TEMPLATE_PATH,
+    params_file: Optional[str] = args.TEMPLATE_PARAMS_FILE,
+    params: Optional[List[str]] = args.TEMPLATE_PARAMS,
+) -> None:
+    """***Create*** a new release of the App spec.
+
+    \b
+    🧩 ***Input file schema (yaml):***<br/>
+    ```yaml
+      body (map):
+        release (map):
+            version (string): A valid semantic release version of the spec. Must be greater than previous release version.
+            notes (string | required: false): Notes for the release version.
+        config (list(map)):
+            - id (string): ID of the block spec.
+              release (map):
+                version (string): A valid semantic release version of the block spec.
+    ```
+
+    \b
+    📝 ***Example usage:***
+    ```bash
+    peak apps specs create-release "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" /path/to/body.yaml -v /path/to/params.yaml
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb",
+        "release": {
+            "version": "2.0.0"
+        }
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/post_v1_apps_specs__specId__releases)
+    """
+    body = helpers.template_handler(file, params_file, params)
+    app_client: App = ctx.obj["client"]
+    body = helpers.remove_unknown_args(body, app_client.create_spec_release)
+    response: Dict[str, str] = app_client.create_spec_release(spec_id, **body)
+    console.print(response)
+
+
+@app.command(short_help="Describe an App spec release.")
+def describe_release(
+    ctx: typer.Context,
+    spec_id: str = args.SPEC_ID,
+    version: str = args.RELEASE_VERSION,
+) -> None:
+    """***Describe*** an App spec release.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps specs describe-release --spec-id "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" --version 1.0.0
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```json
+    {
+        "config": [
+            {
+                "id": "632a4e7c-ab86-4ecb-8f34-99b5da531ceb",
+                "release": {
+                    "version": "1.0.0"
+                }
+            }
+        ],
+        "createdAt": "2020-01-01T18:00:00.000Z",
+        "createdBy": "jane.smith@peak.ai",
+        "id": "6a6b9e08-638e-4116-a29d-077086135062",
+        "notes": "Updated workflows with new algorithms."
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/get_v1_apps_specs__specId__releases__release_)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.describe_spec_release(spec_id, version)
+    console.print(response)
+
+
+@app.command(short_help="List App specs releases.")
+def list_releases(
+    ctx: typer.Context,
+    spec_id: str = args.SPEC_ID,
+    sort: Optional[List[str]] = args.SORT_KEYS,
+    page_size: Optional[int] = args.PAGE_SIZE,
+    page_number: Optional[int] = args.PAGE_NUMBER,
+) -> None:
+    """***List*** all the releases for a specific App Spec.
+
+    \b
+    📝 ***Example usage:***<br/>
+    ```bash
+    peak apps specs list-releases --spec-id "632a4e7c-ab86-4ecb-8f34-99b5da531ceb" --sort createdAt:asc --page-size 10 --page-number 1
+    ```
+
+    \b
+    🆗 ***Response:***
+    ```
+    {
+        "pageCount": 1,
+        "pageNumber": 1,
+        "pageSize": 10,
+        "releaseCount": 1,
+        "releases": [...]
+    }
+    ```
+
+    🔗 [**API Documentation**](https://press.peak.ai/api-docs/index.htm#/App%20Specs/get_v1_apps_specs__specId__releases)
+    """
+    app_client: App = ctx.obj["client"]
+    response = app_client.list_spec_releases(
+        spec_id=spec_id,
+        sort=sort,
+        page_size=page_size,
+        page_number=page_number,
+        return_iterator=False,
+    )
+    console.print(response)

peak/cli/press/blocks/__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>
+#
+"""Blocks Module."""
+import typer
+from peak.cli.press.blocks import deployments, specs
+
+app = typer.Typer(
+    help="Create and manage Block specs and deployments.",
+    short_help="Create and manage Block specs and deployments.",
+)
+app.add_typer(
+    specs.app,
+    name="specs",
+    help="Create and manage Block specs which are blueprint for Peak resources.",
+    short_help="Create and manage Block Specs.",
+)
+app.add_typer(
+    deployments.app,
+    name="deployments",
+    help="Create and manage Block deployments which deploys the Peak resources based on the created specs.",
+    short_help="Create and manage Block Deployments.",
+)