simple-module-cli 0.0.2__tar.gz

simple_module_cli-0.0.2/.gitignore

@@ -0,0 +1,59 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.venv/
+*.egg
+
+# UV
+uv.lock
+
+# Node
+node_modules/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Environment
+.env
+
+# Database
+*.db
+*.sqlite3
+
+# Module-managed runtime state (e.g. uploaded dataset files,
+# default storage_dir for SM_DATASETS_STORAGE_DIR).
+var/
+
+# file_storage filesystem backend default root (override via SM_FILE_STORAGE_FS_ROOT_PATH).
+uploads/
+
+# Vite
+host/static/dist/
+
+# Auto-generated frontend module manifest (regenerated by the host at boot
+# or via `make gen-pages`).
+host/client_app/modules.manifest.json
+host/client_app/modules.generated.ts
+host/client_app/modules.generated.css
+
+# Worktrees
+.worktrees/
+
+# Performance profiles
+.memray/
+.benchmarks/
+
+# OS
+.DS_Store
+Thumbs.db
+
+.playwright-cli/*
+.playwright-mcp/*
+host/client_app/.playwright-cli/*
+.superpowers/

simple_module_cli-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Anto Subash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

simple_module_cli-0.0.2/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: simple_module_cli
+Version: 0.0.2
+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
+Project-URL: Issues, https://github.com/antosubash/simple_module_python/issues
+Author-email: Anto Subash <antosubash@live.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,fastapi,modular-monolith,scaffolding,simple-module
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: tomlkit>=0.13
+Requires-Dist: typer>=0.12
+Description-Content-Type: text/markdown
+
+# simple_module_cli
+
+Standalone scaffolder for the [SimpleModule framework](https://github.com/antosubash/simple_module_python).
+
+## Install
+
+```bash
+pip install simple_module_cli
+# or, to keep the CLI in its own venv:
+pipx install simple_module_cli
+# or, to run it without installing:
+uvx --from simple_module_cli sm new my-app
+```
+
+The package depends only on `typer` and `tomlkit` — installing it does **not** pull in FastAPI, SQLModel, or any other framework runtime.
+
+## Usage
+
+```bash
+sm new my-app                       # interactive wizard
+sm new my-app --yes --preset full   # all built-in modules + background jobs
+sm create-module my_feature         # scaffold a publishable module package
+sm create-host bare-host            # scaffold a bare host (no opinionated wiring)
+```
+
+Built-in commands: `sm new`, `sm create-host`, `sm create-module`.
+
+When other framework packages are installed, they contribute additional subcommands via the `simple_module_cli.cli_plugins` entry-point group:
+
+| Package | Commands |
+|---|---|
+| `simple_module_hosting` | `sm host gen-pages`, `sm host sync-js-deps` |
+| `simple_module_users`   | `sm users create-admin` |
+| `simple_module_settings` | `sm settings import-from-env` |
+
+## License
+
+MIT — see [LICENSE](LICENSE).

simple_module_cli-0.0.2/README.md

@@ -0,0 +1,38 @@
+# simple_module_cli
+
+Standalone scaffolder for the [SimpleModule framework](https://github.com/antosubash/simple_module_python).
+
+## Install
+
+```bash
+pip install simple_module_cli
+# or, to keep the CLI in its own venv:
+pipx install simple_module_cli
+# or, to run it without installing:
+uvx --from simple_module_cli sm new my-app
+```
+
+The package depends only on `typer` and `tomlkit` — installing it does **not** pull in FastAPI, SQLModel, or any other framework runtime.
+
+## Usage
+
+```bash
+sm new my-app                       # interactive wizard
+sm new my-app --yes --preset full   # all built-in modules + background jobs
+sm create-module my_feature         # scaffold a publishable module package
+sm create-host bare-host            # scaffold a bare host (no opinionated wiring)
+```
+
+Built-in commands: `sm new`, `sm create-host`, `sm create-module`.
+
+When other framework packages are installed, they contribute additional subcommands via the `simple_module_cli.cli_plugins` entry-point group:
+
+| Package | Commands |
+|---|---|
+| `simple_module_hosting` | `sm host gen-pages`, `sm host sync-js-deps` |
+| `simple_module_users`   | `sm users create-admin` |
+| `simple_module_settings` | `sm settings import-from-env` |
+
+## License
+
+MIT — see [LICENSE](LICENSE).

simple_module_cli-0.0.2/pyproject.toml

@@ -0,0 +1,44 @@
+[project]
+name = "simple_module_cli"
+version = "0.0.2"
+description = "Standalone scaffolder for the SimpleModule framework — `sm new`, `sm create-module`, plugin host."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+authors = [{ name = "Anto Subash", email = "antosubash@live.com" }]
+keywords = ["simple-module", "scaffolding", "cli", "fastapi", "modular-monolith"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Code Generators",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+dependencies = [
+    "typer>=0.12",
+    "tomlkit>=0.13",
+]
+
+[project.scripts]
+sm = "simple_module_cli.cli:main"
+simple-module = "simple_module_cli.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/antosubash/simple_module_python"
+Repository = "https://github.com/antosubash/simple_module_python"
+Issues = "https://github.com/antosubash/simple_module_python/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["simple_module_cli"]
+
+[tool.hatch.build.targets.wheel.shared-data]
+"simple_module_cli/templates" = "simple_module_cli/templates"

simple_module_cli-0.0.2/simple_module_cli/_env.py

@@ -0,0 +1,12 @@
+"""Shared helpers for editing dotenv-style files at scaffold time."""
+
+from __future__ import annotations
+
+__all__ = ["set_env_key"]
+
+
+def set_env_key(text: str, key: str, value: str) -> str:
+    """Replace or append ``KEY=VALUE`` in an env-style file body."""
+    lines = [ln for ln in text.splitlines() if not ln.startswith(f"{key}=")]
+    lines.append(f"{key}={value}")
+    return "\n".join(lines) + "\n"

simple_module_cli-0.0.2/simple_module_cli/app_project.py

@@ -0,0 +1,123 @@
+"""Greenfield ``simple-module new`` scaffolding.
+
+Wraps :func:`simple_module_hosting.scaffolding.create_host` with the
+opinionated bits — module-list resolution from the CLI catalog, secret
+generation, DB URL selection, ``pyproject.toml`` / ``package.json``
+rewriting, and post-scaffold recipe application.
+
+Lives in its own module to keep ``scaffolding.py`` under the per-file
+line cap and to make the surface area of "host scaffold" vs "app
+scaffold" obvious to readers.
+"""
+
+from __future__ import annotations
+
+import json as _json
+import secrets as _secrets
+from collections.abc import Sequence
+from pathlib import Path
+
+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
+
+__all__ = ["create_app_project"]
+
+_FRAMEWORK_VERSION = "0.0.1"
+
+_APP_PY_DEV_DEPS = [f"simple_module_test=={_FRAMEWORK_VERSION}", "pytest>=8.0"]
+
+_APP_NPM_DEPS = {
+    "@simple-module-py/ui": _FRAMEWORK_VERSION,
+    "@simple-module-py/i18n": _FRAMEWORK_VERSION,
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@inertiajs/react": "^1.0.0",
+}
+_APP_NPM_DEV_DEPS = {
+    "@simple-module-py/tsconfig": _FRAMEWORK_VERSION,
+    "@vitejs/plugin-react": "^5.0.0",
+    "typescript": "^5.6.0",
+    "vite": "^8.0.0",
+}
+
+
+def create_app_project(
+    target: Path,
+    *,
+    name: str,
+    db: str = "sqlite",
+    tenancy: bool = False,
+    selected: Sequence[str] | None = None,
+) -> None:
+    """Greenfield ``simple-module new`` scaffold.
+
+    Wraps :func:`create_host` with a chosen module list (defaults to the
+    ``standard`` preset), generates a secret, picks a DB URL, rewrites
+    the generated ``package.json`` / ``pyproject.toml`` to pin exact
+    framework versions, and applies any matching post-scaffold recipes
+    (e.g. the ``background_tasks`` recipe drops a Celery worker stack).
+    """
+    if target.exists() and any(target.iterdir()):
+        raise FileExistsError(
+            f"Destination {target} already exists and is non-empty; "
+            "choose a new path or remove its contents first."
+        )
+
+    chosen = list(selected) if selected is not None else list(PRESETS["standard"])
+    resolved, _added = expand_deps(chosen)
+
+    display_names = [to_pascal_case(CATALOG[m].display) for m in resolved]
+    create_host(target, name=name, modules=display_names)
+
+    py_deps = [f"simple_module_hosting=={_FRAMEWORK_VERSION}"] + [
+        f"{CATALOG[m].package}=={_FRAMEWORK_VERSION}" for m in resolved
+    ]
+
+    env_path = target / ".env.example"
+    env_text = env_path.read_text(encoding="utf-8") if env_path.exists() else ""
+    env_text = set_env_key(env_text, "SM_SECRET_KEY", _secrets.token_urlsafe(32))
+    env_text = set_env_key(env_text, "SM_DATABASE_URL", _db_url(db, to_kebab_case(name)))
+    env_text = set_env_key(env_text, "SM_MULTI_TENANT", "true" if tenancy else "false")
+    env_path.write_text(env_text, encoding="utf-8")
+
+    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)
+        pyproject.write_text(text, encoding="utf-8")
+
+    pkg_path = target / "package.json"
+    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)
+    pkg_path.write_text(_json.dumps(data, indent=2) + "\n", encoding="utf-8")
+
+    ctx = ScaffoldCtx(name=name, db=db, tenancy=tenancy, selected=tuple(resolved))
+    for mod_name in resolved:
+        recipe_key = CATALOG[mod_name].recipe
+        if recipe_key is not None and recipe_key in RECIPES:
+            RECIPES[recipe_key].apply(target, ctx)
+
+
+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."""
+    import tomlkit
+
+    doc = tomlkit.parse(text)
+    project = doc.setdefault("project", tomlkit.table())
+    project["dependencies"] = list(deps)
+    groups = doc.setdefault("dependency-groups", tomlkit.table())
+    groups["dev"] = list(dev_deps)
+    return tomlkit.dumps(doc)

simple_module_cli-0.0.2/simple_module_cli/case.py

@@ -0,0 +1,30 @@
+"""Identifier case-conversion helpers used by every scaffolder.
+
+Module/host names are accepted in any case style and normalized to the
+three forms the templates need: snake_case (Python package + entry-point
+key), kebab-case (PyPI slug), and PascalCase (display name in Meta).
+"""
+
+from __future__ import annotations
+
+import re
+
+__all__ = ["to_kebab_case", "to_pascal_case", "to_snake_case"]
+
+
+def to_snake_case(name: str) -> str:
+    """'MyFeature' / 'my-feature' / 'My Feature' -> 'my_feature'."""
+    s = re.sub(r"(?<!^)(?=[A-Z])", "_", name)
+    s = re.sub(r"[\s\-]+", "_", s)
+    return s.lower()
+
+
+def to_kebab_case(name: str) -> str:
+    """'MyFeature' / 'my_feature' -> 'my-feature' (used as the PyPI slug)."""
+    return to_snake_case(name).replace("_", "-")
+
+
+def to_pascal_case(name: str) -> str:
+    """'my-feature' / 'my_feature' -> 'MyFeature' (the display name in Meta)."""
+    snake = to_snake_case(name)
+    return "".join(part.capitalize() for part in snake.split("_") if part)

simple_module_cli-0.0.2/simple_module_cli/catalog.py

@@ -0,0 +1,107 @@
+"""Hardcoded catalog of installable SimpleModule modules.
+
+Each :class:`ModuleEntry` declares the PyPI package name, a human display
+name, transitive ``requires`` (other catalog keys), and an optional
+``recipe`` key for post-scaffold actions handled by :mod:`.recipes`.
+
+:func:`expand_deps` takes a user-selected subset and returns a
+topologically ordered superset including every transitive requirement,
+plus the list of ``(added, required_by)`` pairs for printing back to the
+user.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterable
+from dataclasses import dataclass, field
+
+__all__ = ["CATALOG", "PRESETS", "ModuleEntry", "expand_deps"]
+
+
+@dataclass(frozen=True)
+class ModuleEntry:
+    name: str
+    package: str
+    display: str
+    requires: tuple[str, ...] = field(default_factory=tuple)
+    recipe: str | None = None
+
+
+CATALOG: dict[str, ModuleEntry] = {
+    "auth": ModuleEntry("auth", "simple_module_auth", "Auth"),
+    "users": ModuleEntry("users", "simple_module_users", "Users", requires=("auth",)),
+    "permissions": ModuleEntry(
+        "permissions",
+        "simple_module_permissions",
+        "Permissions",
+        requires=("auth", "users"),
+    ),
+    "products": ModuleEntry("products", "simple_module_products", "Products"),
+    "dashboard": ModuleEntry(
+        "dashboard",
+        "simple_module_dashboard",
+        "Dashboard",
+        requires=("users", "products"),
+    ),
+    "settings": ModuleEntry("settings", "simple_module_settings", "Settings"),
+    "feature_flags": ModuleEntry("feature_flags", "simple_module_feature_flags", "Feature Flags"),
+    "file_storage": ModuleEntry(
+        "file_storage",
+        "simple_module_file_storage",
+        "File Storage",
+        requires=("settings",),
+    ),
+    "background_tasks": ModuleEntry(
+        "background_tasks",
+        "simple_module_background_tasks",
+        "Background Tasks",
+        requires=("users",),
+        recipe="background_tasks",
+    ),
+    "datasets": ModuleEntry(
+        "datasets",
+        "simple_module_datasets",
+        "Datasets",
+        requires=("file_storage", "background_tasks"),
+    ),
+}
+
+
+PRESETS: dict[str, tuple[str, ...]] = {
+    "minimal": ("users",),
+    "standard": ("users", "dashboard", "permissions"),
+    "full": tuple(CATALOG),
+}
+
+
+def expand_deps(selected: Iterable[str]) -> tuple[list[str], list[tuple[str, str]]]:
+    """Return ``(topo-ordered resolved list, [(added, required_by), ...])``.
+
+    Raises :class:`KeyError` if any input name is missing from the
+    catalog. The error message lists the available catalog keys so a
+    user typo (`--with=does_not_exist`) is self-correcting.
+    """
+    selected_list = list(selected)
+    for name in selected_list:
+        if name not in CATALOG:
+            available = ", ".join(sorted(CATALOG))
+            raise KeyError(f"unknown module: {name!r}; available: {available}")
+
+    explicit = set(selected_list)
+    resolved: list[str] = []
+    in_resolved: set[str] = set()
+    added: list[tuple[str, str]] = []
+
+    def _visit(name: str, required_by: str | None) -> None:
+        if name in in_resolved:
+            return
+        for dep in CATALOG[name].requires:
+            _visit(dep, required_by=name)
+        resolved.append(name)
+        in_resolved.add(name)
+        if required_by is not None and name not in explicit:
+            added.append((name, required_by))
+
+    for name in selected_list:
+        _visit(name, required_by=None)
+    return resolved, added

simple_module_cli-0.0.2/simple_module_cli/cli.py

@@ -0,0 +1,104 @@
+"""Root `sm` Typer app — scaffolders + plugin mount.
+
+Built-in commands:
+  sm new
+  sm create-host
+  sm create-module
+
+Plugins discovered via the ``simple_module_cli.cli_plugins`` entry-point
+group are mounted as named subgroups (e.g. ``sm host gen-pages``).
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Annotated
+
+import typer
+
+from simple_module_cli.case import to_kebab_case
+from simple_module_cli.new import new_project
+from simple_module_cli.plugins import discover_and_mount
+from simple_module_cli.scaffolding import create_host as _create_host
+from simple_module_cli.scaffolding import create_module as _create_module
+
+app = typer.Typer(
+    help="SimpleModule developer CLI.",
+    no_args_is_help=True,
+    add_completion=False,
+)
+
+app.command("new")(new_project)
+
+
+@app.command("create-host")
+def create_host(
+    name: Annotated[str, typer.Argument(help="Host project name.")],
+    dest: Annotated[
+        Path | None,
+        typer.Option("--dest", help="Destination directory. Defaults to ./<name>."),
+    ] = None,
+    modules: Annotated[
+        str,
+        typer.Option(
+            "--with",
+            help="Comma-separated module names to declare as deps (e.g. Auth,Products).",
+        ),
+    ] = "",
+) -> 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:
+        typer.echo(f"ERROR: {exc}", err=True)
+        raise typer.Exit(code=1) from exc
+
+    typer.echo(f"Created host '{name}' at {target}")
+    if selected:
+        typer.echo(f"Declared modules: {', '.join(selected)}")
+    typer.echo("\nNext steps:")
+    typer.echo(f"  cd {target}")
+    typer.echo("  uv sync")
+    typer.echo("  cp .env.example .env")
+    typer.echo('  alembic revision --autogenerate -m "initial schema"')
+    typer.echo("  alembic upgrade head")
+    typer.echo("  python main.py")
+
+
+@app.command("create-module")
+def create_module(
+    name: Annotated[str, typer.Argument(help="Module name (any case).")],
+    dest: Annotated[
+        Path | None,
+        typer.Option("--dest", help="Destination dir. Defaults to ./simple_module_<name>."),
+    ] = 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:
+        typer.echo(f"ERROR: {exc}", err=True)
+        raise typer.Exit(code=1) from exc
+
+    typer.echo(f"Created module 'simple_module_{package}' at {target}")
+    typer.echo("\nNext steps:")
+    typer.echo(f"  cd {target}")
+    typer.echo("  uv sync --extra dev")
+    typer.echo("  uv run pytest")
+
+
+discover_and_mount(app)
+
+
+def main() -> None:
+    """Entry point for the `sm` console script."""
+    app()
+
+
+if __name__ == "__main__":
+    main()