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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: validio-cli
-Version: 0.12.0
+Version: 0.13.0
 Summary: CLI tool to interact with the Validio platform
 Home-page: https://validio.io/
 License: Apache-2.0

{validio_cli-0.12.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.12.0"
+version = "0.13.0"
 description = "CLI tool to interact with the Validio platform"
 authors = ["Validio <support@validio.io>"]
 license = "Apache-2.0"

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.12.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()