validio-cli 0.11.0__tar.gz → 0.13.0__tar.gz

{validio_cli-0.11.0 → validio_cli-0.13.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validio-cli
-Version: 0.11.0
+Version: 0.13.0
 Summary: CLI tool to interact with the Validio platform
 Home-page: https://validio.io/
 License: Apache-2.0
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: camel-converter (>=3.0.0,<4.0.0)
-Requires-Dist: classdiff (>=0.2.0,<0.3.0)
+Requires-Dist: classdiff (>=0.3.0,<0.4.0)
 Requires-Dist: prompt-toolkit (>=3.0.38,<4.0.0)
 Requires-Dist: pydantic (==2.4.2)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)

{validio_cli-0.11.0 → validio_cli-0.13.0}/pyproject.toml

@@ -3,7 +3,7 @@ name = "validio-cli"
 # This version does not represent the released version or any tag. For each
 # release we automatically bump this before building and publishing so this
 # should be kept at 0.0.1dev1
-version = "0.11.0"
+version = "0.13.0"
 description = "CLI tool to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"
@@ -15,7 +15,7 @@ readme = "README_PUBLIC.md"
 [tool.poetry.dependencies]
 python = "^3.10"
 camel-converter = "^3.0.0"
-classdiff = "^0.2.0"
+classdiff = "^0.3.0"
 validio-sdk = "*"
 typer = {extras = ["all"], version = "^0.7.0"}
 prompt-toolkit = "^3.0.38"

{validio_cli-0.11.0 → validio_cli-0.13.0}/validio_cli/bin/entities/code.py

@@ -1,6 +1,5 @@
 import os
 import pathlib
-import re
 import sys
 from collections.abc import Mapping
 from enum import Enum
