svc-infra 0.1.595__py3-none-any.whl → 0.1.706__py3-none-any.whl

svc_infra/cli/cmds/db/sql/sql_export_cmds.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+import asyncio
+import json
+import os
+import sys
+from pathlib import Path
+from typing import Any, Optional, cast
+
+import typer
+from sqlalchemy import text
+from sqlalchemy.engine import Engine
+
+from svc_infra.db.sql.utils import build_engine
+
+try:  # SQLAlchemy async extras are optional
+    import sqlalchemy.ext.asyncio as sa_async
+except Exception:  # pragma: no cover - fallback when async extras unavailable
+    sa_async = None  # type: ignore[assignment]
+
+
+def export_tenant(
+    table: str = typer.Argument(
+        ..., help="Qualified table name to export (e.g., public.items)"
+    ),
+    tenant_id: str = typer.Option(
+        ..., "--tenant-id", help="Tenant id value to filter by."
+    ),
+    tenant_field: str = typer.Option(
+        "tenant_id", help="Column name for tenant id filter."
+    ),
+    output: Optional[Path] = typer.Option(
+        None, "--output", help="Output file; defaults to stdout."
+    ),
+    limit: Optional[int] = typer.Option(None, help="Max rows to export."),
+    database_url: Optional[str] = typer.Option(
+        None, "--database-url", help="Overrides env SQL_URL for this command."
+    ),
+):
+    """Export rows for a tenant from a given SQL table as JSON array."""
+    if database_url:
+        os.environ["SQL_URL"] = database_url
+
+    url = os.getenv("SQL_URL")
+    if not url:
+        typer.echo("SQL_URL is required (or pass --database-url)", err=True)
+        raise typer.Exit(code=2)
+
+    engine = build_engine(url)
+    rows: list[dict[str, Any]]
+    query = f"SELECT * FROM {table} WHERE {tenant_field} = :tenant_id"
+    if limit and limit > 0:
+        query += " LIMIT :limit"
+
+    params: dict[str, Any] = {"tenant_id": tenant_id}
+    if limit and limit > 0:
+        params["limit"] = int(limit)
+
+    stmt = text(query)
+
+    is_async_engine = sa_async is not None and isinstance(engine, sa_async.AsyncEngine)
+
+    if is_async_engine:
+        async_engine = cast(Any, engine)
+
+        async def _fetch() -> list[dict[str, Any]]:
+            async with async_engine.connect() as conn:
+                result = await conn.execute(stmt, params)
+                return [dict(row) for row in result.mappings()]
+
+        rows = asyncio.run(_fetch())
+    else:
+        sync_engine = cast(Engine, engine)
+        with sync_engine.connect() as conn:
+            result = conn.execute(stmt, params)
+            rows = [dict(row) for row in result.mappings()]
+
+    data = json.dumps(rows, indent=2)
+    if output:
+        output.write_text(data)
+        typer.echo(str(output))
+    else:
+        sys.stdout.write(data)
+
+
+def register(app_root: typer.Typer) -> None:
+    # Attach directly to the provided 'sql' group app
+    app_root.command("export-tenant")(export_tenant)

svc_infra/cli/cmds/db/sql/sql_scaffold_cmds.py

