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

svc_infra/cli/__init__.py

@@ -6,6 +6,7 @@ from svc_infra.cli.cmds import (
     _HELP,
     jobs_app,
     register_alembic,
+    register_docs,
     register_dx,
     register_mongo,
     register_mongo_scaffold,
@@ -40,6 +41,9 @@ app.add_typer(jobs_app, name="jobs")
 # -- sdk commands ---
 register_sdk(app)
 
+# -- docs commands ---
+register_docs(app)
+
 
 def main():
     app()

svc_infra/cli/cmds/__init__.py

@@ -5,6 +5,7 @@ from svc_infra.cli.cmds.db.nosql.mongo.mongo_scaffold_cmds import (
 from svc_infra.cli.cmds.db.sql.alembic_cmds import register as register_alembic
 from svc_infra.cli.cmds.db.sql.sql_export_cmds import register as register_sql_export
 from svc_infra.cli.cmds.db.sql.sql_scaffold_cmds import register as register_sql_scaffold
+from svc_infra.cli.cmds.docs.docs_cmds import register as register_docs
 from svc_infra.cli.cmds.dx import register_dx
 from svc_infra.cli.cmds.jobs.jobs_cmds import app as jobs_app
 from svc_infra.cli.cmds.obs.obs_cmds import register as register_obs
@@ -22,5 +23,6 @@ __all__ = [
     "jobs_app",
     "register_sdk",
     "register_dx",
+    "register_docs",
     "_HELP",
 ]

svc_infra/cli/cmds/docs/docs_cmds.py

@@ -0,0 +1,69 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Dict, List, Tuple
+
+import typer
+
+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))
+    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)
+
+    # 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."
+
+    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)}")
+
+    # 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)
+
+    for name, path in discovered:
+        _make_topic_cmd(name, path)
+
+    # 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]
+        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"))
+
+    app.add_typer(docs_app, name="docs")

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

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

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

@@ -126,9 +126,9 @@ svc_infra/cache/resources.py,sha256=BhvPAZvCQ-fitUdniGEOOE4g1ZvljdCA_R5pR8WfJz4,
 svc_infra/cache/tags.py,sha256=9URw4BRlnb4QFAYpDI36fMms6642xq4TeV9jqsEjzE8,2625
 svc_infra/cache/ttl.py,sha256=_lWvNx1CTE4RcFEOUYkADd7_k4I13SLmtK0AMRUq2OM,1945
 svc_infra/cache/utils.py,sha256=-LWr5IiJCNm3pwaoeCVlxNknnO2ChNKFcAGlFU98kjg,4856
-svc_infra/cli/__init__.py,sha256=Bdmx-qMHwPINg1S6nIsU7f4Qfrg8QmDiIQ11BblEuL4,864
+svc_infra/cli/__init__.py,sha256=enGeMhxOjfeClic51C4QB2Car3DDZD3A9P9R_8YfYHQ,926
 svc_infra/cli/__main__.py,sha256=5BjNuyet8AY-POwoF5rGt722rHQ7tJ0Vf0UFUfzzi-I,58
-svc_infra/cli/cmds/__init__.py,sha256=MqXFdhTyLHua-c0bJGm0O5kFKsS-TXrA48PJy5u5zFU,958
+svc_infra/cli/cmds/__init__.py,sha256=xKVXpMP_fD7jfmYonxWxh5LKHUQiuIFaJgkpqtkPt-M,1051
 svc_infra/cli/cmds/db/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 svc_infra/cli/cmds/db/nosql/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 svc_infra/cli/cmds/db/nosql/mongo/README.md,sha256=0u3XLeoBd0XQzXwwfEiFISMIij11TJ9iOGzrysBvsFk,1788
@@ -139,6 +139,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/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
@@ -292,7 +293,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.614.dist-info/METADATA,sha256=zY3M6rLvXJH2tE7oHwD07QN7zEMfD4yjVP0AbYrMV48,8106
-svc_infra-0.1.614.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-svc_infra-0.1.614.dist-info/entry_points.txt,sha256=6x_nZOsjvn6hRZsMgZLgTasaCSKCgAjsGhACe_CiP0U,48
-svc_infra-0.1.614.dist-info/RECORD,,
+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,,