simple-module-cli 0.0.6__tar.gz → 0.0.8__tar.gz

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simple_module_cli
-Version: 0.0.6
+Version: 0.0.8
 Summary: Standalone scaffolder for the SimpleModule framework — `sm new`, `sm create-module`, plugin host.
 Project-URL: Homepage, https://github.com/antosubash/simple_module_python
 Project-URL: Repository, https://github.com/antosubash/simple_module_python

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simple_module_cli"
-version = "0.0.6"
+version = "0.0.8"
 description = "Standalone scaffolder for the SimpleModule framework — `sm new`, `sm create-module`, plugin host."
 readme = "README.md"
 license = "MIT"

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/simple_module_cli/app_project.py

@@ -18,15 +18,19 @@ from collections.abc import Sequence
 from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version as _pkg_version
 from pathlib import Path
+from typing import Any
 
 from simple_module_cli._env import set_env_key
 from simple_module_cli.case import to_kebab_case, to_pascal_case
 from simple_module_cli.catalog import CATALOG, PRESETS, expand_deps
 from simple_module_cli.recipes import RECIPES, ScaffoldCtx
-from simple_module_cli.scaffolding import create_host
+from simple_module_cli.scaffolding import _module_to_pypi_name, create_host, create_module
 
 __all__ = ["create_app_project"]
 
+_SAMPLE_MODULE_NAME = "hello"
+_SAMPLE_MODULE_PKG = _module_to_pypi_name(_SAMPLE_MODULE_NAME)
+
 
 def _resolve_framework_version() -> str:
     """Resolve the framework version to pin scaffolded apps against.
@@ -69,6 +73,7 @@ def create_app_project(
     db: str = "sqlite",
     tenancy: bool = False,
     selected: Sequence[str] | None = None,
+    flat: bool = False,
 ) -> None:
     """Greenfield ``simple-module new`` scaffold.
 
@@ -101,19 +106,26 @@ def create_app_project(
     env_text = set_env_key(env_text, "SM_MULTI_TENANT", "true" if tenancy else "false")
     env_path.write_text(env_text, encoding="utf-8")
 
+    if not flat:
+        _scaffold_sample_module(target)
+        py_deps.append(_SAMPLE_MODULE_PKG)
+
     pyproject = target / "pyproject.toml"
     if pyproject.exists():
         text = pyproject.read_text(encoding="utf-8")
-        text = _inject_py_deps(text, py_deps, _APP_PY_DEV_DEPS)
+        text = _rewrite_pyproject(text, py_deps, _APP_PY_DEV_DEPS, flat=flat)
         pyproject.write_text(text, encoding="utf-8")
 
     pkg_path = target / "package.json"
+    data: dict[str, Any]
     if pkg_path.exists():
         data = _json.loads(pkg_path.read_text(encoding="utf-8"))
     else:
         data = {"name": to_kebab_case(name), "private": True, "type": "module"}
     data.setdefault("dependencies", {}).update(_APP_NPM_DEPS)
     data.setdefault("devDependencies", {}).update(_APP_NPM_DEV_DEPS)
+    if not flat:
+        data["workspaces"] = ["client_app", "modules/*"]
     pkg_path.write_text(_json.dumps(data, indent=2) + "\n", encoding="utf-8")
 
     ctx = ScaffoldCtx(name=name, db=db, tenancy=tenancy, selected=tuple(resolved))
@@ -123,14 +135,32 @@ def create_app_project(
             RECIPES[recipe_key].apply(target, ctx)
 
 
+def _scaffold_sample_module(target: Path) -> None:
+    """Give the user a place to copy when they want to add a feature module.
+
+    The alternative is reverse-engineering one of the wheel-installed
+    framework modules from ``.venv/site-packages/``.
+    """
+    sample_dest = target / "modules" / _SAMPLE_MODULE_NAME
+    if sample_dest.exists():
+        return
+    create_module(sample_dest, name=_SAMPLE_MODULE_NAME)
+
+
 def _db_url(db: str, slug: str) -> str:
     if db == "postgres":
         return f"postgresql+asyncpg://postgres:postgres@localhost:5432/{slug}"
     return "sqlite+aiosqlite:///./app.db"
 
 
-def _inject_py_deps(text: str, deps: list[str], dev_deps: list[str]) -> str:
-    """Replace project.dependencies + dependency-groups.dev in a pyproject.toml."""
+def _rewrite_pyproject(text: str, deps: list[str], dev_deps: list[str], *, flat: bool) -> str:
+    """Replace deps + wire uv workspace based on ``flat`` mode.
+
+    Workspace mode (``flat=False``) adds a ``[tool.uv.sources]`` entry so uv
+    resolves the bundled sample module from the workspace, not PyPI. Flat
+    mode strips the static ``[tool.uv.workspace]`` block inherited from the
+    template — there is no ``modules/`` tree for it to point at.
+    """
     import tomlkit
 
     doc = tomlkit.parse(text)
@@ -138,4 +168,12 @@ def _inject_py_deps(text: str, deps: list[str], dev_deps: list[str]) -> str:
     project["dependencies"] = list(deps)
     groups = doc.setdefault("dependency-groups", tomlkit.table())
     groups["dev"] = list(dev_deps)
+    tool = doc.setdefault("tool", tomlkit.table())
+    uv_table = tool.setdefault("uv", tomlkit.table())
+    if flat:
+        if "workspace" in uv_table:
+            del uv_table["workspace"]
+    else:
+        sources = uv_table.setdefault("sources", tomlkit.table())
+        sources[_SAMPLE_MODULE_PKG] = {"workspace": True}
     return tomlkit.dumps(doc)

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/simple_module_cli/new.py

@@ -64,6 +64,16 @@ def new_project(
             help="Skip 'uv sync' / 'npm install' / 'alembic upgrade head' after scaffolding.",
         ),
     ] = False,
+    flat: Annotated[
+        bool,
+        typer.Option(
+            "--flat",
+            help=(
+                "Skip the modules/ directory and sample module. Use when the host "
+                "will only consume published modules and never author its own."
+            ),
+        ),
+    ] = False,
 ) -> None:
     """Scaffold a new SimpleModule app, optionally with background jobs."""
     target = dest or Path.cwd() / name
