viur-cli 3.0.0__tar.gz → 3.0.0b2__tar.gz

{viur_cli-3.0.0/src/viur_cli.egg-info → viur_cli-3.0.0b2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viur-cli
-Version: 3.0.0
+Version: 3.0.0b2
 Summary: Command-line interface for ViUR application maintenance.
 Author-email: "Andreas H. Kelch" <ak@mausbrand.de>
 License-Expression: MIT

{viur_cli-3.0.0 → viur_cli-3.0.0b2}/pyproject.toml

@@ -30,7 +30,7 @@ Homepage = "https://github.com/viur-framework/viur-cli"
 "Bug Tracker" = "https://github.com/viur-framework/viur-cli/issues"
 
 [project.scripts]
-viur = "viur_cli:cli"
+viur = "viur_cli.cli:main"
 get-pyodide = "viur_cli.scripts.get_pyodide:main"
 
 [tool.setuptools]
@@ -39,3 +39,9 @@ packages = { find = { where = ["src"] } }
 
 [tool.setuptools.dynamic]
 version = { attr = "viur_cli.version.__version__" }
+
+[dependency-groups]
+docs = [
+    "mkdocs-shadcn",
+    "mkdocs-click~=0.8",
+]

viur_cli-3.0.0b2/src/viur_cli/__init__.py

@@ -0,0 +1,6 @@
+# viur-cli v3 — package marker only.
+#
+# Submodules are imported explicitly by `cli.py`'s `main()` entry point.
+# The v2 pattern of `from .X import *` here triggered module-level side
+# effects (conf.py auto-loading project.json, sys.exit on missing files)
+# which is now avoided.

viur_cli-3.0.0b2/src/viur_cli/_docs_cli.py

@@ -0,0 +1,24 @@
+"""Docs-only entry point for mkdocs-click.
+
+mkdocs-click introspects the Click group object at import time. The runtime
+entry point `viur_cli.cli:main` attaches all subcommands by importing each
+submodule explicitly (their `@cli.command`/`@cli.group` decorators bind to
+the root group at import time). Without invoking main(), only the commands
+defined directly in `cli.py` are visible.
+
+This module performs the same side-effect imports so that `from
+viur_cli._docs_cli import cli` returns a fully populated Click group —
+suitable for static introspection by mkdocs-click.
+"""
+from viur_cli import build  # noqa: F401
+from viur_cli import cloud  # noqa: F401
+from viur_cli import deprecated  # noqa: F401
+from viur_cli import local  # noqa: F401
+from viur_cli import package  # noqa: F401
+from viur_cli import setup  # noqa: F401
+from viur_cli import update  # noqa: F401
+from viur_cli.scriptor import script  # noqa: F401
+
+from viur_cli.cli import cli
+
+__all__ = ["cli"]

viur_cli-3.0.0b2/src/viur_cli/build.py

@@ -0,0 +1,152 @@
+"""Build pipeline for ViUR projects: orchestrates npm and exec build steps."""
+
+import click
+import os
+from .conf import config
+from .cli import cli
+from . import utils
+
+
+def _build(conf, name, build_cfg, additional_args):
+    """Run a single build entry from a profile's `builds` section.
+
+    Args:
+        conf: Resolved profile configuration.
+        name: The build entry's key (used only for log output).
+        build_cfg: The build entry itself. Required keys depend on
+            ``kind``:
+
+            * ``kind == "npm"`` — needs ``source`` (relative to
+              ``conf['sources_folder']``) and ``command`` (the npm
+              script name to run).
+            * ``kind == "exec"`` — needs ``command`` (a shell string
+              executed verbatim).
+
+        additional_args: Extra args passed to the build callable.
+            Currently ignored by both kinds — kept for forward
+            compatibility.
+
+    Aborts (via ``echo_fatal``) on an unknown ``kind``.
+    """
+    utils.echo_info(f"""- {build_cfg["kind"]} {name}""")
+    match build_cfg["kind"]:
+        case "npm":
+            utils.system(
+                " && ".join(
+                    (
+                        f'cd {os.path.join(conf["sources_folder"], build_cfg["source"])}',
+                        "npm install",
+                        f'npm run {build_cfg["command"]}'
+                    )
+                )
+            )
+
+        case "exec":
+            utils.system(build_cfg["command"])
+
+        case other:
+            utils.echo_fatal(f"Unknown build kind {other!r}")
+
+
+def _clean(conf, name, build_cfg):
+    """Drop generated artifacts for a single build entry.
+
+    Args:
+        conf: Resolved profile configuration.
+        name: The build entry's key (used only for log output).
+        build_cfg: The build entry. Recognized keys:
+
+            * ``target`` (npm only) — deleted under
+              ``conf['distribution_folder']``
+            * ``source`` (npm only) — its ``node_modules`` is dropped
+            * ``clean`` (any kind) — explicit shell command run after
+              the kind-specific cleanup
+
+    Aborts on unknown ``kind``.
+    """
+    utils.echo_info(f"""- cleaning {build_cfg["kind"]} {name}""")
+
+    match build_cfg["kind"]:
+        # for npm, drop the target folder and node_modules (npm)
+        case "npm":
+            if target_dir := build_cfg.get("target"):
+                target_dir = os.path.join(conf["distribution_folder"], target_dir)
+                utils.echo_info(f"  - dropping {target_dir}")
+                utils.rmdir(target_dir)
+
+            if build_cfg["kind"] == "npm":
+                # todo: Later, call "npm run clean" or a similar command when it exists
+
+                node_modules = os.path.join(conf["sources_folder"], build_cfg["source"], "node_modules")
+                utils.echo_info(f"  - dropping {node_modules}")
+                utils.rmdir(os.path.join(node_modules))
+
+        case "exec":
+            pass
+
+        case other:
+            utils.echo_fatal(f"Unknown build kind {other!r}")
+
+    # Always execute explicit "clean" command if provided
+    if clean_cmd := build_cfg.get("clean"):
+        utils.echo_info(f"  - executing {clean_cmd=}")
+        utils.system(clean_cmd)
+
+
+@cli.group()
+def build():
+    """Build deploy artifacts (npm bundles, exec build steps) for a ViUR project."""
+
+
+@build.command(context_settings={"ignore_unknown_options": True})
+@click.argument("profile", default='default')
+@click.argument("additional_args", nargs=-1)
+def release(profile, additional_args):
+    """Build every entry in the profile's `builds` section, in declaration order."""
+    conf = config.get_profile(profile)
+    utils.echo_info("building started...")
+
+    for build_name, build_cfg in conf.get("builds", {}).items():
+        _build(conf, build_name, build_cfg, additional_args)
+
+    utils.echo_info("building finished!")
+
+
+@build.command(context_settings={"ignore_unknown_options": True})
+@click.argument("appname")
+@click.argument("additional_args", nargs=-1)
+@click.argument("profile", default="default")
+def app(appname, profile, additional_args):
+    """Build a single application from the profile's `builds` section."""
+
+    conf = config.get_profile(profile)
+
+    if not (build_cfg := conf.get("builds").get(appname)):
+        utils.echo_fatal(f"""{appname=} must be one of these options: {", ".join(conf["builds"].keys())}""")
+
+    utils.echo_info("building started...")
+    _build(conf, appname, build_cfg, additional_args)
+    utils.echo_info("building finished!")
+
+
+@build.command
+@click.argument("target", default="")
+@click.argument("profile", default="default")
+def clean(target, profile):
+    """Drop build artifacts for one application (TARGET) or for all builds in the profile."""
+
+    conf = config.get_profile(profile)
+
+    builds = conf.get("builds", {})
+    if target:
+        if not (build_cfg := builds.get(target)):
+            utils.echo_fatal(f"""{target=} must be one of these options: {", ".join(conf["builds"].keys())}""")
+
+        builds = {target: build_cfg}
+
+    utils.echo_info("clean started...")
+
+    for build_name, build_cfg in builds.items():
+        _clean(conf, build_name, build_cfg)
+
+    utils.echo_info("clean finished!")

{viur_cli-3.0.0 → viur_cli-3.0.0b2}/src/viur_cli/cli.py

@@ -15,26 +15,16 @@ from pathlib import Path
 @click.version_option(__version__)
 @click.pass_context
 def cli(ctx):
-    """
-    Command-line interface for managing project configuration and information.
-
-    The viur-cli provides a set of commands to manage your project's configuration in the 'project.json'.
-     It also offers commands to view and modify project information.
-
-    Note:
+    """Manage and operate ViUR projects from a single command line.
 
-        - Use the `--version` option to display the CLI tool's version.
-
-        - Run the 'project' command to manage 'project.json' and project configuration settings.
+    Reads `project.json` for per-profile settings (deploy targets, build
+    pipelines, packaged ViUR frontends). Run `viur project list` to see
+    the resolved configuration of a profile.
     """
-
-    # Get the systems pipenv Version Number
-    uv_version = subprocess.check_output(['uv', 'self', 'version']).decode("utf-8")
-    version_pattern = r'\b(\d+\.\d+\.\d+)\b'
-    match = re.search(version_pattern, uv_version)
+    uv_version = subprocess.check_output(["uv", "self", "version"]).decode("utf-8")
+    match = re.search(r"\b(\d+\.\d+\.\d+)\b", uv_version)
     sys_uv = match.group(1)
 
-    # sys kleiner min
     if semver.compare(sys_uv, MINIMAL_UV) < 0:
         echo_warning(
             f"Your uv Version does not match the recommended uv version. \n"
@@ -48,7 +38,7 @@ def cli(ctx):
 @click.argument("action", type=click.Choice(['list']))
 @click.argument("profile", default="default")
 def project(action, profile):
-    """List your project.json Configuration File"""
+    """Inspect the resolved project.json configuration for a profile."""
     project_config = config.get_profile(profile)
     if action == "list":
         echo_info(f"These are the Settings for {profile} profile")
@@ -59,10 +49,14 @@ def project(action, profile):
 @click.option('--shell', type=click.Choice(['bash', 'zsh', 'fish', 'auto']),
               default='auto', help='Shell type (auto-detect if not specified)')
 def setup_autocomplete(shell):
-    """Install shell autocompletion for the viur CLI.
+    """Install shell tab-completion for the viur CLI.
 
-    This command sets up autocompletion for your shell, making it easier
-    to use the viur CLI by providing tab-completion for commands and options.
+    Generates Click's completion script for the chosen shell and writes it
+    next to the shell's rc file (sourcing it from `~/.bashrc` / `~/.zshrc`,
+    or directly into fish's completions dir).
+
+    Args:
+        shell: ``bash``, ``zsh``, ``fish``, or ``auto`` (detect from $SHELL).
     """
     # Auto-detect shell if not specified
     if shell == 'auto':
@@ -258,3 +252,24 @@ def autocomplete_info():
         echo_warning("No autocompletion installed")
         echo_info("\nTo install, run:")
         echo_info("  viur setup-autocomplete")
+
+
+def main() -> None:
+    """Entry point used by the ``viur`` console script.
+
+    Imports each command module explicitly so its ``@cli.command`` /
+    ``@cli.group`` decorators bind to the root ``cli`` group above. This
+    replaces the v2 pattern that relied on star-imports in
+    ``__init__.py`` to trigger the same decorator side-effects.
+    """
+    # Side-effect imports — decorators run on module load.
+    from viur_cli import build  # noqa: F401
+    from viur_cli import cloud  # noqa: F401
+    from viur_cli import local  # noqa: F401
+    from viur_cli import package  # noqa: F401
+    from viur_cli import setup  # noqa: F401
+    from viur_cli import update  # noqa: F401
+    from viur_cli import deprecated  # noqa: F401
+    from viur_cli.scriptor import script  # noqa: F401
+
+    cli()