simple-module-hosting 0.0.1__tar.gz → 0.0.3__tar.gz

{simple_module_hosting-0.0.1 → simple_module_hosting-0.0.3}/.gitignore

@@ -36,6 +36,10 @@ uploads/
 # Vite
 host/static/dist/
 
+# VitePress (docs)
+docs/.vitepress/cache/
+docs/.vitepress/dist/
+
 # Auto-generated frontend module manifest (regenerated by the host at boot
 # or via `make gen-pages`).
 host/client_app/modules.manifest.json

{simple_module_hosting-0.0.1 → simple_module_hosting-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple_module_hosting
-Version: 0.0.1
+Version: 0.0.3
 Summary: FastAPI + Inertia.js host runtime for simple_module — app_builder, middleware stack, CLI (sm / simple-module), scaffolding
 Project-URL: Homepage, https://github.com/antosubash/simple_module_python
 Project-URL: Repository, https://github.com/antosubash/simple_module_python
@@ -26,8 +26,8 @@ Requires-Dist: fastapi-inertia>=1.0
 Requires-Dist: fastapi>=0.115
 Requires-Dist: httpx>=0.27
 Requires-Dist: jinja2>=3.1
-Requires-Dist: simple-module-core==0.0.1
-Requires-Dist: simple-module-db==0.0.1
+Requires-Dist: simple-module-core==0.0.3
+Requires-Dist: simple-module-db==0.0.3
 Requires-Dist: starlette>=0.44
 Requires-Dist: tomlkit>=0.13
 Requires-Dist: uvicorn[standard]>=0.34
@@ -35,7 +35,7 @@ Description-Content-Type: text/markdown
 
 # simple_module_hosting
 
-FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/antosubash/simple_module_python) framework — builds the app, wires the middleware pipeline, exposes the `sm` / `simple-module` CLI, and ships the project scaffolder.
+FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/antosubash/simple_module_python) framework — builds the app, wires the middleware pipeline, and contributes the `sm host` plugin to the standalone `sm` CLI.
 
 ## Install
 
@@ -43,10 +43,10 @@ FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/ant
 pip install simple_module_hosting
 ```
 
-For a new project, most users run the generator instead:
+For a new project, most users run the generator instead (shipped by the standalone `simple_module_cli` distribution):
 
 ```bash
-uvx simple-module new my-app
+uvx --from simple_module_cli sm new my-app
 ```
 
 ## What it provides
@@ -54,8 +54,7 @@ uvx simple-module new my-app
 - `create_app(settings)` — returns a fully-wired `FastAPI` instance with all discovered modules registered.
 - Middleware pipeline (execution order): CorrelationId → RequestLogging → SecurityHeaders → Session → `<module middleware>` → Tenant (opt-in) → Locale → InertiaLayoutData → app.
 - Inertia wiring — shared props (`auth`, `menus`, `i18n`), `InertiaDep`, page-route lookup.
-- CLI entry points: both `sm` and `simple-module` are installed and alias the same Click tree.
-- Scaffolders — `sm create-host`, `sm create-module`, `sm new` (greenfield app with users + dashboard + permissions pre-wired), `sm gen-pages`.
+- `sm host` plugin — `sm host gen-pages` regenerates the frontend pages manifest; `sm host sync-js-deps` installs JS deps declared by installed modules. The `sm` binary itself comes from `simple_module_cli`.
 
 ## Usage
 
@@ -73,16 +72,13 @@ if __name__ == "__main__":
     uvicorn.run(app, host="0.0.0.0", port=8000)
 ```
 
-CLI:
+CLI (after also installing `simple_module_cli`):
 
 ```bash
-simple-module new my-app        # scaffold a new project
-simple-module doctor            # diagnostic codes (SM001-SM017)
-simple-module gen-pages         # regenerate client_app/modules.generated.ts
+sm host gen-pages               # regenerate client_app/modules.generated.ts
+sm host sync-js-deps            # sync module JS deps into client_app/node_modules
 ```
 