@@ -90,7 +100,14 @@ def new_project(
             raise typer.Exit(code=1) from None
 
     try:
-        create_app_project(target, name=name, db=db_final, tenancy=tenancy_final, selected=resolved)
+        create_app_project(
+            target,
+            name=name,
+            db=db_final,
+            tenancy=tenancy_final,
+            selected=resolved,
+            flat=flat,
+        )
     except FileExistsError as exc:
         typer.echo(f"ERROR: {exc}", err=True)
         raise typer.Exit(code=1) from exc

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/simple_module_cli/scaffolding.py

@@ -117,6 +117,7 @@ def create_module(
             "{{MODULE_NAME}}": display_name,
             "{{MODULE_SLUG}}": slug,
             "{{PACKAGE_NAME}}": package_name,
+            "{{PACKAGE_NAME_UPPER}}": package_name.upper(),
         },
         path_rewrites={_PACKAGE_PATH_TOKEN: package_name},
     )

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/simple_module_cli/templates/host/Makefile

@@ -1,8 +1,9 @@
-.PHONY: install dev dev-api dev-ui build migrate gen-pages
+.PHONY: install dev dev-api dev-ui build migrate gen-pages sync-js-deps
 
 install:
 	uv sync
 	cd client_app && npm install
+	$(MAKE) sync-js-deps
 
 dev: gen-pages
 	@echo "Starting API and UI dev servers..."
@@ -21,4 +22,7 @@ migrate:
 	uv run alembic upgrade head
 
 gen-pages:
-	uv run sm gen-pages --host-dir=client_app
+	uv run python -m simple_module_hosting gen-pages --host-dir=client_app
+
+sync-js-deps:
+	uv run python -m simple_module_hosting sync-js-deps --host-client-app=client_app

simple_module_cli-0.0.8/simple_module_cli/templates/host/pyproject.toml.tpl

@@ -0,0 +1,24 @@
+[project]
+name = "{{HOST_NAME}}"
+version = "0.1.0"
+description = "SimpleModule host application"
+requires-python = ">=3.12"
+dependencies = [
+    "simple_module_core>=1.0,<2.0",
+    "simple_module_db>=1.0,<2.0",
+    "simple_module_hosting>=1.0,<2.0",
+    "simple_module_settings>=1.0,<2.0",
+    "alembic>=1.13",
+    "uvicorn[standard]>=0.34",
+{{MODULE_DEPS}}
+]
+
+# Host is an application, not a distributable package.
+[tool.uv]
+package = false
+
+# Add a new module with `sm create-module <name>`, then add
+# `simple_module_<name>` to the dependency list above and to
+# [tool.uv.sources] as `{ workspace = true }`.
+[tool.uv.workspace]
+members = ["modules/*"]

simple_module_cli-0.0.8/simple_module_cli/templates/module/__PACKAGE__/settings.py.tpl