@@ -134,6 +134,6 @@ def cmd_scaffold_schemas(
 
 
 def register(app: typer.Typer) -> None:
-    app.command("sql-scaffold")(cmd_scaffold)
-    app.command("sql-scaffold-models")(cmd_scaffold_models)
-    app.command("sql-scaffold-schemas")(cmd_scaffold_schemas)
+    app.command("scaffold")(cmd_scaffold)
+    app.command("scaffold-models")(cmd_scaffold_models)
+    app.command("scaffold-schemas")(cmd_scaffold_schemas)

svc_infra/cli/cmds/docs/docs_cmds.py

@@ -0,0 +1,142 @@
+from __future__ import annotations
+
+import os
+from importlib.resources import as_file
+from importlib.resources import files as pkg_files
+from pathlib import Path
+from typing import Dict, List
+
+import click
+import typer
+from typer.core import TyperGroup
+
+from svc_infra.app.root import resolve_project_root
+
+
+def _norm(name: str) -> str:
+    return name.strip().lower().replace(" ", "-").replace("_", "-")
+
+
+def _discover_fs_topics(docs_dir: Path) -> Dict[str, Path]:
+    topics: Dict[str, Path] = {}
+    if docs_dir.exists() and docs_dir.is_dir():
+        for p in sorted(docs_dir.glob("*.md")):
+            if p.is_file():
+                topics[_norm(p.stem)] = p
+    return topics
+
+
+def _discover_pkg_topics() -> Dict[str, Path]:
+    """
+    Discover docs shipped inside the installed package at svc_infra/docs/*,
+    using importlib.resources so this works for wheels, sdists, and zipped wheels.
+    """
+    topics: Dict[str, Path] = {}
+    try:
+        docs_root = pkg_files("svc_infra").joinpath("docs")
+        # docs_root is a Traversable; it may be inside a zip. Iterate safely.
+        for entry in docs_root.iterdir():
+            if entry.name.endswith(".md"):
+                # materialize to a real tempfile path if needed
+                with as_file(entry) as concrete:
+                    p = Path(concrete)
+                    if p.exists() and p.is_file():
+                        topics[_norm(p.stem)] = p
+    except Exception:
+        # If the package has no docs directory, just return empty.
+        pass
+    return topics
+
+
+def _resolve_docs_dir(ctx: click.Context) -> Path | None:
+    """
+    Optional override precedence:
+      1) SVC_INFRA_DOCS_DIR env var
+      2) *Only when working inside the svc-infra repo itself*: repo-root /docs
+    """
+    # 1) Env var
+    env_dir = os.getenv("SVC_INFRA_DOCS_DIR")
+    if env_dir:
+        p = Path(env_dir).expanduser()
+        if p.exists():
+            return p
+
+    # 2) In-repo convenience (so `svc-infra docs` works inside this repo)
+    try:
+        root = resolve_project_root()
+        proj_docs = root / "docs"
+        if proj_docs.exists():
+            return proj_docs
+    except Exception:
+        pass
+
+    return None
+
+
+class DocsGroup(TyperGroup):
+    def list_commands(self, ctx: click.Context) -> List[str]:
+        names: List[str] = list(super().list_commands(ctx) or [])
+        dir_to_use = _resolve_docs_dir(ctx)
+        fs = _discover_fs_topics(dir_to_use) if dir_to_use else {}
+        pkg = _discover_pkg_topics()
+        names.extend(fs.keys())
+        names.extend([k for k in pkg.keys() if k not in fs])
+        return sorted(set(names))
+
+    def get_command(self, ctx: click.Context, name: str) -> click.Command | None:
+        cmd = super().get_command(ctx, name)
+        if cmd is not None:
+            return cmd
+
+        key = _norm(name)
+
+        dir_to_use = _resolve_docs_dir(ctx)
+        fs = _discover_fs_topics(dir_to_use) if dir_to_use else {}
+        if key in fs:
+            file_path = fs[key]
+
+            @click.command(name=name)
+            def _show_fs() -> None:
+                click.echo(file_path.read_text(encoding="utf-8", errors="replace"))
+
+            return _show_fs
+
+        pkg = _discover_pkg_topics()
+        if key in pkg:
+            file_path = pkg[key]
+
+            @click.command(name=name)
+            def _show_pkg() -> None:
+                click.echo(file_path.read_text(encoding="utf-8", errors="replace"))
+
+            return _show_pkg
+
+        return None
+
+
+def register(app: typer.Typer) -> None:
+    docs_app = typer.Typer(no_args_is_help=True, add_completion=False, cls=DocsGroup)
+
+    @docs_app.callback(invoke_without_command=True)
+    def _docs_options() -> None:
+        # No group-level options; dynamic commands and 'show' handle topics.
+        return None
+
+    @docs_app.command(
+        "show", help="Show docs for a topic (alternative to dynamic subcommand)"
+    )
+    def show(topic: str) -> None:
+        key = _norm(topic)
+        ctx = click.get_current_context()
+        dir_to_use = _resolve_docs_dir(ctx)
+        fs = _discover_fs_topics(dir_to_use) if dir_to_use else {}
+        if key in fs:
+            typer.echo(fs[key].read_text(encoding="utf-8", errors="replace"))
+            return
+        pkg = _discover_pkg_topics()
+        if key in pkg:
+            typer.echo(pkg[key].read_text(encoding="utf-8", errors="replace"))
+            return
+        raise typer.BadParameter(f"Unknown topic: {topic}")
+
+    app.add_typer(docs_app, name="docs")

svc_infra/cli/cmds/dx/__init__.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+import typer
+
+from .dx_cmds import app as dx_app
+
+
+def register_dx(root: typer.Typer) -> None:
+    root.add_typer(dx_app, name="dx")
+
+
+__all__ = ["register_dx"]

svc_infra/cli/cmds/dx/dx_cmds.py

@@ -0,0 +1,116 @@
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+import typer
+
+from svc_infra.dx.changelog import Commit, generate_release_section
+from svc_infra.dx.checks import (
+    check_migrations_up_to_date,
+    check_openapi_problem_schema,
+)
+
+app = typer.Typer(no_args_is_help=True, add_completion=False)
+
+
+@app.command("openapi")
+def cmd_openapi(path: str = typer.Argument(..., help="Path to OpenAPI JSON")):
+    try:
+        check_openapi_problem_schema(path=path)
+    except Exception as e:  # noqa: BLE001
+        typer.secho(f"OpenAPI check failed: {e}", fg=typer.colors.RED, err=True)
+        raise typer.Exit(2)
+    typer.secho("OpenAPI checks passed", fg=typer.colors.GREEN)
+
+
+@app.command("migrations")
+def cmd_migrations(project_root: str = typer.Option(".", help="Project root")):
+    try:
+        check_migrations_up_to_date(project_root=project_root)
+    except Exception as e:  # noqa: BLE001
+        typer.secho(f"Migrations check failed: {e}", fg=typer.colors.RED, err=True)
+        raise typer.Exit(2)
+    typer.secho("Migrations checks passed", fg=typer.colors.GREEN)
+
+
+@app.command("changelog")
+def cmd_changelog(
+    version: str = typer.Argument(..., help="Version (e.g., 0.1.604)"),
+    commits_file: str = typer.Option(
+        None, help="Path to JSON lines of commits (sha,subject)"
+    ),
+):
+    """Generate a changelog section from commit messages.
+
+    Expects Conventional Commits style for best grouping; falls back to Other.
+    If commits_file is omitted, prints an example format.
+    """
+    import json
+    import sys
+
+    if not commits_file:
+        typer.echo(
+            '# Provide --commits-file with JSONL: {"sha": "<sha>", "subject": "feat: ..."}',
+            err=True,
+        )
+        raise typer.Exit(2)
+    rows = [
+        json.loads(line)
+        for line in Path(commits_file).read_text().splitlines()
+        if line.strip()
+    ]
+    commits = [Commit(sha=r["sha"], subject=r["subject"]) for r in rows]
+    out = generate_release_section(version=version, commits=commits)
+    sys.stdout.write(out)
+
+
+@app.command("ci")
+def cmd_ci(
+    run: bool = typer.Option(
+        False, help="Execute the steps; default just prints a plan"
+    ),
+    openapi: str | None = typer.Option(None, help="Path to OpenAPI JSON to lint"),
+    project_root: str = typer.Option(".", help="Project root for migrations check"),
+):
+    """Print (or run) the CI steps locally to mirror the workflow."""
+    steps: list[list[str]] = []
+    # Lint, typecheck, tests
+    steps.append(["flake8", "--select=E,F"])  # mirrors CI
+    steps.append(["mypy", "src"])  # mirrors CI
+    if openapi:
+        steps.append([sys.executable, "-m", "svc_infra.cli", "dx", "openapi", openapi])
+    steps.append(
+        [
+            sys.executable,
+            "-m",
+            "svc_infra.cli",
+            "dx",
+            "migrations",
+            "--project-root",
+            project_root,
+        ]
+    )
+    steps.append(["pytest", "-q", "-W", "error"])  # mirrors CI
+
+    if not run:
+        typer.echo("CI dry-run plan:")
+        for cmd in steps:
+            typer.echo("  $ " + " ".join(cmd))
+        return
+
+    import subprocess
+
+    for cmd in steps:
+        typer.echo("Running: " + " ".join(cmd))
+        res = subprocess.run(cmd)
+        if res.returncode != 0:
+            raise typer.Exit(res.returncode)
+    typer.echo("All CI steps passed")
+
+
+def main():  # pragma: no cover - CLI entrypoint
+    app()
+
+
+__all__ = ["main", "app"]

svc_infra/cli/cmds/health/__init__.py

@@ -0,0 +1,179 @@
+"""Health check CLI commands.
+
+Provides CLI commands for health checking:
+- check: Check health of a URL endpoint
+"""
+
+from __future__ import annotations
+
+import asyncio
+import json
+
+import typer
+
+
+def cmd_check(
+    url: str = typer.Argument(
+        ...,
+        help="URL of the health endpoint to check.",
+    ),
+    timeout: float = typer.Option(
+        10.0,
+        "--timeout",
+        "-t",
+        help="Request timeout in seconds.",
+    ),
+    json_output: bool = typer.Option(
+        False,
+        "--json",
+        "-j",
+        help="Output as JSON.",
+    ),
+    verbose: bool = typer.Option(
+        False,
+        "--verbose",
+        "-v",
+        help="Show detailed response.",
+    ),
+) -> None:
+    """
+    Check health of a URL endpoint.
+
+    Fetches the URL and reports the health status based on HTTP response.
+    Expects the endpoint to return 200 for healthy status.
+
+    Examples:
+        svc-infra health check http://localhost:8000/health
+        svc-infra health check http://api:8080/ready --timeout 5
+        svc-infra health check http://localhost:8000/health --json
+
+    Exit codes:
+        0: Healthy (HTTP 2xx)
+        1: Unhealthy or unreachable
+    """
+
+    async def _check() -> dict:
+        """Perform the health check and return result."""
+        from svc_infra.health import check_url
+
+        # Create the check function with the given URL
+        check_fn = check_url(url, timeout=timeout)
+
+        # Run the check
+        result = await check_fn()
+
+        return result.to_dict()
+
+    result = asyncio.run(_check())
+
+    if json_output:
+        typer.echo(json.dumps(result, indent=2))
+    else:
+        status = result["status"]
+        latency = result["latency_ms"]
+
+        if status == "healthy":
+            typer.secho(f"✓ {url}", fg=typer.colors.GREEN)
+            typer.echo(f"  Status: {status} ({latency:.1f}ms)")
+        else:
+            typer.secho(f"✗ {url}", fg=typer.colors.RED)
+            typer.echo(f"  Status: {status}")
+            if result.get("message"):
+                typer.echo(f"  Message: {result['message']}")
+
+        if verbose and result.get("details"):
+            typer.echo("  Details:")
+            for key, value in result["details"].items():
+                typer.echo(f"    {key}: {value}")
+
+    # Exit with error code if unhealthy
+    if result["status"] != "healthy":
+        raise typer.Exit(1)
+
+
+def cmd_wait(
+    url: str = typer.Argument(
+        ...,
+        help="URL of the health endpoint to wait for.",
+    ),
+    timeout: int = typer.Option(
+        60,
+        "--timeout",
+        "-t",
+        help="Maximum time to wait in seconds.",
+    ),
+    interval: float = typer.Option(
+        2.0,
+        "--interval",
+        "-i",
+        help="Time between checks in seconds.",
+    ),
+    quiet: bool = typer.Option(
+        False,
+        "--quiet",
+        "-q",
+        help="Suppress progress messages.",
+    ),
+) -> None:
+    """
+    Wait for a health endpoint to become healthy.
+
+    Repeatedly checks the URL until it returns a healthy response
+    or timeout is reached.
+
+    Examples:
+        svc-infra health wait http://localhost:8000/health
+        svc-infra health wait http://api:8080/ready --timeout 120
+
+    Exit codes:
+        0: Endpoint became healthy
+        1: Timeout reached, endpoint not healthy
+    """
+    import time
+
+    async def _wait() -> bool:
+        """Wait loop."""
+        from svc_infra.health import check_url
+
+        check_fn = check_url(url, timeout=5.0)
+        deadline = time.monotonic() + timeout
+        attempt = 0
+
+        while time.monotonic() < deadline:
+            attempt += 1
+            if not quiet:
+                typer.echo(f"Attempt {attempt}: Checking {url}...")
+
+            result = await check_fn()
+
+            if result.status == "healthy":
+                if not quiet:
+                    typer.secho(
+                        f"✓ Healthy ({result.latency_ms:.1f}ms)",
+                        fg=typer.colors.GREEN,
+                    )
+                return True
+
+            if not quiet:
+                msg = result.message or "Unhealthy"
+                typer.echo(f"  → {msg}")
+
+            remaining = deadline - time.monotonic()
+            if remaining > 0:
+                await asyncio.sleep(min(interval, remaining))
+
+        return False
+
+    success = asyncio.run(_wait())
+    if not success:
+        typer.secho(
+            f"ERROR: Endpoint not healthy after {timeout}s",
+            fg=typer.colors.RED,
+        )
+        raise typer.Exit(1)
+
+
+def register(app: typer.Typer) -> None:
+    """Register health check commands with the CLI app."""
+    app.command("check")(cmd_check)
+    app.command("wait")(cmd_wait)

svc_infra/cli/cmds/health/health_cmds.py

@@ -0,0 +1,8 @@
+"""Health check CLI commands module.
+
+Re-exports from health/__init__.py for backward compatibility.
+"""
+
+from svc_infra.cli.cmds.health import register
+
+__all__ = ["register"]

svc_infra/cli/cmds/help.py

@@ -21,4 +21,8 @@ How to run (pick what fits your workflow):
 Notes:
 * Make sure you’re in the right virtual environment (or use `pipx`).
 * You can point `--project-root` at your Alembic root; if omitted we auto-detect.
+
+Learn more:
+* Explore available topics: `svc-infra docs --help`
+* Show a topic directly: `svc-infra docs <topic>` or `svc-infra docs show <topic>`
 """

svc_infra/cli/cmds/jobs/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

svc_infra/cli/cmds/jobs/jobs_cmds.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import asyncio
+from typing import Optional
+
+import typer
+
+from svc_infra.jobs.easy import easy_jobs
+from svc_infra.jobs.loader import schedule_from_env
+from svc_infra.jobs.worker import process_one
+
+app = typer.Typer(help="Background jobs and scheduler commands")
+
+
+@app.command("run")
+def run(
+    poll_interval: float = typer.Option(
+        0.5, help="Sleep seconds between loops when idle"
+    ),
+    max_loops: Optional[int] = typer.Option(
+        None, help="Max loops before exit (for tests)"
+    ),
+):
+    """Run scheduler ticks and process jobs in a simple loop."""
+
+    queue, scheduler = easy_jobs()
+    # load schedule from env JSON if provided
+    schedule_from_env(scheduler)
+
+    async def _loop():
+        loops = 0
+        while True:
+            await scheduler.tick()
+            processed = await process_one(queue, _noop_handler)
+            if not processed:
+                # idle
+                await asyncio.sleep(poll_interval)
+            if max_loops is not None:
+                loops += 1
+                if loops >= max_loops:
+                    break
+
+    async def _noop_handler(job):
+        # Default handler does nothing; users should write their own runners
+        return None
+
+    asyncio.run(_loop())