splent-cli 1.1.1__tar.gz → 1.2.6__tar.gz

{splent_cli-1.1.1/src/splent_cli.egg-info → splent_cli-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splent_cli
-Version: 1.1.1
+Version: 1.2.6
 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
@@ -9,6 +9,7 @@ Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: click==8.1.8
+Requires-Dist: packaging>=24.0
 Provides-Extra: dev
 Requires-Dist: setuptools==80.3.1; extra == "dev"
 Requires-Dist: pytest==8.3.4; extra == "dev"
@@ -38,4 +39,39 @@ Requires-Dist: tomli_w==1.2.0; extra == "dev"
 Requires-Dist: PyYAML==6.0.3; extra == "dev"
 Dynamic: license-file
 
-# splent_cli
+# 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
+```
+
+## 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
+- Python 3.13+
+
+## Documentation
+
+Full documentation at **[docs.splent.io](https://docs.splent.io)**
+
+## License
+
+Creative Commons CC BY 4.0 - SPLENT - Diverso Lab

splent_cli-1.2.6/README.md

@@ -0,0 +1,36 @@
+# 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
+```
+
+## 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
+- Python 3.13+
+
+## Documentation
+
+Full documentation at **[docs.splent.io](https://docs.splent.io)**
+
+## License
+
+Creative Commons CC BY 4.0 - SPLENT - Diverso Lab

{splent_cli-1.1.1 → splent_cli-1.2.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splent_cli"
-version = "1.1.1"
+version = "1.2.6"
 description = "SPLENT-CLI is a CLI to be able to work on your development more easily."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -13,6 +13,7 @@ license-files = ["LICENSE"]
 
 dependencies = [
     "click==8.1.8",
+    "packaging>=24.0",
 ]
 
 [project.optional-dependencies]
@@ -54,6 +55,10 @@ package-dir = { "" = "src" }
 [tool.setuptools.packages.find]
 where = ["src"]
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
 [tool.black]
 line-length = 79
 

{splent_cli-1.1.1 → splent_cli-1.2.6}/src/splent_cli/cli.py

@@ -3,6 +3,7 @@ from dotenv import load_dotenv
 
 from splent_cli.utils.dynamic_imports import get_app
 from splent_cli.utils.command_loader import load_commands
+from splent_cli.utils.db_utils import check_db_connection
 
 load_dotenv()
 
@@ -12,6 +13,7 @@ class SPLENTCLI(click.Group):
     Main SPLENT CLI class.
 
     - Automatically injects the Flask app context for commands marked with `requires_app = True`.
+    - Checks DB connectivity for commands marked with `requires_db = True`.
     - Displays commands grouped by category for a cleaner, more readable help output.
     """
 
@@ -21,6 +23,9 @@ class SPLENTCLI(click.Group):
 
         if command and getattr(command, "requires_app", False):
             app = get_app()
+            if getattr(command, "requires_db", False):
+                if not check_db_connection(app):
+                    raise SystemExit(1)
             with app.app_context():
                 return super().invoke(ctx)
 
@@ -39,11 +44,12 @@ class SPLENTCLI(click.Group):
                 cmd for cmd in self.commands if cmd.startswith("uvl:")
             ],
             "🧱 Database": [cmd for cmd in self.commands if cmd.startswith("db:")],
+            "💾 Cache": [cmd for cmd in self.commands if cmd.startswith("cache:")],
             "🧰 Utilities": [
                 cmd
                 for cmd in self.commands
                 if cmd.startswith(
-                    ("clear:", "env", "select", "info", "version", "doctor")
+                    ("clear:", "env", "select", "info", "version", "doctor", "tokens")
                 )
             ],
             "🐍 Development & QA": [
@@ -51,9 +57,6 @@ class SPLENTCLI(click.Group):
                 for cmd in self.commands
                 if cmd.startswith(("linter", "test", "coverage", "locust"))
             ],
-            "⚙️ Build & Assets": [
-                cmd for cmd in self.commands if cmd.startswith("webpack:")
-            ],
         }
         for title, cmds in groups.items():
             cmds = [c for c in cmds if c in self.commands]

splent_cli-1.2.6/src/splent_cli/commands/cache/cache_clear.py

@@ -0,0 +1,85 @@
+from splent_cli.services import context, compose
+import shutil
+import click
+from pathlib import Path
+
+
+@click.command("cache:clear", short_help="Clear the feature cache (total or partial).")
+@click.option(
+    "--namespace",
+    default=None,
+    help="Clear only a specific namespace (e.g. splent_io).",
+)
+@click.option(
+    "--feature",
+    default=None,
+    help="Clear all entries for a specific feature (e.g. splent_feature_auth).",
+)
+@click.option("--yes", is_flag=True, help="Skip confirmation prompt.")
+def cache_clear(namespace, feature, yes):
+    """
+    Deletes entries from the feature cache and removes broken symlinks in products.
+
+    \b
+    Scope (most to least specific):
+      --feature splent_feature_auth   → removes all cache entries for that feature
+      --namespace splent_io           → removes the entire namespace folder
+      (no options)                    → clears the entire feature cache
+    """
+    workspace = context.workspace()
+    cache_root = workspace / ".splent_cache" / "features"
+
+    if not cache_root.exists():
+        click.secho("⚠️  No .splent_cache/features directory found.", fg="yellow")
+        raise SystemExit(0)
+
+    # Resolve targets
+    if feature:
+        targets = []
+        search_in = [cache_root / namespace] if namespace else cache_root.iterdir()
+        for ns_dir in search_in if namespace else cache_root.iterdir():
+            ns_dir = Path(ns_dir)
+            if not ns_dir.is_dir():
+                continue
+            for feat_dir in ns_dir.iterdir():
+                base = feat_dir.name.split("@")[0]
+                if base == feature:
+                    targets.append(feat_dir)
+        if not targets:
+            label = f"'{feature}'" + (
+                f" in namespace '{namespace}'" if namespace else ""
+            )
+            click.secho(f"⚠️  No cache entries found for {label}.", fg="yellow")
+            raise SystemExit(0)
+        description = f"{len(targets)} entry/entries for feature '{feature}'"
+    elif namespace:
+        targets = [cache_root / namespace]
+        if not targets[0].exists():
+            click.secho(f"⚠️  Namespace '{namespace}' not found in cache.", fg="yellow")
+            raise SystemExit(0)
+        description = f"namespace '{namespace}'"
+    else:
+        targets = [cache_root]
+        description = "entire feature cache"
+
+    if not yes and not click.confirm(
+        f"⚠️  This will permanently delete the {description}. Continue?"
+    ):
+        click.echo("❎ Cancelled.")
+        raise SystemExit(0)
+
+    # Delete
+    for t in targets:
+        shutil.rmtree(t)
+    cache_root.mkdir(parents=True, exist_ok=True)
+    click.secho(f"🧹 Cleared: {description}.", fg="green")
+
+    # Clean broken symlinks
+    removed = compose.remove_broken_symlinks(workspace)
+    if removed:
+        click.secho(f"🔗 Removed {removed} broken feature symlink(s).", fg="yellow")
+    else:
+        click.secho("✅ No broken symlinks found.", fg="green")
+
+
+cli_command = cache_clear

splent_cli-1.2.6/src/splent_cli/commands/cache/cache_orphans.py

@@ -0,0 +1,97 @@
+from splent_cli.services import context
+import click
+from pathlib import Path
+
+
+def _get_cache_entries(cache_root: Path) -> list:
+    """Returns list of {namespace, name, version, is_versioned} dicts."""
+    entries = []
+    if not cache_root.exists():
+        return entries
+    for ns_dir in sorted(cache_root.iterdir()):
+        if not ns_dir.is_dir():
+            continue
+        for feat_dir in sorted(ns_dir.iterdir()):
+            if not feat_dir.is_dir():
+                continue
+            feat = feat_dir.name
+            if "@" in feat:
+                name, version = feat.split("@", 1)
+                entries.append(
+                    {
+                        "namespace": ns_dir.name,
+                        "name": name,
+                        "version": version,
+                        "is_versioned": True,
+                    }
+                )
+            else:
+                entries.append(
+                    {
+                        "namespace": ns_dir.name,
+                        "name": feat,
+                        "version": None,
+                        "is_versioned": False,
+                    }
+                )
+    return entries
+
+
+def _get_all_product_refs(workspace: Path) -> set:
+    """Returns set of 'name' and 'name@version' (no namespace) from all products' pyproject.toml."""
+    import tomllib
+    refs = set()
+    for product_dir in sorted(workspace.iterdir()):
+        if not product_dir.is_dir() or product_dir.name.startswith("."):
+            continue
+        pyproject = product_dir / "pyproject.toml"
+        if not pyproject.exists():
+            continue
+        try:
+            with open(pyproject, "rb") as f:
+                data = tomllib.load(f)
+            splent = data.get("tool", {}).get("splent", {})
+            feats = list(splent.get("features", []))
+            feats += list(splent.get("features_dev", []))
+            feats += list(splent.get("features_prod", []))
+            for entry in feats:
+                ref = entry.split("/", 1)[1] if "/" in entry else entry
+                refs.add(ref)
+        except Exception:
+            continue
+    return refs
+
+
+@click.command(
+    "cache:orphans", short_help="Show cached features not referenced by any product."
+)
+def cache_orphans():
+    """Lists features in the cache that no product references in its pyproject.toml."""
+    workspace = context.workspace()
+    cache_root = workspace / ".splent_cache" / "features"
+
+    entries = _get_cache_entries(cache_root)
+    if not entries:
+        click.secho("ℹ️  Feature cache is empty.", fg="yellow")
+        return
+
+    refs = _get_all_product_refs(workspace)
+
+    orphans = []
+    for e in entries:
+        # Match against just name[@version] — pyproject doesn't include namespace
+        ref_key = f"{e['name']}@{e['version']}" if e["is_versioned"] else e["name"]
+        if ref_key not in refs:
+            display_key = f"{e['namespace']}/{ref_key}"
+            orphans.append(display_key)
+
+    if not orphans:
+        click.secho("✅ No orphaned features in cache.", fg="green")
+        return
+
+    click.secho(f"🗑  Orphaned cache entries ({len(orphans)}):", fg="yellow")
+    for o in orphans:
+        click.echo(f"  - {o}")
+
+
+cli_command = cache_orphans

splent_cli-1.2.6/src/splent_cli/commands/cache/cache_outdated.py

@@ -0,0 +1,127 @@
+from splent_cli.services import context
+import re
+import click
+from pathlib import Path
+from collections import defaultdict
+from packaging.version import Version, InvalidVersion
+
+
+def _get_cache_versions(cache_root: Path) -> dict:
+    """Returns {name: [version, ...]} with all versioned snapshots in cache."""
+    versions = defaultdict(list)
+    if not cache_root.exists():
+        return versions
+    for ns_dir in cache_root.iterdir():
+        if not ns_dir.is_dir():
+            continue
+        for feat_dir in ns_dir.iterdir():
+            if not feat_dir.is_dir() or "@" not in feat_dir.name:
+                continue
+            name, version = feat_dir.name.split("@", 1)
+            versions[name].append(version)
+    return versions
+
+
+def _latest(versions: list) -> str:
+    """Returns the latest version string, using semver if possible."""
+
+    def sort_key(v):
+        try:
+            return Version(v.lstrip("v"))
+        except InvalidVersion:
+            return Version("0")
+
+    return max(versions, key=sort_key)
+
+
+def _get_product_features(workspace: Path) -> dict:
+    """Returns {product_name: {feature_name: version_or_None}}."""
+    products = {}
+    for product_dir in sorted(workspace.iterdir()):
+        if not product_dir.is_dir() or product_dir.name.startswith("."):
+            continue
+        pyproject = product_dir / "pyproject.toml"
+        if not pyproject.exists():
+            continue
+        content = pyproject.read_text()
+        m = re.search(
+            r"\[project\.optional-dependencies\].*?features\s*=\s*\[(.*?)\]",
+            content,
+            re.DOTALL,
+        )
+        if not m:
+            continue
+        features = {}
+        for raw in re.findall(r'"([^"]+)"|\'([^\']+)\'', m.group(1)):
+            ref = raw[0] or raw[1]
+            if "/" in ref:
+                ref = ref.split("/", 1)[1]
+            if "@" in ref:
+                name, version = ref.split("@", 1)
+                features[name] = version
+            else:
+                features[ref] = None
+        if features:
+            products[product_dir.name] = features
+    return products
+
+
+@click.command(
+    "cache:outdated",
+    short_help="Show products using older versions than what's in cache.",
+)
+def cache_outdated():
+    """
+    Compares the version each product uses against all versions available in cache.
+    Reports features where a newer version exists locally.
+    """
+    workspace = context.workspace()
+    cache_root = workspace / ".splent_cache" / "features"
+
+    cache_versions = _get_cache_versions(cache_root)
+    if not cache_versions:
+        click.secho("ℹ️  No versioned snapshots in cache.", fg="yellow")
+        return
+
+    products = _get_product_features(workspace)
+    if not products:
+        click.secho("ℹ️  No products with declared features found.", fg="yellow")
+        return
+
+    outdated = []
+    for product, features in sorted(products.items()):
+        for name, current_ver in features.items():
+            available = cache_versions.get(name)
+            if not available:
+                continue
+            if current_ver is None:
+                # Editable — show available versions as informational
+                outdated.append(
+                    (product, name, "(editable)", _latest(available), available)
+                )
+                continue
+            latest = _latest(available)
+            try:
+                is_old = Version(latest.lstrip("v")) > Version(current_ver.lstrip("v"))
+            except InvalidVersion:
+                is_old = latest != current_ver
+            if is_old:
+                outdated.append((product, name, current_ver, latest, available))
+
+    if not outdated:
+        click.secho("✅ All products are on the latest cached version.", fg="green")
+        return
+
+    click.secho(f"Outdated features ({len(outdated)}):\n", fg="yellow")
+    for product, name, current, latest, available in outdated:
+        click.echo(
+            f"  {click.style(product, bold=True)}  {name}  "
+            f"{click.style(current, fg='red')} → {click.style(latest, fg='green')}"
+        )
+        others = sorted(set(available) - {latest})
+        if others:
+            click.echo(f"    also cached: {', '.join(others)}")
+    click.echo()
+
+
+cli_command = cache_outdated

splent_cli-1.2.6/src/splent_cli/commands/cache/cache_prune.py

@@ -0,0 +1,123 @@
+from splent_cli.services import context, compose
+import re
+import shutil
+import click
+from pathlib import Path
+
+
+def _get_cache_entries(cache_root: Path) -> list:
+    entries = []
+    if not cache_root.exists():
+        return entries
+    for ns_dir in sorted(cache_root.iterdir()):
+        if not ns_dir.is_dir():
+            continue
+        for feat_dir in sorted(ns_dir.iterdir()):
+            if not feat_dir.is_dir():
+                continue
+            feat = feat_dir.name
+            if "@" in feat:
+                name, version = feat.split("@", 1)
+                entries.append(
+                    {
+                        "namespace": ns_dir.name,
+                        "name": name,
+                        "version": version,
+                        "is_versioned": True,
+                        "path": feat_dir,
+                    }
+                )
+            else:
+                entries.append(
+                    {
+                        "namespace": ns_dir.name,
+                        "name": feat,
+                        "version": None,
+                        "is_versioned": False,
+                        "path": feat_dir,
+                    }
+                )
+    return entries
+
+
+def _get_all_product_refs(workspace: Path) -> set:
+    refs = set()
+    for product_dir in sorted(workspace.iterdir()):
+        if not product_dir.is_dir() or product_dir.name.startswith("."):
+            continue
+        pyproject = product_dir / "pyproject.toml"
+        if not pyproject.exists():
+            continue
+        content = pyproject.read_text()
+        m = re.search(
+            r"\[project\.optional-dependencies\].*?features\s*=\s*\[(.*?)\]",
+            content,
+            re.DOTALL,
+        )
+        if not m:
+            continue
+        for raw in re.findall(r'"([^"]+)"|\'([^\']+)\'', m.group(1)):
+            ref = raw[0] or raw[1]
+            if "/" in ref:
+                ref = ref.split("/", 1)[1]
+            refs.add(ref)
+    return refs
+
+
+@click.command(
+    "cache:prune", short_help="Remove orphaned cache entries not used by any product."
+)
+@click.option("--yes", is_flag=True, help="Skip confirmation prompt.")
+def cache_prune(yes):
+    """
+    Removes cache entries that no product references in its pyproject.toml,
+    then cleans up broken symlinks in products.
+    """
+    workspace = context.workspace()
+    cache_root = workspace / ".splent_cache" / "features"
+
+    entries = _get_cache_entries(cache_root)
+    if not entries:
+        click.secho("ℹ️  Feature cache is empty.", fg="yellow")
+        return
+
+    refs = _get_all_product_refs(workspace)
+
+    orphans = [
+        e
+        for e in entries
+        if (f"{e['name']}@{e['version']}" if e["is_versioned"] else e["name"])
+        not in refs
+    ]
+
+    if not orphans:
+        click.secho("✅ Nothing to prune — no orphaned entries.", fg="green")
+        return
+
+    click.secho(f"Orphaned entries to remove ({len(orphans)}):", fg="yellow")
+    for e in orphans:
+        label = (
+            f"{e['name']}@{e['version']}"
+            if e["is_versioned"]
+            else f"{e['name']}  (editable)"
+        )
+        click.echo(f"  - {e['namespace']}/{label}")
+
+    click.echo()
+    if not yes and not click.confirm("Remove all of the above?"):
+        click.echo("❎ Cancelled.")
+        raise SystemExit(0)
+
+    for e in orphans:
+        shutil.rmtree(e["path"])
+
+    click.secho(f"🧹 Pruned {len(orphans)} orphaned cache entry/entries.", fg="green")
+
+    removed = compose.remove_broken_symlinks(workspace)
+    if removed:
+        click.secho(f"🔗 Removed {removed} broken feature symlink(s).", fg="yellow")
+    else:
+        click.secho("✅ No broken symlinks found.", fg="green")
+
+
+cli_command = cache_prune

splent_cli-1.2.6/src/splent_cli/commands/cache/cache_size.py

@@ -0,0 +1,57 @@
+from splent_cli.services import context
+import click
+from pathlib import Path
+
+
+def _dir_size(path: Path) -> int:
+    return sum(f.stat().st_size for f in path.rglob("*") if f.is_file())
+
+
+def _human(size: int) -> str:
+    for unit in ("B", "KB", "MB", "GB"):
+        if size < 1024:
+            return f"{size:.1f} {unit}"
+        size /= 1024
+    return f"{size:.1f} TB"
+
+
+@click.command("cache:size", short_help="Show disk usage of the feature cache.")
+def cache_size():
+    """Shows disk usage per namespace and feature entry in the cache."""
+    workspace = context.workspace()
+    cache_root = workspace / ".splent_cache" / "features"
+
+    if not cache_root.exists():
+        click.secho("ℹ️  Feature cache is empty.", fg="yellow")
+        return
+
+    total = 0
+    namespaces = sorted(d for d in cache_root.iterdir() if d.is_dir())
+
+    if not namespaces:
+        click.secho("ℹ️  Feature cache is empty.", fg="yellow")
+        return
+
+    for ns_dir in namespaces:
+        ns_size = _dir_size(ns_dir)
+        total += ns_size
+        click.secho(f"  {ns_dir.name}  {_human(ns_size)}", bold=True)
+
+        entries = sorted(d for d in ns_dir.iterdir() if d.is_dir())
+        for i, feat_dir in enumerate(entries):
+            size = _dir_size(feat_dir)
+            connector = "└──" if i == len(entries) - 1 else "├──"
+            name = feat_dir.name
+            label = (
+                click.style(f"@{name.split('@')[1]}", fg="green")
+                if "@" in name
+                else click.style("editable", fg="blue")
+            )
+            base = name.split("@")[0] if "@" in name else name
+            click.echo(f"    {connector} {base}  {label}  {_human(size)}")
+        click.echo()
+
+    click.secho(f"  Total: {_human(total)}", fg="cyan", bold=True)
+
+
+cli_command = cache_size