@@ -0,0 +1,14 @@
+"""{{MODULE_NAME}} module settings.
+
+Per-module env-var prefix is ``SM_{{PACKAGE_NAME_UPPER}}_*``. Add fields here
+as the module grows; the framework wires them onto
+``app.state.{{PACKAGE_NAME}}`` via ``register_settings``.
+"""
+
+from __future__ import annotations
+
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+
+class {{MODULE_NAME}}Settings(BaseSettings):
+    model_config = SettingsConfigDict(env_prefix="SM_{{PACKAGE_NAME_UPPER}}_", extra="ignore")

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/simple_module_cli/templates/module/pyproject.toml.tpl

@@ -7,6 +7,7 @@ dependencies = [
     "simple_module_core>=1.0,<2.0",
     "simple_module_db>=1.0,<2.0",
     "simple_module_hosting>=1.0,<2.0",
+    "pydantic-settings>=2.0",
     "sqlalchemy>=2.0",
 ]
 

{simple_module_cli-0.0.6 → simple_module_cli-0.0.8}/tests/test_cli_new.py

@@ -196,6 +196,66 @@ def test_sm_new_interactive_full_preset(tmp_path: Path) -> None:
     assert (target / "docker-compose.yml").is_file()
 
 
+def test_sm_new_default_scaffolds_sample_hello_module(tmp_path: Path) -> None:
+    """Default (workspace) mode lays down modules/hello/ as an authoring template."""
+    runner = CliRunner()
+    target = tmp_path / "demo"
+    result = runner.invoke(
+        app,
+        ["new", "demo", "--yes", "--db", "sqlite", "--no-install", "--dest", str(target)],
+    )
+    assert result.exit_code == 0, result.output
+    assert (target / "modules" / "hello" / "pyproject.toml").is_file()
+    assert (target / "modules" / "hello" / "hello" / "module.py").is_file()
+
+
+def test_sm_new_default_wires_workspace_in_pyproject(tmp_path: Path) -> None:
+    """Default mode adds [tool.uv.workspace] members + a workspace source for the sample."""
+    runner = CliRunner()
+    target = tmp_path / "demo"
+    runner.invoke(
+        app,
+        ["new", "demo", "--yes", "--db", "sqlite", "--no-install", "--dest", str(target)],
+    )
+    pyproject_text = (target / "pyproject.toml").read_text()
+    assert "[tool.uv.workspace]" in pyproject_text
+    assert 'members = ["modules/*"]' in pyproject_text
+    assert "simple_module_hello" in pyproject_text
+    # Sample module is a workspace source, not pulled from PyPI.
+    assert "[tool.uv.sources" in pyproject_text
+    assert "workspace = true" in pyproject_text
+
+
+def test_sm_new_default_adds_npm_workspaces_field(tmp_path: Path) -> None:
+    """Default mode declares ``workspaces`` so vite picks up modules/<name>/."""
+    runner = CliRunner()
+    target = tmp_path / "demo"
+    runner.invoke(
+        app,
+        ["new", "demo", "--yes", "--db", "sqlite", "--no-install", "--dest", str(target)],
+    )
+    data = json.loads((target / "package.json").read_text())
+    assert data.get("workspaces") == ["client_app", "modules/*"]
+
+
+def test_sm_new_flat_skips_modules_dir(tmp_path: Path) -> None:
+    """``--flat`` keeps the legacy single-host layout: no modules/ tree, no sample."""
+    runner = CliRunner()
+    target = tmp_path / "demo"
+    result = runner.invoke(
+        app,
+        ["new", "demo", "--yes", "--flat", "--no-install", "--dest", str(target)],
+    )
+    assert result.exit_code == 0, result.output
+    assert not (target / "modules").exists()
+    pyproject_text = (target / "pyproject.toml").read_text()
+    assert "simple_module_hello" not in pyproject_text
+    # No workspace plumbing pointing at a non-existent modules/ tree.
+    assert "[tool.uv.workspace]" not in pyproject_text
+    data = json.loads((target / "package.json").read_text())
+    assert "workspaces" not in data
+
+
 def test_sm_new_refuses_to_overwrite(tmp_path: Path) -> None:
     target = tmp_path / "my-app"
     target.mkdir()

simple_module_cli-0.0.6/simple_module_cli/templates/host/pyproject.toml.tpl

@@ -1,17 +0,0 @@
-[project]
-name = "{{HOST_NAME}}"
-version = "0.1.0"
-description = "SimpleModule host application"
-requires-python = ">=3.12"
-dependencies = [
-    "simple_module_core>=1.0,<2.0",
-    "simple_module_db>=1.0,<2.0",
-    "simple_module_hosting>=1.0,<2.0",
-    "alembic>=1.13",
-    "uvicorn[standard]>=0.34",
-{{MODULE_DEPS}}
-]
-
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"