svc-infra 0.1.615__py3-none-any.whl → 0.1.616__py3-none-any.whl

svc_infra/bundled_docs/README.md

@@ -0,0 +1,5 @@
+# Bundled Docs
+
+This directory contains a minimal set of Markdown files that the `svc-infra docs` CLI can fall back to when the project running the CLI doesn't have a local `docs/` directory.
+
+You can add more topics here as needed; each `*.md` file becomes a topic named after its stem (e.g., `getting-started.md` -> `getting-started`).

svc_infra/bundled_docs/__init__.py

@@ -0,0 +1 @@
+# Bundled docs package for zip-safe importlib.resources access

svc_infra/bundled_docs/getting-started.md

@@ -0,0 +1,6 @@
+# Getting Started
+
+Welcome to svc-infra docs. Use `svc-infra docs list` to see topics.
+
+- This content is bundled with the package.
+- If your project doesn't have a local `docs/` folder, you'll still see this.

svc_infra/cli/cmds/docs/docs_cmds.py

@@ -1,69 +1,203 @@
 from __future__ import annotations
 
+import os
 from pathlib import Path
-from typing import Dict, List, Tuple
+from typing import Dict, List
 
+import click
 import typer
+from typer.core import TyperGroup
 
 from svc_infra.app.root import resolve_project_root
 
 
-def _discover_docs(root: Path) -> List[Tuple[str, Path]]:
-    """Return a list of (topic, file_path) for top-level Markdown files under docs/.
-
-    Topic is the filename stem (e.g. security.md -> "security").
-    """
-    docs_dir = root / "docs"
-    topics: List[Tuple[str, Path]] = []
-    if not docs_dir.exists() or not docs_dir.is_dir():
-        return topics
-    for p in sorted(docs_dir.glob("*.md")):
-        if p.is_file():
-            topics.append((p.stem.replace(" ", "-"), p))
+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[p.stem.replace(" ", "-")] = p
     return topics
 
 
-def register(app: typer.Typer) -> None:
-    """Register the `docs` command group and dynamic topic subcommands."""
-
-    root = resolve_project_root()
-    discovered = _discover_docs(root)
+def _discover_pkg_topics() -> Dict[str, object]:
+    topics: Dict[str, object] = {}
+    try:
+        import importlib.resources as ir
 
-    # Build help text listing available topics
-    if discovered:
-        topic_names = ", ".join(name for name, _ in discovered)
-        docs_help = (
-            f"Show docs from the repository's docs/ directory.\n\nAvailable topics: {topic_names}"
-        )
-    else:
-        docs_help = "Show docs from the repository's docs/ directory.\n\nNo topics discovered."
+        pkg_docs = ir.files("svc_infra.bundled_docs")
+        for res in pkg_docs.iterdir():
+            if res.name.endswith(".md"):
+                topics[Path(res.name).stem.replace(" ", "-")] = res
+    except Exception:
+        pass
+    return topics
 
-    docs_app = typer.Typer(no_args_is_help=True, help=docs_help, add_completion=False)
 
-    @docs_app.command("list", help="List available documentation topics")
-    def list_topics() -> None:
-        for name, path in discovered:
-            typer.echo(f"{name}\t{path.relative_to(root)}")
+def _resolve_docs_dir(ctx: click.Context) -> Path | None:
+    # CLI option takes precedence; walk up parent contexts because Typer
+    # executes subcommands in child contexts that do not inherit params.
+    current: click.Context | None = ctx
+    while current is not None:
+        docs_dir = (current.params or {}).get("docs_dir")
+        if docs_dir:
+            path = docs_dir if isinstance(docs_dir, Path) else Path(docs_dir)
+            path = path.expanduser()
+            if path.exists():
+                return path
+        current = current.parent
+    # Env var next
+    env_dir = os.getenv("SVC_INFRA_DOCS_DIR")
+    if env_dir:
+        p = Path(env_dir).expanduser()
+        if p.exists():
+            return p
+    # Project docs
+    root = resolve_project_root()
+    proj_docs = root / "docs"
+    if proj_docs.exists():
+        return proj_docs
+    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() if not fs else {}
+        names.extend(fs.keys())
+        names.extend(pkg.keys())
+        # Deduplicate and sort
+        uniq = sorted({*names})
+        return uniq
+
+    def get_command(self, ctx: click.Context, name: str) -> click.Command | None:
+        # Built-ins first (e.g., list)
+        cmd = super().get_command(ctx, name)
+        if cmd is not None:
+            return cmd
+
+        # Dynamic topic resolution
+        dir_to_use = _resolve_docs_dir(ctx)
+        fs = _discover_fs_topics(dir_to_use) if dir_to_use else {}
+        if name in fs:
+            file_path = fs[name]
+
+            @click.command(name=name)
+            def _show_fs() -> None:
+                click.echo(file_path.read_text(encoding="utf-8", errors="replace"))
+
+            return _show_fs
+
+        if not fs:
+            pkg = _discover_pkg_topics()
+            if name in pkg:
+                res = pkg[name]
+
+                @click.command(name=name)
+                def _show_pkg() -> None:
+                    try:
+                        import importlib.resources as ir
+
+                        content = getattr(res, "read_text", None)
+                        if callable(content):
+                            text = content(encoding="utf-8", errors="replace")
+                        else:
+                            with ir.as_file(res) as p:
+                                text = Path(p).read_text(encoding="utf-8", errors="replace")
+                        click.echo(text)
+                    except Exception as e:  # pragma: no cover
+                        raise click.ClickException(f"Failed to load bundled doc: {e}")
+
+                return _show_pkg
+
+        return None
 