-`sm` works identically to `simple-module`.
-
 ## Depends on
 
 - `simple_module_core`, `simple_module_db`

{simple_module_hosting-0.0.1 → simple_module_hosting-0.0.3}/README.md

@@ -1,6 +1,6 @@
 # simple_module_hosting
 
-FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/antosubash/simple_module_python) framework — builds the app, wires the middleware pipeline, exposes the `sm` / `simple-module` CLI, and ships the project scaffolder.
+FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/antosubash/simple_module_python) framework — builds the app, wires the middleware pipeline, and contributes the `sm host` plugin to the standalone `sm` CLI.
 
 ## Install
 
@@ -8,10 +8,10 @@ FastAPI + Inertia.js host runtime for the [simple_module](https://github.com/ant
 pip install simple_module_hosting
 ```
 
-For a new project, most users run the generator instead:
+For a new project, most users run the generator instead (shipped by the standalone `simple_module_cli` distribution):
 
 ```bash
-uvx simple-module new my-app
+uvx --from simple_module_cli sm new my-app
 ```
 
 ## What it provides
@@ -19,8 +19,7 @@ uvx simple-module new my-app
 - `create_app(settings)` — returns a fully-wired `FastAPI` instance with all discovered modules registered.
 - Middleware pipeline (execution order): CorrelationId → RequestLogging → SecurityHeaders → Session → `<module middleware>` → Tenant (opt-in) → Locale → InertiaLayoutData → app.
 - Inertia wiring — shared props (`auth`, `menus`, `i18n`), `InertiaDep`, page-route lookup.
-- CLI entry points: both `sm` and `simple-module` are installed and alias the same Click tree.
-- Scaffolders — `sm create-host`, `sm create-module`, `sm new` (greenfield app with users + dashboard + permissions pre-wired), `sm gen-pages`.
+- `sm host` plugin — `sm host gen-pages` regenerates the frontend pages manifest; `sm host sync-js-deps` installs JS deps declared by installed modules. The `sm` binary itself comes from `simple_module_cli`.
 
 ## Usage
 
@@ -38,16 +37,13 @@ if __name__ == "__main__":
     uvicorn.run(app, host="0.0.0.0", port=8000)
 ```
 
-CLI:
+CLI (after also installing `simple_module_cli`):
 
 ```bash
-simple-module new my-app        # scaffold a new project
-simple-module doctor            # diagnostic codes (SM001-SM017)
-simple-module gen-pages         # regenerate client_app/modules.generated.ts
+sm host gen-pages               # regenerate client_app/modules.generated.ts
+sm host sync-js-deps            # sync module JS deps into client_app/node_modules
 ```
 
-`sm` works identically to `simple-module`.
-
 ## Depends on
 
 - `simple_module_core`, `simple_module_db`

{simple_module_hosting-0.0.1 → simple_module_hosting-0.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_hosting"
-version = "0.0.1"
+version = "0.0.3"
 description = "FastAPI + Inertia.js host runtime for simple_module — app_builder, middleware stack, CLI (sm / simple-module), scaffolding"
 readme = "README.md"
 license = "MIT"
@@ -26,16 +26,15 @@ dependencies = [
     "fastapi-inertia>=1.0",
     "httpx>=0.27",
     "jinja2>=3.1",
-    "simple_module_core==0.0.1",
-    "simple_module_db==0.0.1",
+    "simple_module_core==0.0.3",
+    "simple_module_db==0.0.3",
     "starlette>=0.44",
     "tomlkit>=0.13",
     "uvicorn[standard]>=0.34",
 ]
 
-[project.scripts]
-sm = "simple_module_hosting.cli:main"
-simple-module = "simple_module_hosting.cli:main"
+[project.entry-points."simple_module_cli.cli_plugins"]
+host = "simple_module_hosting.host_cli:app"
 
 [project.urls]
 Homepage = "https://github.com/antosubash/simple_module_python"

{simple_module_hosting-0.0.1 → simple_module_hosting-0.0.3}/simple_module_hosting/app_builder.py

@@ -69,7 +69,7 @@ def wire_module_routes(app: FastAPI, module) -> None:
     """Attach a module's API + view routers to ``app`` using its Meta prefixes.
 
     The single canonical implementation so ``create_app`` and the test harness
-    in ``simple_module_testing`` stay in lockstep if ``ModuleBase`` ever gains
+    in ``simple_module_test`` stay in lockstep if ``ModuleBase`` ever gains
     a new router type.
     """
     api_router = APIRouter(prefix=module.meta.route_prefix, tags=[module.meta.name])
@@ -131,7 +131,7 @@ def create_app(settings: Settings | None = None) -> FastAPI:
         # Emit frontend module-pages manifest so Vite can find pages shipped
         # inside pip-installed module wheels. See scaffolding.py.
         try:
-            from simple_module_hosting.scaffolding import write_module_pages_manifest
+            from simple_module_hosting.manifest import write_module_pages_manifest
 
             client_app = _PROJECT_ROOT / "host" / "client_app"
             if client_app.is_dir():

simple_module_hosting-0.0.3/simple_module_hosting/host_cli.py

@@ -0,0 +1,117 @@
+"""``sm host`` plugin — project-time helpers exposed through the simple-module CLI.
+
+Commands here need module discovery (``simple_module_core.discover_modules``)
+and the manifest helpers; they're not part of the standalone scaffolder.
+"""
+
+from __future__ import annotations
+
+import logging
+import shutil
+import subprocess
+from pathlib import Path
+from typing import Annotated
+
+import typer
+from simple_module_core import discover_modules
+
+from simple_module_hosting.manifest import (
+    collect_module_js_deps,
+    repo_root_from_client_app,
+    write_module_pages_manifest,
+)
+
+app = typer.Typer(
+    help="Project-time helpers (frontend pages manifest, module JS dep sync).",
+    no_args_is_help=True,
+)
+
+
+@app.command("gen-pages")
+def gen_pages(
+    host_dir: Annotated[
+        Path,
+        typer.Option(
+            "--host-dir",
+            help="Path to the host's client_app directory. Defaults to ./client_app.",
+        ),
+    ] = Path("client_app"),
+) -> None:
+    """Regenerate client_app/modules.{manifest.json,generated.ts,generated.css}."""
+    logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
+    if not host_dir.is_dir():
+        typer.echo(f"ERROR: client_app directory not found at {host_dir}", err=True)
+        raise typer.Exit(code=1)
+    modules = discover_modules()
+    written = write_module_pages_manifest(modules, host_dir)
+    typer.echo(
+        f"Wrote {written['manifest'].name}, {written['generated'].name}, "
+        f"{written['css'].name} to {host_dir}"
+    )
+
+
+@app.command("sync-js-deps")
+def sync_js_deps(
+    host_client_app: Annotated[
+        Path,
+        typer.Option(
+            "--host-client-app",
+            help="Path to host/client_app. Defaults to ./client_app.",
+        ),
+    ] = Path("client_app"),
+    dry_run: Annotated[
+        bool, typer.Option("--dry-run", help="Print the npm install command only.")
+    ] = False,
+) -> None:
+    """Install JS deps declared by installed modules into host's node_modules."""
+    logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
+    if not host_client_app.is_dir():
+        typer.echo(f"ERROR: client_app directory not found at {host_client_app}", err=True)
+        raise typer.Exit(code=1)
+
+    modules = discover_modules()
+    by_module = collect_module_js_deps(modules)
+    if not by_module:
+        typer.echo("No module JS dependencies declared.")
+        return
+
+    specs: list[str] = []
+    for mod_name in sorted(by_module):
+        for dep, rng in sorted(by_module[mod_name].items()):
+            specs.append(f"{dep}@{rng}")
+    deduped: list[str] = []
+    seen: set[str] = set()
+    for spec in specs:
+        if spec not in seen:
+            seen.add(spec)
+            deduped.append(spec)
+
+    npm = shutil.which("npm")
+    if npm is None:
+        typer.echo("ERROR: npm not found on PATH.", err=True)
+        raise typer.Exit(code=1)
+
+    repo_root = repo_root_from_client_app(host_client_app)
+    try:
+        workspace = str(host_client_app.resolve().relative_to(repo_root))
+    except ValueError:
+        workspace = str(host_client_app.resolve())
+
+    cmd = [
+        npm,
+        "install",
+        "--workspace",
+        workspace,
+        "--save=false",
+        "--no-audit",
+        "--no-fund",
+        *deduped,
+    ]
+    typer.echo("Installing module JS deps:")
+    for spec in deduped:
+        typer.echo(f"  {spec}")
+    if dry_run:
+        typer.echo("(dry-run) " + " ".join(cmd))
+        return
+    result = subprocess.run(cmd, cwd=repo_root, check=False)
+    raise typer.Exit(code=result.returncode)

simple_module_hosting-0.0.3/tests/test_host_cli.py

@@ -0,0 +1,28 @@
+"""Smoke tests for the simple_module_hosting host_cli Typer plugin."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from simple_module_hosting.host_cli import app
+from typer.testing import CliRunner
+
+
+def test_app_is_typer_instance() -> None:
+    assert isinstance(app, typer.Typer)
+
+
+def test_help_lists_gen_pages_and_sync_js_deps() -> None:
+    runner = CliRunner()
+    result = runner.invoke(app, ["--help"])
+    assert result.exit_code == 0
+    assert "gen-pages" in result.output
+    assert "sync-js-deps" in result.output
+
+
+def test_gen_pages_errors_on_missing_client_app(tmp_path: Path) -> None:
+    runner = CliRunner()
+    result = runner.invoke(app, ["gen-pages", "--host-dir", str(tmp_path / "does-not-exist")])
+    assert result.exit_code != 0
+    assert "not found" in result.output.lower() or "not found" in (result.stderr or "").lower()

simple_module_hosting-0.0.1/simple_module_hosting/cli.py

@@ -1,292 +0,0 @@
-"""SimpleModule CLI — `sm` console script.
-
-Currently exposes:
-
-* ``sm create-host <name>`` — scaffold a new host directory.
-* ``sm create-module <name>`` — scaffold a new module package.
-* ``sm gen-pages`` — regenerate the frontend pages manifest + Tailwind CSS.
-* ``sm sync-js-deps`` — install JS deps declared by installed modules.
-"""
-
-from __future__ import annotations
-
-import logging
-import shutil
-import subprocess
-import sys
-from pathlib import Path
-
-import click
-from simple_module_core import discover_modules
-
-from simple_module_hosting.scaffolding import (
-    _to_kebab_case,
-    collect_module_js_deps,
-    create_module,
-    repo_root_from_client_app,
-    write_module_pages_manifest,
-)
-from simple_module_hosting.scaffolding import (
-    create_host as _create_host,
-)
-
-
-@click.group()
-def main() -> None:
-    """SimpleModule developer CLI."""
-
-
-@main.command("new")
-@click.argument("name")
-@click.option(
-    "--dest",
-    type=click.Path(file_okay=False, path_type=Path),
-    default=None,
-    help="Destination directory. Defaults to ./<name>.",
-)
-@click.option(
-    "--db",
-    type=click.Choice(["sqlite", "postgres"]),
-    default="sqlite",
-    show_default=True,
-    help="Database backend to configure in .env.example.",
-)
-@click.option(
-    "--tenancy/--no-tenancy",
-    default=False,
-    show_default=True,
-    help="Enable the multi-tenant middleware by default.",
-)
-@click.option(
-    "--yes",
-    "-y",
-    is_flag=True,
-    default=False,
-    help="Skip interactive prompts; accept all defaults.",
-)
-@click.option(
-    "--no-install",
-    is_flag=True,
-    default=False,
-    help="Skip 'uv sync' / 'npm install' / 'alembic upgrade head' after scaffolding.",
-)
-def new_project(
-    name: str,
-    dest: Path | None,
-    db: str,
-    tenancy: bool,
-    yes: bool,
-    no_install: bool,
-) -> None:
-    """Scaffold a new SimpleModule app — pre-wired with users, dashboard, permissions."""
-    target = dest or Path.cwd() / name
-    if not yes:
-        db = click.prompt(
-            "Database backend",
-            default=db,
-            type=click.Choice(["sqlite", "postgres"]),
-        )
-        tenancy = click.confirm("Enable multi-tenancy?", default=tenancy)
-
-    from simple_module_hosting.scaffolding import create_app_project
-
-    try:
-        create_app_project(target, name=name, db=db, tenancy=tenancy)
-    except FileExistsError as exc:
-        click.echo(f"ERROR: {exc}", err=True)
-        sys.exit(1)
-
-    click.echo(f"Created app '{name}' at {target}")
-    click.echo("\nPre-wired modules: users, dashboard, permissions")
-    click.echo("\nNext steps:")
-    click.echo(f"  cd {target}")
-    if no_install:
-        click.echo("  uv sync")
-        click.echo("  npm install")
-        click.echo("  alembic upgrade head")
-        click.echo("  make dev")
-        return
-
-    click.echo("Installing dependencies...")
-    for cmd in (["uv", "sync"], ["npm", "install"]):
-        result = subprocess.run(cmd, cwd=target, check=False)
-        if result.returncode != 0:
-            click.echo(
-                f"WARNING: {' '.join(cmd)} failed (exit {result.returncode}); "
-                f"finish setup manually.",
-                err=True,
-            )
-            return
-
-    subprocess.run(["uv", "run", "alembic", "upgrade", "head"], cwd=target, check=False)
-    click.echo("\nSetup complete. Run `make dev` in the new directory.")
-
-
-@main.command("create-host")
-@click.argument("name")
-@click.option(
-    "--dest",
-    type=click.Path(file_okay=False, path_type=Path),
-    default=None,
-    help="Destination directory. Defaults to ./<name>.",
-)
-@click.option(
-    "--with",
-    "modules",
-    default="",
-    help="Comma-separated module names to declare as deps (e.g. --with=Auth,Products).",
-)
-def create_host(name: str, dest: Path | None, modules: str) -> None:
-    """Scaffold a new SimpleModule host project at ./<NAME>."""
-    target = dest or Path.cwd() / name
-    selected = [m.strip() for m in modules.split(",") if m.strip()]
-
-    try:
-        _create_host(target, name=name, modules=selected)
-    except FileExistsError as exc:
-        click.echo(f"ERROR: {exc}", err=True)
-        sys.exit(1)
-
-    click.echo(f"Created host '{name}' at {target}")
-    if selected:
-        click.echo(f"Declared modules: {', '.join(selected)}")
-    click.echo("\nNext steps:")
-    click.echo(f"  cd {target}")
-    click.echo("  uv sync")
-    click.echo("  cp .env.example .env")
-    click.echo('  alembic revision --autogenerate -m "initial schema"')
-    click.echo("  alembic upgrade head")
-    click.echo("  python main.py")
-
-
-@main.command("create-module")
-@click.argument("name")
-@click.option(
-    "--dest",
-    type=click.Path(file_okay=False, path_type=Path),
-    default=None,
-    help="Destination directory. Defaults to ./simple_module_<package>.",
-)
-def create_module_cmd(name: str, dest: Path | None) -> None:
-    """Scaffold a publishable SimpleModule module package."""
-    slug = _to_kebab_case(name)
-    package = slug.replace("-", "_")
-    target = dest or Path.cwd() / f"simple_module_{package}"
-
-    try:
-        create_module(target, name=name)
-    except FileExistsError as exc:
-        click.echo(f"ERROR: {exc}", err=True)
-        sys.exit(1)
-
-    click.echo(f"Created module 'simple_module_{package}' at {target}")
-    click.echo("\nNext steps:")
-    click.echo(f"  cd {target}")
-    click.echo("  uv sync --extra dev")
-    click.echo("  uv run pytest")
-
-
-@main.command("gen-pages")
-@click.option(
-    "--host-dir",
-    type=click.Path(file_okay=False, exists=True, path_type=Path),
-    default=None,
-    help="Path to the host's client_app directory. Defaults to ./client_app.",
-)
-def gen_pages(host_dir: Path | None) -> None:
-    """Regenerate client_app/modules.{manifest.json,generated.ts,generated.css}."""
-    logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
-    output = host_dir or Path.cwd() / "client_app"
-    if not output.is_dir():
-        click.echo(f"ERROR: client_app directory not found at {output}", err=True)
-        sys.exit(1)
-
-    modules = discover_modules()
-    written = write_module_pages_manifest(modules, output)
-    click.echo(
-        f"Wrote {written['manifest'].name}, {written['generated'].name}, "
-        f"{written['css'].name} to {output}"
-    )
-
-
-@main.command("sync-js-deps")
-@click.option(
-    "--host-client-app",
-    type=click.Path(file_okay=False, exists=True, path_type=Path),
-    default=None,
-    help="Path to host/client_app. Defaults to ./client_app.",
-)
-@click.option(
-    "--dry-run",
-    is_flag=True,
-    default=False,
-    help="Print the npm install command without running it.",
-)
-def sync_js_deps(host_client_app: Path | None, dry_run: bool) -> None:
-    """Install JS deps declared by installed modules into host's node_modules.
-
-    Walks every discovered module, reads its package.json, and runs a single
-    ``npm install --workspace host/client_app --save=false <specs>``. Use
-    this after ``pip install``-ing a module wheel that declares JS deps;
-    in-repo modules already flow through npm workspaces and need nothing.
-    """
-    logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s")
-
-    output = host_client_app or Path.cwd() / "client_app"
-    if not output.is_dir():
-        click.echo(f"ERROR: client_app directory not found at {output}", err=True)
-        sys.exit(1)
-
-    modules = discover_modules()
-    by_module = collect_module_js_deps(modules)
-    if not by_module:
-        click.echo("No module JS dependencies declared.")
-        return
-
-    # Flatten into a single spec list. npm's own resolver handles conflicts.
-    specs: list[str] = []
-    for mod_name in sorted(by_module):
-        for dep, rng in sorted(by_module[mod_name].items()):
-            specs.append(f"{dep}@{rng}")
-    # Dedupe while preserving first-seen order.
-    deduped: list[str] = []
-    seen: set[str] = set()
-    for spec in specs:
-        if spec not in seen:
-            seen.add(spec)
-            deduped.append(spec)
-
-    npm = shutil.which("npm")
-    if npm is None:
-        click.echo("ERROR: npm not found on PATH.", err=True)
-        sys.exit(1)
-
-    # Workspace path is relative to the repo root — derive it from output.
-    repo_root = repo_root_from_client_app(output)
-    try:
-        workspace = str(output.resolve().relative_to(repo_root))
-    except ValueError:
-        workspace = str(output.resolve())
-
-    cmd = [
-        npm,
-        "install",
-        "--workspace",
-        workspace,
-        "--save=false",
-        "--no-audit",
-        "--no-fund",
-        *deduped,
-    ]
-    click.echo("Installing module JS deps:")
-    for spec in deduped:
-        click.echo(f"  {spec}")
-    if dry_run:
-        click.echo("(dry-run) " + " ".join(cmd))
-        return
-    result = subprocess.run(cmd, cwd=repo_root, check=False)
-    sys.exit(result.returncode)
-
-
-if __name__ == "__main__":
-    main()