cortexapps-cli 1.34.0__tar.gz → 1.35.0__tar.gz

{cortexapps_cli-1.34.0 → cortexapps_cli-1.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cortexapps-cli
-Version: 1.34.0
+Version: 1.35.0
 Summary: Command Line Interface for cortexapps
 License: MIT
 License-File: LICENSE

{cortexapps_cli-1.34.0 → cortexapps_cli-1.35.0}/cortexapps_cli/cli.py

@@ -39,6 +39,7 @@ import cortexapps_cli.commands.packages as packages
 import cortexapps_cli.commands.plugins as plugins
 import cortexapps_cli.commands.queries as queries
 import cortexapps_cli.commands.rest as rest
+import cortexapps_cli.commands.scaffolders as scaffolders
 import cortexapps_cli.commands.scim as scim
 import cortexapps_cli.commands.scorecards as scorecards
 import cortexapps_cli.commands.secrets as secrets
@@ -277,6 +278,7 @@ app.add_typer(packages.app, name="packages")
 app.add_typer(plugins.app, name="plugins")
 app.add_typer(queries.app, name="queries")
 app.add_typer(rest.app, name="rest")
+app.add_typer(scaffolders.app, name="scaffolders")
 app.add_typer(scim.app, name="scim")
 app.add_typer(scorecards.app, name="scorecards")
 app.add_typer(secrets.app, name="secrets")

cortexapps_cli-1.35.0/cortexapps_cli/commands/scaffolders.py

@@ -0,0 +1,156 @@
+from cortexapps_cli.command_options import CommandOptions
+from cortexapps_cli.command_options import ListCommandOptions
+from cortexapps_cli.utils import print_output_with_context, print_output
+from typing_extensions import Annotated
+import json
+import typer
+import yaml
+
+app = typer.Typer(
+    help="Scaffolder template commands",
+    no_args_is_help=True
+)
+
+def _is_valid_yaml(filepath):
+    try:
+        yaml.safe_load(filepath)
+        filepath.seek(0)
+        return True
+    except yaml.YAMLError:
+        return False
+
+def _is_valid_json(filepath):
+    try:
+        json.load(filepath)
+        filepath.seek(0)
+        return True
+    except json.JSONDecodeError:
+        return False
+
+def _read_definition(file_input):
+    if _is_valid_json(file_input):
+        content_type = "application/json"
+        data = json.loads("".join([line for line in file_input]))
+    elif _is_valid_yaml(file_input):
+        data = file_input.read()
+        content_type = "application/yaml"
+    else:
+        raise typer.BadParameter("Input file is neither valid JSON nor YAML.")
+    return data, content_type
+
+@app.command()
+def list(
+    ctx: typer.Context,
+    _print: CommandOptions._print = True,
+    page: ListCommandOptions.page = None,
+    page_size: ListCommandOptions.page_size = 250,
+    table_output: ListCommandOptions.table_output = False,
+    csv_output: ListCommandOptions.csv_output = False,
+    columns: ListCommandOptions.columns = [],
+    no_headers: ListCommandOptions.no_headers = False,
+    filters: ListCommandOptions.filters = [],
+    sort: ListCommandOptions.sort = [],
+):
+    """
+    List Scaffolder templates.
+    """
+
+    client = ctx.obj["client"]
+
+    params = {
+       "page": page,
+       "pageSize": page_size
+    }
+
+    if (table_output or csv_output) and not ctx.params.get('columns'):
+        ctx.params['columns'] = [
+            "Tag=tag",
+            "Name=name",
+            "Description=description",
+        ]
+
+    # remove any params that are None
+    params = {k: v for k, v in params.items() if v is not None}
+
+    if page is None:
+        # if page is not specified, we want to fetch all pages
+        r = client.fetch("api/v1/scaffolders", params=params)
+    else:
+        # if page is specified, we want to fetch only that page
+        r = client.get("api/v1/scaffolders", params=params)
+
+    if _print:
+        print_output_with_context(ctx, r)
+    else:
+        return(r)
+
+@app.command()
+def get(
+    ctx: typer.Context,
+    tag: str = typer.Option(..., "--tag", "-t", help="The tag or unique, auto-generated Cortex ID of the Scaffolder template"),
+    yaml: bool = typer.Option(False, "--yaml", "-y", help="When true, returns the YAML representation of the template."),
+    _print: CommandOptions._print = True,
+):
+    """
+    Retrieve Scaffolder template by tag or Cortex ID.
+    """
+
+    client = ctx.obj["client"]
+
+    if yaml:
+        headers={'Accept': 'application/yaml'}
+    else:
+        headers={'Accept': 'application/json'}
+    r = client.get("api/v1/scaffolders/" + tag, headers=headers)
+
+    if _print:
+        if yaml:
+           print(r)
+        else:
+           print_output_with_context(ctx, r)
+    else:
+        return(r)
+
+@app.command()
+def create(
+    ctx: typer.Context,
+    file_input: Annotated[typer.FileText, typer.Option(..., "--file", "-f", help="File containing the Scaffolder template definition; can be passed as stdin with -, example: -f-")],
+):
+    """
+    Create or update a Scaffolder template.  API key must have the Configure Scaffolder permission.  Note: If a Scaffolder template with the same tag already exists, it will be updated.
+    """
+
+    client = ctx.obj["client"]
+
+    data, content_type = _read_definition(file_input)
+    r = client.post("api/v1/scaffolders", data=data, content_type=content_type)
+    print_output(r)
+
+@app.command()
+def update(
+    ctx: typer.Context,
+    tag: Annotated[str, typer.Option(..., "--tag", "-t", help="The tag or unique, auto-generated Cortex ID of the Scaffolder template")],
+    file_input: Annotated[typer.FileText, typer.Option(..., "--file", "-f", help="File containing the Scaffolder template definition; can be passed as stdin with -, example: -f-")],
+):
+    """
+    Update a Scaffolder template by tag or Cortex ID.  API key must have the Configure Scaffolder permission.
+    """
+
+    client = ctx.obj["client"]
+
+    data, content_type = _read_definition(file_input)
+    r = client.put("api/v1/scaffolders/" + tag, data=data, content_type=content_type)
+    print_output(r)
+
+@app.command()
+def delete(
+    ctx: typer.Context,
+    tag: str = typer.Option(..., "--tag", "-t", help="The tag or unique, auto-generated Cortex ID of the Scaffolder template"),
+):
+    """
+    Delete Scaffolder template by tag or Cortex ID.  API key must have the Configure Scaffolder permission.
+    """
+
+    client = ctx.obj["client"]
+
+    r = client.delete("api/v1/scaffolders/" + tag)

{cortexapps_cli-1.34.0 → cortexapps_cli-1.35.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "cortexapps-cli"
 # version will be incremented via command line as part of github actions build
-version = "1.34.0"
+version = "1.35.0"
 description = "Command Line Interface for cortexapps"
 license = "MIT"
 authors = [