splent-cli 1.5.0__tar.gz → 1.6.0__tar.gz

{splent_cli-1.5.0/src/splent_cli.egg-info → splent_cli-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.5.0
+Version: 1.6.0
 Summary: SPLENT-CLI is a CLI to be able to work on your development more easily.
 Author-email: DiversoLab <diversolab@us.es>
 Project-URL: Homepage, https://github.com/diverso-lab/splent_cli
@@ -47,23 +47,10 @@ Command-line tool for managing SPLENT products, features, databases, and environ
 ## Quick start
 
 ```bash
-make setup           # Prepare .env, start Docker, enter CLI container
-splent --help        # See all available commands
+make setup        # Prepare .env, start Docker, enter CLI container
+splent --help     # See all available commands
 ```
 
-## Key commands
-
-| Command | Description |
-|---------|-------------|
-| `product:create` | Create a new product |
-| `product:derive --dev` | Full SPL derivation pipeline |
-| `feature:add` / `feature:attach` | Add features to a product |
-| `feature:status` | Show feature lifecycle states |
-| `feature:release` | Release a feature (tag + PyPI + GitHub) |
-| `db:migrate` / `db:upgrade` | Manage per-feature migrations |
-| `export:puml` | Generate PlantUML diagrams |
-| `doctor` | System health check |
-
 ## Requirements
 
 - Docker + Docker Compose
@@ -71,7 +58,7 @@ splent --help        # See all available commands
 
 ## Documentation
 
-Full documentation at **[docs.splent.io](https://docs.splent.io)**
+Full docs, tutorials, and command reference at **[docs.splent.io](https://docs.splent.io)**
 
 ## License
 

splent_cli-1.6.0/README.md

@@ -0,0 +1,23 @@
+# SPLENT CLI
+
+Command-line tool for managing SPLENT products, features, databases, and environments.
+
+## Quick start
+
+```bash
+make setup        # Prepare .env, start Docker, enter CLI container
+splent --help     # See all available commands
+```
+
+## Requirements
+
+- Docker + Docker Compose
+- Python 3.13+
+
+## Documentation
+
+Full docs, tutorials, and command reference at **[docs.splent.io](https://docs.splent.io)**
+
+## License
+
+Creative Commons CC BY 4.0 - SPLENT - Diverso Lab

{splent_cli-1.5.0 → splent_cli-1.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.5.0"
+version = "1.6.0"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/cli.py

@@ -44,9 +44,13 @@ class SPLENTCLI(click.Group):
             with app.app_context():
                 registry = app.extensions.get("splent_feature_commands", {})
                 for feature_short, commands in registry.items():
+                    cmd_names = ", ".join(c.name for c in commands if c.name)
                     group = click.Group(
                         name=f"feature:{feature_short}",
                         help=f"Commands contributed by splent_feature_{feature_short}.",
+                        short_help=f"Subcommands: {cmd_names}"
+                        if cmd_names
+                        else f"Commands from splent_feature_{feature_short}.",
                     )
                     group.requires_app = True  # type: ignore[attr-defined]
                     for cmd in commands:
@@ -92,12 +96,12 @@ class SPLENTCLI(click.Group):
     def format_commands(self, ctx, formatter):
         """Group SPLENT commands by category in the CLI help output."""
         all_cmds = self.list_commands(ctx)
+        feat_cmds = self._load_feature_commands()
         groups = {
             "🌿 Feature Management": [
                 cmd
                 for cmd in all_cmds
-                if cmd.startswith("feature:")
-                and cmd not in self._load_feature_commands()
+                if cmd.startswith("feature:") and cmd not in feat_cmds
             ],
             "🏗️ Product Management": [
                 cmd for cmd in all_cmds if cmd.startswith("product:")
@@ -107,27 +111,28 @@ class SPLENTCLI(click.Group):
             ],
             "🧱 Database": [cmd for cmd in all_cmds if cmd.startswith("db:")],
             "💾 Cache": [cmd for cmd in all_cmds if cmd.startswith("cache:")],
+            "🔍 Checks": [cmd for cmd in all_cmds if cmd.startswith("check:")],
+            "📦 Export": [cmd for cmd in all_cmds if cmd.startswith("export:")],
+            "🚀 Release": [cmd for cmd in all_cmds if cmd.startswith("release:")],
             "🧰 Utilities": [
                 cmd
                 for cmd in all_cmds
-                if cmd.startswith(
-                    ("clear:", "env", "select", "info", "version", "doctor", "tokens")
-                )
+                if cmd.startswith(("clear:", "command:", "env:", "env"))
+                or cmd in ("doctor", "tokens:setup", "version")
             ],
             "🐍 Development & QA": [
                 cmd
                 for cmd in all_cmds
-                if cmd.startswith(("linter", "test", "coverage", "locust"))
-            ],
-            "🔌 Feature Commands": [
-                cmd for cmd in all_cmds if cmd in self._load_feature_commands()
+                if cmd in ("lint", "coverage", "selenium", "locust", "locust:stop")
             ],
+            "🔌 Feature Commands": [cmd for cmd in all_cmds if cmd in feat_cmds],
         }
+        total = 0
         for title, cmds in groups.items():
             if not cmds:
                 continue
 
-            with formatter.section(title):
+            with formatter.section(f"{title} ({len(cmds)})"):
                 rows = []
                 for cmd_name in sorted(cmds):
                     cmd = self.get_command(ctx, cmd_name)
@@ -136,6 +141,9 @@ class SPLENTCLI(click.Group):
                     rows.append((cmd_name, cmd.get_short_help_str()))
                 if rows:
                     formatter.write_dl(rows)
+            total += len(cmds)
+
+        formatter.write(f"\n  {total} commands available.\n")
 
 
 @click.group(cls=SPLENTCLI)

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/cache/cache_clear.py

@@ -4,7 +4,10 @@ import click
 from pathlib import Path
 
 
-@click.command("cache:clear", short_help="Clear the feature cache (total or partial).")
+@click.command(
+    "cache:clear",
+    short_help="Clear the feature version cache (.splent_cache), totally or partially.",
+)
 @click.option(
     "--namespace",
     default=None,

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/cache/cache_outdated.py

@@ -68,7 +68,7 @@ def _get_product_features(workspace: Path) -> dict:
 
 @click.command(
     "cache:outdated",
-    short_help="Show products using older versions than what's in cache.",
+    short_help="Show products using older feature versions than what is in cache.",
 )
 def cache_outdated():
     """

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/check/check_github.py

@@ -18,13 +18,17 @@ def check_github():
     # --- presence checks ---
     if not user:
         click.echo(click.style("[✖] ", fg="red") + "GITHUB_USER not set in .env")
-        click.secho("   Run 'splent tokens' for setup instructions.", fg="bright_black")
+        click.secho(
+            "   Run 'splent tokens:setup' for setup instructions.", fg="bright_black"
+        )
         raise SystemExit(1)
     click.echo(click.style("[✔] ", fg="green") + f"GITHUB_USER = {user}")
 
     if not token:
         click.echo(click.style("[✖] ", fg="red") + "GITHUB_TOKEN not set in .env")
-        click.secho("   Run 'splent tokens' for setup instructions.", fg="bright_black")
+        click.secho(
+            "   Run 'splent tokens:setup' for setup instructions.", fg="bright_black"
+        )
         raise SystemExit(1)
 
     masked = token[:4] + "*" * (len(token) - 8) + token[-4:]
@@ -54,7 +58,7 @@ def check_github():
                 + "Token invalid or expired (401 Unauthorized)"
             )
             click.secho(
-                "   Run 'splent tokens' for instructions on obtaining a valid token.",
+                "   Run 'splent tokens:setup' for instructions on obtaining a valid token.",
                 fg="bright_black",
             )
         elif e.code == 403:
@@ -63,7 +67,7 @@ def check_github():
                 + "Token lacks required permissions (403 Forbidden)"
             )
             click.secho(
-                "   Run 'splent tokens' — ensure the token has 'repo' scope.",
+                "   Run 'splent tokens:setup' — ensure the token has 'repo' scope.",
                 fg="bright_black",
             )
         else:

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/check/check_infra.py

@@ -220,6 +220,116 @@ def check_infra():
     else:
         _ok("No external networks required")
 
+    # --- Check 4: Dockerfile build contexts ---
+    click.echo()
+    click.echo(click.style("  Build contexts", bold=True))
+    build_count = 0
+    for label, cf in compose_files:
+        docker_dir = os.path.dirname(cf)
+        result = subprocess.run(
+            ["docker", "compose", "-f", cf, "config", "--format", "json"],
+            capture_output=True,
+            text=True,
+        )
+        if result.returncode != 0:
+            continue
+        try:
+            config = json.loads(result.stdout)
+        except json.JSONDecodeError:
+            continue
+        for svc_name, svc_def in config.get("services", {}).items():
+            build_cfg = svc_def.get("build")
+            if not build_cfg:
+                continue
+            build_count += 1
+            if isinstance(build_cfg, dict):
+                ctx = build_cfg.get("context", ".")
+                dockerfile = build_cfg.get("dockerfile", "Dockerfile")
+                df_path = (
+                    os.path.join(ctx, dockerfile)
+                    if os.path.isabs(ctx)
+                    else os.path.join(docker_dir, ctx, dockerfile)
+                )
+            else:
+                df_path = os.path.join(docker_dir, build_cfg, "Dockerfile")
+
+            if os.path.isfile(df_path):
+                _ok(f"{label}/{svc_name}: Dockerfile found")
+            else:
+                _fail(f"{label}/{svc_name}: Dockerfile not found at {df_path}")
+
+    if build_count == 0:
+        _ok("No custom builds (all services use pre-built images)")
+
+    # --- Check 5: Healthcheck coverage ---
+    click.echo()
+    click.echo(click.style("  Health checks", bold=True))
+    services_with_hc: set[str] = set()
+    services_depended_on: dict[str, str] = {}  # depended_svc -> by_svc
+
+    for label, cf in compose_files:
+        result = subprocess.run(
+            ["docker", "compose", "-f", cf, "config", "--format", "json"],
+            capture_output=True,
+            text=True,
+        )
+        if result.returncode != 0:
+            continue
+        try:
+            config = json.loads(result.stdout)
+        except json.JSONDecodeError:
+            continue
+        for svc_name, svc_def in config.get("services", {}).items():
+            if "healthcheck" in svc_def:
+                services_with_hc.add(svc_name)
+            for dep_svc, dep_cfg in (svc_def.get("depends_on") or {}).items():
+                if (
+                    isinstance(dep_cfg, dict)
+                    and dep_cfg.get("condition") == "service_healthy"
+                ):
+                    services_depended_on[dep_svc] = svc_name
+
+    missing_hc = {
+        svc: by
+        for svc, by in services_depended_on.items()
+        if svc not in services_with_hc
+    }
+    if missing_hc:
+        for svc, by in sorted(missing_hc.items()):
+            _fail(
+                f"'{by}' depends on '{svc}' being healthy, but '{svc}' has no healthcheck"
+            )
+    elif services_with_hc:
+        _ok(f"{len(services_with_hc)} service(s) with health checks")
+    else:
+        _ok("No health checks declared (none required)")
+
+    # --- Check 6: Volume name conflicts ---
+    click.echo()
+    click.echo(click.style("  Volumes", bold=True))
+    all_volumes: dict[str, list[str]] = {}  # vol_name -> [labels]
+    for label, cf in compose_files:
+        result = subprocess.run(
+            ["docker", "compose", "-f", cf, "config", "--format", "json"],
+            capture_output=True,
+            text=True,
+        )
+        if result.returncode != 0:
+            continue
+        try:
+            config = json.loads(result.stdout)
+        except json.JSONDecodeError:
+            continue
+        for vol_name in config.get("volumes", {}):
+            all_volumes.setdefault(vol_name, []).append(label)
+
+    vol_conflicts = {v: srcs for v, srcs in all_volumes.items() if len(srcs) > 1}
+    if vol_conflicts:
+        for vol, sources in sorted(vol_conflicts.items()):
+            _warn(f"Volume '{vol}' declared by multiple features: {', '.join(sources)}")
+    else:
+        _ok(f"No volume name conflicts ({len(all_volumes)} volumes)")
+
     # --- Summary ---
     click.echo()
     if fail:

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/check/check_product.py

@@ -291,7 +291,7 @@ def _check_blueprints(counters):
 
 @click.command(
     "check:product",
-    short_help="Validate product health: env vars, symlinks, config.",
+    short_help="Quick health check: env vars, symlinks, and config files.",
 )
 @context.requires_product
 def check_product():

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/check/check_pypi.py

@@ -26,7 +26,9 @@ def check_pypi(test: bool):
     # --- presence checks ---
     if not username:
         click.echo(click.style("[✖] ", fg="red") + "TWINE_USERNAME not set in .env")
-        click.secho("   Run 'splent tokens' for setup instructions.", fg="bright_black")
+        click.secho(
+            "   Run 'splent tokens:setup' for setup instructions.", fg="bright_black"
+        )
         raise SystemExit(1)
     click.echo(click.style("[✔] ", fg="green") + f"TWINE_USERNAME = {username}")
 
@@ -35,7 +37,9 @@ def check_pypi(test: bool):
             click.style("[✖] ", fg="red")
             + "TWINE_PASSWORD (or PYPI_PASSWORD) not set in .env"
         )
-        click.secho("   Run 'splent tokens' for setup instructions.", fg="bright_black")
+        click.secho(
+            "   Run 'splent tokens:setup' for setup instructions.", fg="bright_black"
+        )
         raise SystemExit(1)
 
     masked = (
@@ -94,7 +98,7 @@ def check_pypi(test: bool):
                 + f"Credentials rejected by {registry} (HTTP {e.code}) — token invalid or expired"
             )
             click.secho(
-                "   Run 'splent tokens' for instructions on obtaining a valid token.",
+                "   Run 'splent tokens:setup' for instructions on obtaining a valid token.",
                 fg="bright_black",
             )
             raise SystemExit(1)

splent_cli-1.5.0/src/splent_cli/commands/clear_cache.py → splent_cli-1.6.0/src/splent_cli/commands/clear/clear_build.py

@@ -52,8 +52,8 @@ def clean_build_artifacts(target_path: str | Path, *, quiet: bool = False):
 
 
 @click.command(
-    "clear:pycache",
-    short_help="Clear __pycache__, .pytest_cache and build artifacts from the workspace.",
+    "clear:build",
+    short_help="Remove __pycache__, .pytest_cache, dist/, build/, and egg-info.",
 )
 def clear_cache():
     if not click.confirm("Are you sure you want to clear caches and build artifacts?"):

{splent_cli-1.5.0/src/splent_cli/commands → splent_cli-1.6.0/src/splent_cli/commands/clear}/clear_log.py

@@ -5,7 +5,7 @@ from splent_cli.utils.path_utils import PathUtils
 from splent_cli.services import context
 
 
-@click.command("clear:log", short_help="Clears the 'app.log' file.")
+@click.command("clear:log", short_help="Clear the app.log file.")
 @context.requires_product
 def clear_log():
     log_file_path = PathUtils.get_app_log_dir()

{splent_cli-1.5.0/src/splent_cli/commands → splent_cli-1.6.0/src/splent_cli/commands/clear}/clear_uploads.py

@@ -8,7 +8,7 @@ from splent_cli.services import context
 
 @click.command(
     "clear:uploads",
-    short_help="Clears the contents of the 'uploads' directory without removing the folder.",
+    short_help="Clear the contents of the uploads directory.",
 )
 @context.requires_product
 def clear_uploads():

{splent_cli-1.5.0/src/splent_cli/commands → splent_cli-1.6.0/src/splent_cli/commands/command}/command_create.py

@@ -5,7 +5,7 @@ import click
 from splent_cli.utils.path_utils import PathUtils
 
 
-@click.command("command:create", help="Creates a new CLI command skeleton.")
+@click.command("command:create", short_help="Create a new CLI command skeleton.")
 @click.argument("name")
 def command_create(name):
     commands_dir = PathUtils.get_commands_path()

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/coverage.py

@@ -8,7 +8,7 @@ from splent_cli.services import context
 
 @click.command(
     "coverage",
-    short_help="Runs pytest coverage on the selected feature",
+    short_help="Run pytest with coverage reporting for a feature.",
 )
 @click.argument("module_name", required=False)
 @click.option("--html", is_flag=True, help="Generates an HTML coverage report.")

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/database/db_console.py

@@ -7,7 +7,7 @@ from splent_cli.services import context
 
 
 @click.command(
-    "db:console", short_help="Opens a MariaDB console with credentials from .env."
+    "db:console", short_help="Open a MariaDB console with credentials from .env."
 )
 @context.requires_product
 def db_console():

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/database/db_dump.py

@@ -9,7 +9,7 @@ from splent_cli.services import context
 
 @click.command(
     "db:dump",
-    short_help="Creates a dump of the MariaDB database with credentials from .env.",
+    short_help="Create a SQL dump of the MariaDB database.",
 )
 @click.argument("filename", required=False)
 @context.requires_product

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/database/db_migrate.py

@@ -1,13 +1,11 @@
 import os
 
 import click
-from flask import current_app
-from flask_migrate import migrate as alembic_migrate, upgrade as alembic_upgrade
+from flask_migrate import migrate as alembic_migrate
 
 from splent_cli.utils.decorators import requires_db
 from splent_cli.services import context
 from splent_cli.utils.lifecycle import (
-    advance_state,
     resolve_feature_key_from_entry,
     require_editable,
 )
@@ -50,19 +48,20 @@ def _is_empty_migration(path: str) -> bool:
 @requires_db
 @click.command(
     "db:migrate",
-    short_help="Generate and apply migrations (all features or a single one).",
+    short_help="Generate a new migration from model changes and apply it.",
 )
 @click.argument("feature", required=False, default=None)
+@click.option(
+    "-m", "message", default=None, help="Migration message (defaults to feature name)."
+)
 @context.requires_product
-def db_migrate(feature):
+def db_migrate(feature, message):
     """
     Generate new migration files for features that have schema changes,
     then apply all pending migrations.
 
     Empty migrations (no schema changes detected) are automatically removed.
     """
-    app = current_app
-
     if feature:
         dirs = {}
         mdir = MigrationManager.get_feature_migration_dir(feature)
@@ -84,7 +83,6 @@ def db_migrate(feature):
 
     # Build entry→key lookup for manifest updates
     product_path = PathUtils.get_app_base_dir()
-    product_name = os.getenv("SPLENT_APP", "")
     entry_lookup = {}
     for entry in get_features_from_pyproject() or []:
         key, ns, name, version = resolve_feature_key_from_entry(entry)
@@ -110,7 +108,7 @@ def db_migrate(feature):
         alembic_logger.setLevel(logging.WARNING)
 
         try:
-            alembic_migrate(directory=mdir, message=feat)
+            alembic_migrate(directory=mdir, message=message or feat)
         except Exception as e:
             if os.getenv("SPLENT_DEBUG"):
                 click.secho(
@@ -142,30 +140,5 @@ def db_migrate(feature):
         else:
             click.echo(click.style(f"  ✔ {feat}: up to date", fg="green"))
 
-        # Apply pending migrations
-        try:
-            alembic_upgrade(directory=mdir)
-            revision = MigrationManager.get_current_feature_revision(
-                feat, app.extensions["migrate"].db.engine
-            )
-            MigrationManager.update_feature_status(app, feat, revision)
-            click.echo(click.style(f"  ✅ {feat} → {revision or 'head'}", fg="green"))
-
-            # Advance lifecycle state to "migrated"
-            info = entry_lookup.get(feat)
-            if info:
-                key, ns, name, version = info
-                advance_state(
-                    product_path,
-                    product_name,
-                    key,
-                    to="migrated",
-                    namespace=ns,
-                    name=name,
-                    version=version,
-                )
-        except Exception as e:
-            click.echo(click.style(f"  ❌ {feat}: {e}", fg="red"))
-
 
 cli_command = db_migrate

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/database/db_reset.py

@@ -15,7 +15,7 @@ from splent_framework.managers.migration_manager import (
 )
 from splent_framework.utils.feature_utils import get_features_from_pyproject
 from splent_framework.utils.path_utils import PathUtils
-from splent_cli.commands.clear_uploads import clear_uploads
+from splent_cli.commands.clear.clear_uploads import clear_uploads
 
 
 @requires_db

{splent_cli-1.5.0 → splent_cli-1.6.0}/src/splent_cli/commands/database/db_rollback.py

@@ -206,7 +206,28 @@ def db_rollback(feature, steps, cascade):
                 )
                 break
     except Exception as e:
-        click.secho(f"  ❌ {feature}: {e}", fg="red")
+        click.secho(f"  {feature}: {e}", fg="red")
+        raise SystemExit(1)
+
+    # Offer to delete migration files if fully rolled back to base
+    if revision is None:
+        versions_dir = os.path.join(mdir, "versions")
+        if os.path.isdir(versions_dir):
+            migration_files = [
+                f
+                for f in os.listdir(versions_dir)
+                if f.endswith(".py") and not f.startswith("__")
+            ]
+            if migration_files and click.confirm(
+                f"  Delete {len(migration_files)} migration file(s)?",
+                default=False,
+            ):
+                for f in migration_files:
+                    os.remove(os.path.join(versions_dir, f))
+                click.echo(
+                    click.style("  deleted: ", dim=True)
+                    + f"{len(migration_files)} file(s)"
+                )
 
 
 cli_command = db_rollback