-    # Freeze mapping for use in dynamic commands and generic fallback
-    topic_map: Dict[str, Path] = {name: path for name, path in discovered}
 
-    def _make_topic_cmd(topic: str, file_path: Path):
-        @docs_app.command(name=topic, help=f"Show docs for topic: {topic}")
-        def _show_topic() -> None:  # noqa: WPS430 (nested function OK for closure)
-            content = file_path.read_text(encoding="utf-8", errors="replace")
-            typer.echo(content)
+def register(app: typer.Typer) -> None:
+    """Register the `docs` command group with dynamic topic subcommands."""
 
-    for name, path in discovered:
-        _make_topic_cmd(name, path)
+    docs_app = typer.Typer(no_args_is_help=True, add_completion=False, cls=DocsGroup)
 
-    # Optional generic fallback: allow `svc-infra docs --topic <name>`
     @docs_app.callback(invoke_without_command=True)
-    def _maybe_show_topic(topic: str = typer.Option(None, "--topic", help="Topic to show")) -> None:  # type: ignore[no-redef]
+    def _docs_options(
+        docs_dir: Path | None = typer.Option(
+            None,
+            "--docs-dir",
+            help="Path to a docs directory to read from (overrides env/project root)",
+        ),
+        topic: str | None = typer.Option(None, "--topic", help="Topic to show directly"),
+    ) -> None:
+        """Support --docs-dir and --topic at group level."""
         if topic:
-            p = topic_map.get(topic)
-            if not p:
-                raise typer.BadParameter(f"Unknown topic: {topic}")
-            typer.echo(p.read_text(encoding="utf-8", errors="replace"))
+            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 topic in fs:
+                typer.echo(fs[topic].read_text(encoding="utf-8", errors="replace"))
+                raise typer.Exit(code=0)
+            if not fs:
+                pkg = _discover_pkg_topics()
+                if topic in pkg:
+                    try:
+                        import importlib.resources as ir
+
+                        res = pkg[topic]
+                        content = getattr(res, "read_text", None)
+                        if callable(content):
+                            text = content(encoding="utf-8", errors="replace")
+                        else:
+                            with ir.as_file(res) as p:
+                                text = Path(p).read_text(encoding="utf-8", errors="replace")
+                        typer.echo(text)
+                        raise typer.Exit(code=0)
+                    except Exception as e:  # pragma: no cover
+                        raise typer.BadParameter(f"Failed to load bundled topic '{topic}': {e}")
+            raise typer.BadParameter(f"Unknown topic: {topic}")
+
+    @docs_app.command("list", help="List available documentation topics")
+    def list_topics() -> None:
+        ctx = click.get_current_context()
+        root = resolve_project_root()
+        dir_to_use = _resolve_docs_dir(ctx)
+        fs = _discover_fs_topics(dir_to_use) if dir_to_use else {}
+        pkg = _discover_pkg_topics() if not fs else {}
+        for name, path in fs.items():
+            try:
+                rel = path.relative_to(root)
+                typer.echo(f"{name}\t{rel}")
+            except Exception:
+                typer.echo(f"{name}\t{path}")
+        for name in sorted(pkg.keys()):
+            typer.echo(f"{name}\t(bundled)")
+
+    # Also support a generic "show" command
+    @docs_app.command("show", help="Show docs for a topic (alternative to dynamic subcommand)")
+    def show(topic: str) -> None:
+        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 topic in fs:
+            typer.echo(fs[topic].read_text(encoding="utf-8", errors="replace"))
+            return
+        if not fs:
+            pkg = _discover_pkg_topics()
+            if topic in pkg:
+                try:
+                    import importlib.resources as ir
+
+                    res = pkg[topic]
+                    content = getattr(res, "read_text", None)
+                    if callable(content):
+                        text = content(encoding="utf-8", errors="replace")
+                    else:
+                        with ir.as_file(res) as p:
+                            text = Path(p).read_text(encoding="utf-8", errors="replace")
+                    typer.echo(text)
+                    return
+                except Exception as e:  # pragma: no cover
+                    raise typer.BadParameter(f"Failed to load bundled topic '{topic}': {e}")
+        raise typer.BadParameter(f"Unknown topic: {topic}")
 
     app.add_typer(docs_app, name="docs")