@@ -334,23 +333,6 @@ async def _plan(
     return diff, manifest_ctx
 
 
-# https://stackoverflow.com/a/14693789/2274551
-ansi_escape = re.compile(
-    r"""
-   \x1B  # ESC
-   (?:   # 7-bit C1 Fe (except CSI)
-       [@-Z\\-_]
-   |     # or [ for CSI, followed by a control sequence
-       \[
-       [0-?]*  # Parameter bytes
-       [ -/]*  # Intermediate bytes
-       [@-~]   # Final byte
-   )
-""",
-    re.VERBOSE,
-)
-
-
 def _show_resources_diff(
     diff: GraphDiff,
     show_schema: bool,
@@ -412,9 +394,8 @@ def _show_create_resource_diff(
         value = code_plan._create_resource_diff_object(
             r, rewrites=rewrites, show_secrets=show_secrets
         )
-        diff = classdiff.diff(a=value, b=None, class_key=class_key)
 
-        _show_diff(diff, color, diff_output)
+        _show_diff(None, value, color, diff_output, class_key)
 
 
 def _show_delete_resource_diff(
@@ -433,9 +414,8 @@ def _show_delete_resource_diff(
         value = code_plan._create_resource_diff_object(
             r, rewrites=rewrites, show_secrets=show_secrets
         )
-        diff = classdiff.diff(a=None, b=value, class_key=class_key)
 
-        _show_diff(diff, color, diff_output)
+        _show_diff(value, None, color, diff_output, class_key)
 
 
 def _show_update_resource_diff(
@@ -457,34 +437,34 @@ def _show_update_resource_diff(
         b_value = code_plan._create_resource_diff_object(
             r.server.resource, show_secrets=show_secrets, rewrites=rewrites
         )
-        diff = classdiff.diff(a=a_value, b=b_value, class_key=class_key)
 
-        _show_diff(diff, color, diff_output)
+        _show_diff(b_value, a_value, color, diff_output, class_key)
 
 
-def _show_diff(diff: Any, color: bool, diff_output: DiffOutput) -> None:
+def _show_diff(
+    current_value: Any,
+    new_value: Any,
+    color: bool,
+    diff_output: DiffOutput,
+    class_key: str | None = None,
+) -> None:
     if diff_output == DiffOutput.NONE:
         return
 
+    diff = classdiff.diff(
+        current_value,
+        new_value,
+        no_color=not color,
+        changes_only=diff_output == DiffOutput.CHANGES,
+        object_name=class_key,
+    )
+
+    print(diff)
+
     # We keep track if any lines were printed at all (any changes or full
     # output) and if not we don't add a newline. This is to make it more
     # condensed and consistent with the DiffOutput.NONE output.
-    any_lines_printed = False
-
-    for diff_info in diff:
-        if (
-            diff_output == DiffOutput.CHANGES
-            and diff_info.diff_type == classdiff.DiffType.UNCHANGED
-        ):
-            continue
-
-        any_lines_printed = True
-        line = str(diff_info)
-        if not color:
-            line = ansi_escape.sub("", line)
-        print(f"{line}")
-
-    if any_lines_printed:
+    if diff:
         print()
 
 

{validio_cli-0.11.0 → validio_cli-0.13.0}/validio_cli/bin/entities/sources.py

@@ -15,6 +15,7 @@ from validio_sdk.graphql_client.input_types import (
     AwsRedshiftInferSchemaInput,
     AwsS3InferSchemaInput,
     CsvParserInput,
+    DatabricksInferSchemaInput,
     GcpBigQueryInferSchemaInput,
     GcpPubSubInferSchemaInput,
     GcpPubSubLiteInferSchemaInput,
@@ -258,6 +259,7 @@ async def _interactive(config_dir: str, filename: Path, namespace: str) -> None:
             ("kinesis", "Amazon Kinesis"),
             ("s3", "Amazon S3"),
         ],
+        "DatabricksCredential": [("databricks", "Databricks")],
         "DemoCredential": [("demo", "Demo")],
         "GcpCredential": [
             ("bigquery", "Google BigQuery"),
@@ -288,6 +290,20 @@ async def _interactive(config_dir: str, filename: Path, namespace: str) -> None:
         return
 
     match inference_type:
+        case "databricks":
+            info = await _multip_prompt([
+                ("Catalog", [], ""),
+                ("Schema", [], ""),
+                ("Table", [], ""),
+            ])
+            await _infer_schema_databricks(
+                vc,
+                filename,
+                credential_id,
+                info.get("catalog", ""),
+                info.get("schema", ""),
+                info.get("table", ""),
+            )
         case "demo":
             await _infer_schema_demo(vc, filename)
         case "kinesis":
@@ -815,6 +831,26 @@ async def gcs(
     )
 
 
+async def _infer_schema_databricks(
+    vc: ValidioAPIClient,
+    filename: Path,
+    credential_id: str,
+    catalog: str,
+    db_schema: str,
+    table: str,
+) -> None:
+    schema = await vc.infer_databricks_schema(
+        DatabricksInferSchemaInput(
+            credential_id=credential_id,
+            http_path="",
+            catalog=catalog,
+            db_schema=db_schema,
+            table=table,
+        )
+    )
+    _write_schema(filename, schema)
+
+
 async def _infer_schema_demo(
     vc: ValidioAPIClient,
     filename: Path,
@@ -1155,9 +1191,9 @@ async def _resolve_credential(
 def _get_message_format_input(
     message_format: str | None, message_schema: str | None
 ) -> StreamingSourceMessageFormatConfigInput | None:
-    if any([message_format, message_schema]) and not all([
-        message_format, message_schema
-    ]):
+    if any([message_format, message_schema]) and not all(
+        [message_format, message_schema]
+    ):
         raise ValidioError(
             "Both message_format and message_schema must be supplied, or neither them"
         )

validio_cli-0.13.0/validio_cli/bin/main.py

@@ -0,0 +1,177 @@
+import os
+import shutil
+import sys
+from typing import Optional
+
+import typer
+import validio_sdk.metadata
+from tabulate import tabulate
+from validio_sdk import ValidioError
+from validio_sdk.config import Config
+
+import validio_cli.metadata
+from validio_cli.bin.entities import (
+    channels,
+    code,
+    config,
+    credentials,
+    dbt,
+    incidents,
+    metrics,
+    notification_rules,
+    recommendations,
+    resources,
+    segmentations,
+    segments,
+    sources,
+    users,
+    validators,
+    windows,
+)
+
+app = typer.Typer(
+    help="Validio CLI tool",
+    no_args_is_help=True,
+    pretty_exceptions_enable=False,
+    rich_markup_mode="rich",
+)
+
+app.add_typer(channels.app, no_args_is_help=True, name="channels")
+app.add_typer(code.app, no_args_is_help=True, name="code")
+app.add_typer(config.app, no_args_is_help=True, name="config")
+app.add_typer(credentials.app, no_args_is_help=True, name="credentials")
+app.add_typer(dbt.app, no_args_is_help=True, name="dbt")
+app.add_typer(incidents.app, no_args_is_help=True, name="incidents")
+app.add_typer(metrics.app, no_args_is_help=True, name="metrics")
+app.add_typer(resources.app, no_args_is_help=True, name="resources")
+app.add_typer(notification_rules.app, no_args_is_help=True, name="notification-rules")
+app.add_typer(recommendations.app, no_args_is_help=True, name="recommendations")
+app.add_typer(segmentations.app, no_args_is_help=True, name="segmentations")
+app.add_typer(segments.app, no_args_is_help=True, name="segments")
+app.add_typer(sources.app, no_args_is_help=True, name="sources")
+app.add_typer(users.app, no_args_is_help=True, name="users")
+app.add_typer(validators.app, no_args_is_help=True, name="validators")
+app.add_typer(windows.app, no_args_is_help=True, name="windows")
+
+
+@app.command(help="Show current version")
+def version() -> None:
+    print(
+        tabulate(
+            [
+                ["SDK version", validio_sdk.metadata.version()],
+                ["CLI version", validio_cli.metadata.version()],
+            ],
+            tablefmt="plain",
+        )
+    )
+
+
+@app.command(
+    add_help_option=False,
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+)
+def plugins(
+    ctx: typer.Context,
+    # We need to keep this for typer
+    # ruff: noqa: UP007
+    plugin: Optional[str] = typer.Argument(
+        None,
+        help="Plugin to run. Leave empty to list available plugins.",
+    ),
+) -> None:
+    """
+    Run plugin.
+
+    This works similar to `git` in that any executable prefixed with `validio-`
+    will be executed through this CLI without the prefix. That means that if you
+    have an executable somewhere in your `PATH` named `validio-my-app` you can
+    invoke that by running `validio plugin my-app`.
+
+    Any additional arguments will be passed to your plugin so you can run
+    `validio plugin my-app --arg1 --arg2`.
+    """
+    # We allow plugin as None since we want to show all available plugins when
+    # this part is
+    if plugin is None:
+        _list_executables()
+        return
+
+    # Since we want to allow passing any argument to plugins we accept extra
+    # unknown arguments and remove the `--help` flag so it can be passed to the
+    # plugin. However, if the _only_ argument passed (i.e. the `plugin`) is help
+    # we assume that the user wants help about the `plugin` subcommand.
+    if plugin in ["-h", "--help"]:
+        typer.echo(ctx.get_help())
+        return
+
+    plugin_path = shutil.which(f"validio-{plugin}")
+    if not plugin_path:
+        raise ValidioError(f"Unknown plugin {plugin}")
+
+    cfg = Config(None)
+    validio_cfg = cfg.read()
+
+    os.execve(
+        plugin_path,
+        [plugin_path] + sys.argv[3:],
+        # If someone wants to write a plugin with tooling that doesn't have an
+        # SDK we kindly pass the credentials to the environment so you can
+        # easily call Validio anyway.
+        {
+            "VALIDIO_CONFIG_PATH": str(cfg.config_path),
+            "VALIDIO_ENDPOINT": validio_cfg.endpoint,
+            "VALIDIO_ACCESS_KEY_ENV": validio_cfg.access_key,
+            "VALIDIO_SECRET_ACCESS_KEY_ENV": validio_cfg._access_secret,
+        },
+    )
+
+
+def _list_executables() -> None:
+    paths = os.environ.get("PATH", "").split(":")
+
+    executables = set()
+    for path in paths:
+        try:
+            executables.update({
+                filename.lstrip("validio-")
+                for filename in os.listdir(path)
+                if filename.startswith("validio-")
+            })
+        except FileNotFoundError:
+            continue
+
+    if not executables:
+        print("No plugins found")
+        return
+
+    print(
+        tabulate(
+            [[executable] for executable in executables],
+            tablefmt="plain",
+            headers=["PLUGIN NAME"],
+        )
+    )
+
+
+def main() -> None:
+    exit_code = 1
+
+    try:
+        app()
+        exit_code = 0
+
+    # If the pipe is broken we can't print more so just return asap.
+    except BrokenPipeError:
+        return
+
+    # ValidioErrors are thrown by us and should not require the stack trace
+    # to tell what went wrong.
+    except ValidioError as e:
+        print(f"Something went wrong: {e}")
+
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()

validio_cli-0.11.0/validio_cli/bin/main.py

@@ -1,83 +0,0 @@
-import sys
-
-import typer
-import validio_sdk.metadata
-from tabulate import tabulate
-from validio_sdk import ValidioError
-
-import validio_cli.metadata
-from validio_cli.bin.entities import (
-    channels,
-    code,
-    config,
-    credentials,
-    dbt,
-    incidents,
-    metrics,
-    notification_rules,
-    recommendations,
-    resources,
-    segmentations,
-    segments,
-    sources,
-    users,
-    validators,
-    windows,
-)
-
-app = typer.Typer(
-    help="Validio CLI tool", no_args_is_help=True, pretty_exceptions_enable=False
-)
-
-app.add_typer(channels.app, no_args_is_help=True, name="channels")
-app.add_typer(code.app, no_args_is_help=True, name="code")
-app.add_typer(config.app, no_args_is_help=True, name="config")
-app.add_typer(credentials.app, no_args_is_help=True, name="credentials")
-app.add_typer(dbt.app, no_args_is_help=True, name="dbt")
-app.add_typer(incidents.app, no_args_is_help=True, name="incidents")
-app.add_typer(metrics.app, no_args_is_help=True, name="metrics")
-app.add_typer(resources.app, no_args_is_help=True, name="resources")
-app.add_typer(notification_rules.app, no_args_is_help=True, name="notification-rules")
-app.add_typer(recommendations.app, no_args_is_help=True, name="recommendations")
-app.add_typer(segmentations.app, no_args_is_help=True, name="segmentations")
-app.add_typer(segments.app, no_args_is_help=True, name="segments")
-app.add_typer(sources.app, no_args_is_help=True, name="sources")
-app.add_typer(users.app, no_args_is_help=True, name="users")
-app.add_typer(validators.app, no_args_is_help=True, name="validators")
-app.add_typer(windows.app, no_args_is_help=True, name="windows")
-
-
-@app.command(help="Show current version")
-def version() -> None:
-    print(
-        tabulate(
-            [
-                ["SDK version", validio_sdk.metadata.version()],
-                ["CLI version", validio_cli.metadata.version()],
-            ],
-            tablefmt="plain",
-        )
-    )
-
-
-def main() -> None:
-    exit_code = 1
-
-    try:
-        app()
-        exit_code = 0
-
-    # If the pipe is broken we can't print more so just return asap.
-    except BrokenPipeError:
-        return
-
-    # ValidioErrors are thrown by us and should not require the stack trace
-    # to tell what went wrong.
-    except ValidioError as e:
-        print(f"Something went wrong: {e}")
-
-    sys.exit(exit_code)
-
-
-if __name__ == "__main__":
-    main()