{svc_infra-0.1.615.dist-info → svc_infra-0.1.616.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: svc-infra
-Version: 0.1.615
+Version: 0.1.616
 Summary: Infrastructure for building and deploying prod-ready services
 License: MIT
 Keywords: fastapi,sqlalchemy,alembic,auth,infra,async,pydantic

{svc_infra-0.1.615.dist-info → svc_infra-0.1.616.dist-info}/RECORD

@@ -115,6 +115,9 @@ svc_infra/app/root.py,sha256=344EWBMJCduwzJ1BBo0yGAu15TkryuvOW4qBZ6Gk-8w,1635
 svc_infra/billing/__init__.py,sha256=AdVxgBWibsz0xWk-Z91B7HecA-EhPMSRrXWIYPBgtMA,365
 svc_infra/billing/models.py,sha256=bnCGPKfnK__6x0f0bwKYQsG2GwXjJFi3YRXnq5JYs7c,6083
 svc_infra/billing/service.py,sha256=3SDpPA3NF2lMYiOP4U99sgXpZAXaauexBfZQmYE2kvU,3727
+svc_infra/bundled_docs/README.md,sha256=FqTieL4ADODxTnig8yehV2KdHX9bASDega52bjp5n70,338
+svc_infra/bundled_docs/__init__.py,sha256=8_jF4fM-3Wf6j_mE4000_9AHcJ3tYZXO9hJY-pBEepM,63
+svc_infra/bundled_docs/getting-started.md,sha256=JaMOgRUK_ajaX4SCtiE3GrhQ81wMwng6y46t0032ftU,210
 svc_infra/cache/README.md,sha256=ZgIpmE0UVlGktp2nXUYv6FKJATCdkR_01v-GGxHN6Ao,10795
 svc_infra/cache/__init__.py,sha256=Fz3NS81jrY5sLikRhITCeHDT4MlOLcbMed5EjVecSAg,956
 svc_infra/cache/backend.py,sha256=-dbZ2qkhebzbKosQqgvBNb01A-2_jGt6_0WmJhPoHy8,4418
@@ -139,7 +142,7 @@ svc_infra/cli/cmds/db/sql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJW
 svc_infra/cli/cmds/db/sql/alembic_cmds.py,sha256=kkAu8sfBLWbb9ApMS95b7b_c6GifqvPaRsO7K8icMVI,9649
 svc_infra/cli/cmds/db/sql/sql_export_cmds.py,sha256=6MxoQO-9upoXg0cl1RHIqz96yXFVGidiBYp_ewhB0E0,2700
 svc_infra/cli/cmds/db/sql/sql_scaffold_cmds.py,sha256=eNTCqHXOxgl9H3WTbGVn9BHXYwCpjIEJsDqhEFdrYMM,4613
-svc_infra/cli/cmds/docs/docs_cmds.py,sha256=3GCoRKjnRr_re__7TuelDbcaouJawHlz0AphYyI0DIE,2575
+svc_infra/cli/cmds/docs/docs_cmds.py,sha256=uRoClC68-FRLGkHyTYds3h2xKE_4STzkudB6T72DiKo,7611
 svc_infra/cli/cmds/dx/__init__.py,sha256=wQtl3-kOgoESlpVkjl3YFtqkOnQSIvVsOdutiaZFejM,197
 svc_infra/cli/cmds/dx/dx_cmds.py,sha256=XTKUJzS3UIYn6h3CHzDEWKYJaWn0TzGiUCq3OeW27E0,3326
 svc_infra/cli/cmds/help.py,sha256=wGfZFMYaR2ZPwW2JwKDU7M3m4AtdCd8GRQ412AmEBUM,758
@@ -293,7 +296,7 @@ svc_infra/webhooks/fastapi.py,sha256=BCNvGNxukf6dC2a4i-6en-PrjBGV19YvCWOot5lXWsA
 svc_infra/webhooks/router.py,sha256=6JvAVPMEth_xxHX-IsIOcyMgHX7g1H0OVxVXKLuMp9w,1596
 svc_infra/webhooks/service.py,sha256=hWgiJRXKBwKunJOx91C7EcLUkotDtD3Xp0RT6vj2IC0,1797
 svc_infra/webhooks/signing.py,sha256=NCwdZzmravUe7HVIK_uXK0qqf12FG-_MVsgPvOw6lsM,784
-svc_infra-0.1.615.dist-info/METADATA,sha256=VFmBWPFEQHoLsz2vTyHO2DMDkN9C70YlI3zAJolFyJg,8106
-svc_infra-0.1.615.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-svc_infra-0.1.615.dist-info/entry_points.txt,sha256=6x_nZOsjvn6hRZsMgZLgTasaCSKCgAjsGhACe_CiP0U,48
-svc_infra-0.1.615.dist-info/RECORD,,
+svc_infra-0.1.616.dist-info/METADATA,sha256=8UIJLzGOQ3LgK55oyA9V_dGAg_i33C5wou1tkDajCzM,8106
+svc_infra-0.1.616.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+svc_infra-0.1.616.dist-info/entry_points.txt,sha256=6x_nZOsjvn6hRZsMgZLgTasaCSKCgAjsGhACe_CiP0U,48
+svc_infra-0.1.616.dist-info/RECORD,,