simple-module-cli 0.0.2__py3-none-any.whl

simple_module_cli/scaffolding.py

@@ -0,0 +1,124 @@
+"""Host + module scaffolding via package-data templates.
+
+* :func:`create_host` materializes a new host project from the templates
+  under ``simple_module/templates/host/``.
+* :func:`create_module` materializes a new module package from
+  ``simple_module/templates/module/``.
+
+The frontend pages manifest + per-module JS dep discovery live in
+:mod:`simple_module_hosting.manifest` (those need module-discovery and
+stay in hosting).
+"""
+
+from __future__ import annotations
+
+import importlib.resources
+import logging
+import shutil
+from collections.abc import Mapping, Sequence
+from pathlib import Path
+
+from simple_module_cli.case import to_kebab_case, to_pascal_case, to_snake_case
+
+__all__ = ["create_host", "create_module"]
+
+logger = logging.getLogger(__name__)
+
+_TEMPLATES_PACKAGE = "simple_module_cli.templates"
+_PACKAGE_PATH_TOKEN = "__PACKAGE__"
+
+
+def _module_to_pypi_name(name: str) -> str:
+    return f"simple_module_{name.lower()}"
+
+
+def _iter_template_files(template_root: Path):
+    """Yield every file under ``template_root``. Skips ``_optional/`` paths."""
+    for path in template_root.rglob("*"):
+        if not path.is_file():
+            continue
+        if "_optional" in path.relative_to(template_root).parts:
+            continue
+        yield path
+
+
+def _require_empty_dest(dest: Path) -> None:
+    if dest.exists() and any(dest.iterdir()):
+        raise FileExistsError(
+            f"Destination {dest} already exists and is non-empty. "
+            "Choose a new path or remove the contents first."
+        )
+    dest.mkdir(parents=True, exist_ok=True)
+
+
+def _resolve_template_root(subdir: str, override: Path | None) -> Path:
+    if override is not None:
+        return Path(override)
+    return Path(str(importlib.resources.files(_TEMPLATES_PACKAGE) / subdir))
+
+
+def _apply_template_files(
+    src_root: Path,
+    dest: Path,
+    substitutions: Mapping[str, str],
+    *,
+    path_rewrites: Mapping[str, str] | None = None,
+) -> None:
+    for src in _iter_template_files(src_root):
+        rel_str = str(src.relative_to(src_root))
+        for old, new in (path_rewrites or {}).items():
+            rel_str = rel_str.replace(old, new)
+        rel_str = rel_str.removesuffix(".tpl")
+        target = dest / rel_str
+        target.parent.mkdir(parents=True, exist_ok=True)
+        if src.suffix == ".tpl":
+            text = src.read_text(encoding="utf-8")
+            for placeholder, value in substitutions.items():
+                text = text.replace(placeholder, value)
+            target.write_text(text, encoding="utf-8")
+        else:
+            shutil.copy2(src, target)
+
+
+def create_host(
+    dest: Path,
+    name: str,
+    modules: Sequence[str],
+    template_root: Path | None = None,
+) -> Path:
+    dest = Path(dest)
+    _require_empty_dest(dest)
+    module_dep_lines = "\n".join(f'    "{_module_to_pypi_name(m)}>=0.1,<1.0",' for m in modules)
+    _apply_template_files(
+        _resolve_template_root("host", template_root),
+        dest,
+        {"{{HOST_NAME}}": name, "{{MODULE_DEPS}}": module_dep_lines},
+    )
+    logger.info(
+        "Scaffolded host '%s' at %s (modules: %s)", name, dest, ", ".join(modules) or "<none>"
+    )
+    return dest
+
+
+def create_module(
+    dest: Path,
+    name: str,
+    template_root: Path | None = None,
+) -> Path:
+    dest = Path(dest)
+    _require_empty_dest(dest)
+    display_name = to_pascal_case(name)
+    slug = to_kebab_case(name)
+    package_name = to_snake_case(name)
+    _apply_template_files(
+        _resolve_template_root("module", template_root),
+        dest,
+        substitutions={
+            "{{MODULE_NAME}}": display_name,
+            "{{MODULE_SLUG}}": slug,
+            "{{PACKAGE_NAME}}": package_name,
+        },
+        path_rewrites={_PACKAGE_PATH_TOKEN: package_name},
+    )
+    logger.info("Scaffolded module '%s' at %s (package: %s)", display_name, dest, package_name)
+    return dest

simple_module_cli/templates/host/.env.example

@@ -0,0 +1,20 @@
+# Database — defaults to a local SQLite file.
+# For PostgreSQL use: postgresql+asyncpg://user:pass@host:5432/dbname
+SM_DATABASE_URL=sqlite+aiosqlite:///./app.db
+
+# Environment: development | production
+SM_ENVIRONMENT=development
+
+# Secret key for session middleware — change before deploying.
+SM_SECRET_KEY=change-me-in-production
+
+# Vite dev server URL (only used in development).
+SM_VITE_DEV_URL=http://localhost:5050
+
+# Optional: JSON array to restrict which installed modules load at boot.
+# SM_MODULES_ENABLED=["Auth","Products"]
+
+# First-boot admin seed (optional). Only applied when the users table is empty.
+# Leave unset and use `uv run sm-users create-admin` instead if you prefer.
+# SM_USERS_BOOTSTRAP_EMAIL=admin@example.com
+# SM_USERS_BOOTSTRAP_PASSWORD=changeme

simple_module_cli/templates/host/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+
+uv.lock
+
+node_modules/
+
+.env
+
+*.db
+*.sqlite3
+
+static/dist/
+
+# Auto-generated by the host at boot / `sm gen-pages`.
+client_app/modules.manifest.json
+client_app/modules.generated.ts

simple_module_cli/templates/host/Makefile

@@ -0,0 +1,24 @@
+.PHONY: install dev dev-api dev-ui build migrate gen-pages
+
+install:
+	uv sync
+	cd client_app && npm install
+
+dev: gen-pages
+	@echo "Starting API and UI dev servers..."
+	$(MAKE) -j2 dev-api dev-ui
+
+dev-api:
+	uv run uvicorn main:app --reload --port 8000
+
+dev-ui:
+	cd client_app && npm run dev
+
+build:
+	cd client_app && npm run build
+
+migrate:
+	uv run alembic upgrade head
+
+gen-pages:
+	uv run sm gen-pages --host-dir=client_app

simple_module_cli/templates/host/README.md.tpl

@@ -0,0 +1,59 @@
+# {{HOST_NAME}}
+
+A SimpleModule host application, generated by `sm create-host`.
+
+## Quick start
+
+```bash
+# Install Python deps (framework + any modules listed in pyproject.toml)
+uv sync
+
+# Copy example env and adjust
+cp .env.example .env
+
+# First time only — initialize the migration history for the modules you
+# picked. Inspect the generated file, then apply it.
+alembic revision --autogenerate -m "initial schema"
+alembic upgrade head
+
+# Run the API
+python main.py
+```
+
+Dev UI + API together (when you have a `client_app/` alongside this file):
+
+```bash
+make dev    # if you ship a Makefile; otherwise run vite + uvicorn in two shells
+```
+
+## Adding a module
+
+```bash
+# 1) install the module package (e.g. from PyPI)
+uv add simple_module_my_module
+
+# 2) generate & apply the migration (new tables + any schema changes)
+alembic revision --autogenerate -m "add my-module"
+alembic upgrade head
+
+# 3) restart the host — the module's routes, menu items, permissions,
+#    feature flags, events, and health checks register automatically
+```
+
+## Disabling a module without uninstalling it
+
+Set `SM_MODULES_ENABLED` to a JSON array of the modules you want loaded:
+
+```
+SM_MODULES_ENABLED=["Auth","Products"]
+```
+
+Unlisted modules stay installed (so the existing DB schema is untouched)
+but don't contribute any routes, registries, or lifecycle work.
+
+## Upgrading the framework
+
+Modules declare `requires_framework` in their `Meta`. If a module can't
+work with your installed `simple_module_core` version, the host refuses
+to boot with `FrameworkVersionError` listing the offending modules.
+Upgrade or pin as appropriate.

simple_module_cli/templates/host/_optional/background_tasks/Makefile.snippet

@@ -0,0 +1,12 @@
+# --- background_tasks ----------------------------------------------------
+.PHONY: worker beat worker-docker
+
+worker:                     ## Run a Celery worker locally against $(SM_BG_TASKS_BROKER_URL)
+	uv run celery -A scripts.run_worker:celery worker -l info
+
+beat:                       ## Run the Celery beat scheduler locally
+	uv run celery -A scripts.run_worker:celery beat -l info
+
+worker-docker:              ## Build + run the worker + beat services in docker
+	docker compose up --build worker beat
+# --- end background_tasks ------------------------------------------------

simple_module_cli/templates/host/_optional/background_tasks/docker-compose.yml

@@ -0,0 +1,60 @@
+services:
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redisdata:/data
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 3s
+      retries: 10
+
+  worker:
+    build:
+      context: .
+      dockerfile: docker/worker.Dockerfile
+    env_file: .env
+    environment:
+      SM_BG_TASKS_BROKER_URL: redis://redis:6379/0
+      SM_BG_TASKS_RESULT_BACKEND: redis://redis:6379/1
+    depends_on:
+      redis:
+        condition: service_healthy
+    command:
+      - "uv"
+      - "run"
+      - "celery"
+      - "-A"
+      - "scripts.run_worker:celery"
+      - "worker"
+      - "-l"
+      - "info"
+      - "--concurrency=4"
+
+  beat:
+    build:
+      context: .
+      dockerfile: docker/worker.Dockerfile
+    env_file: .env
+    environment:
+      SM_BG_TASKS_BROKER_URL: redis://redis:6379/0
+      SM_BG_TASKS_RESULT_BACKEND: redis://redis:6379/1
+    depends_on:
+      redis:
+        condition: service_healthy
+      worker:
+        condition: service_started
+    command:
+      - "uv"
+      - "run"
+      - "celery"
+      - "-A"
+      - "scripts.run_worker:celery"
+      - "beat"
+      - "-l"
+      - "info"
+
+volumes:
+  redisdata:

simple_module_cli/templates/host/_optional/background_tasks/run_worker.py

@@ -0,0 +1,17 @@
+"""Entry point for the Celery worker and beat services.
+
+Both the web process and the worker go through the same
+``background_tasks.celery_app.build_celery`` factory so the broker
+config, autodiscovered tasks, and signal handlers stay in lockstep.
+
+Run locally:
+    uv run celery -A scripts.run_worker:celery worker -l info
+    uv run celery -A scripts.run_worker:celery beat   -l info
+"""
+
+from __future__ import annotations
+
+from background_tasks.celery_app import build_celery
+from background_tasks.settings import BackgroundTasksSettings
+
+celery = build_celery(BackgroundTasksSettings())

simple_module_cli/templates/host/_optional/background_tasks/worker.Dockerfile

@@ -0,0 +1,37 @@
+# Celery worker image for the BackgroundTasks module.
+# Serves both the worker and beat services in docker-compose — they
+# differ only by command.
+
+FROM python:3.12-slim AS base
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    UV_LINK_MODE=copy \
+    UV_COMPILE_BYTECODE=1 \
+    UV_SYSTEM_PYTHON=1
+
+RUN apt-get update \
+    && apt-get install -y --no-install-recommends \
+        curl \
+        ca-certificates \
+        build-essential \
+    && rm -rf /var/lib/apt/lists/* \
+    && pip install --no-cache-dir uv
+
+WORKDIR /app
+
+COPY pyproject.toml uv.lock ./
+COPY scripts/ scripts/
+COPY client_app/ client_app/
+
+RUN uv sync --frozen --no-dev
+
+RUN useradd --system --uid 10001 --home /app --shell /usr/sbin/nologin worker \
+    && chown -R worker:worker /app
+USER worker
+
+ENV CELERY_APP=scripts.run_worker:celery
+HEALTHCHECK --interval=30s --timeout=10s --start-period=30s --retries=3 \
+    CMD uv run celery -A $CELERY_APP inspect ping -d celery@$HOSTNAME || exit 1
+
+CMD ["uv", "run", "celery", "-A", "scripts.run_worker:celery", "worker", "-l", "info"]

simple_module_cli/templates/host/alembic.ini

@@ -0,0 +1,36 @@
+[alembic]
+script_location = migrations
+sqlalchemy.url =
+
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

simple_module_cli/templates/host/client_app/app.tsx

@@ -0,0 +1,16 @@
+import { createInertiaApp } from '@inertiajs/react';
+import { createRoot } from 'react-dom/client';
+import { resolvePage } from './pages';
+
+createInertiaApp({
+  resolve: async (name) => {
+    return await resolvePage(name);
+  },
+  setup({ el, App, props }) {
+    createRoot(el).render(<App {...props} />);
+  },
+  progress: {
+    color: '#4B5563',
+    delay: 150,
+  },
+});

simple_module_cli/templates/host/client_app/main.tsx

@@ -0,0 +1,2 @@
+import './styles.css';
+import './app';

simple_module_cli/templates/host/client_app/package.json.tpl

@@ -0,0 +1,23 @@
+{
+  "name": "{{HOST_NAME}}-client-app",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@inertiajs/react": "^2.0.0",
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.0.0",
+    "@types/react-dom": "^19.0.0",
+    "@vitejs/plugin-react": "^5.0.0",
+    "typescript": "^5.7.0",
+    "vite": "^6.0.0"
+  }
+}

simple_module_cli/templates/host/client_app/pages/Error.tsx

@@ -0,0 +1,13 @@
+type ErrorProps = {
+  status: number;
+  message?: string;
+};
+
+export default function Error({ status, message }: ErrorProps) {
+  return (
+    <main style={{ padding: '2rem', maxWidth: '40rem', margin: '0 auto' }}>
+      <h1>{status}</h1>
+      <p>{message || 'Something went wrong.'}</p>
+    </main>
+  );
+}

simple_module_cli/templates/host/client_app/pages.ts

@@ -0,0 +1,47 @@
+/**
+ * Inertia page resolver.
+ *
+ * Module pages are discovered via a generated file (modules.generated.ts)
+ * emitted by the Python host at boot, or manually via `sm gen-pages`. Each
+ * installed module contributes an import.meta.glob() call with an absolute
+ * path, so pages shipped inside pip-installed module wheels resolve.
+ *
+ * Host-level pages live in client_app/pages/{PageName}.tsx and are
+ * registered under just "{PageName}" (e.g. "Error").
+ */
+
+import { moduleGlobs } from './modules.generated';
+
+type PageModule = { default: React.ComponentType<Record<string, unknown>> };
+type PageLoader = () => Promise<PageModule>;
+
+const hostPages = import.meta.glob<PageModule>('./pages/*.tsx');
+
+const pages: Record<string, PageLoader> = {};
+
+for (const [moduleName, globEntries] of Object.entries(moduleGlobs)) {
+  for (const [filePath, loader] of Object.entries(globEntries)) {
+    const match = filePath.match(/\/pages\/(\w+)\.tsx$/);
+    if (match) {
+      pages[`${moduleName}/${match[1]}`] = loader;
+    }
+  }
+}
+
+for (const [filePath, loader] of Object.entries(hostPages)) {
+  const match = filePath.match(/\.\/pages\/(\w+)\.tsx$/);
+  if (match) {
+    pages[match[1]] = loader;
+  }
+}
+
+export async function resolvePage(
+  name: string,
+): Promise<React.ComponentType<Record<string, unknown>>> {
+  const loader = pages[name];
+  if (!loader) {
+    throw new Error(`Page "${name}" not found. Available pages: ${Object.keys(pages).join(', ')}`);
+  }
+  const module = await loader();
+  return module.default;
+}

simple_module_cli/templates/host/client_app/styles.css

@@ -0,0 +1,7 @@
+body {
+  margin: 0;
+  font-family:
+    system-ui,
+    -apple-system,
+    sans-serif;
+}

simple_module_cli/templates/host/client_app/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "lib": ["ES2022", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "jsx": "react-jsx",
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "types": ["vite/client", "node"],
+    "allowImportingTsExtensions": false
+  },
+  "include": ["**/*.ts", "**/*.tsx"]
+}

simple_module_cli/templates/host/client_app/vite.config.ts

@@ -0,0 +1,39 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import react from '@vitejs/plugin-react';
+import { defineConfig } from 'vite';
+
+const projectRoot = path.resolve(__dirname, '..');
+
+// Load the module pages manifest written by the Python host at boot.
+// Each entry points at an absolute pages/ directory — typically inside a
+// pip-installed module wheel. Vite needs these in server.fs.allow so the
+// dev server can read files outside the host root.
+const manifestPath = path.resolve(__dirname, 'modules.manifest.json');
+const moduleFsAllow: string[] = [];
+if (fs.existsSync(manifestPath)) {
+  const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf-8')) as Record<string, string>;
+  for (const pagesDir of Object.values(manifest)) {
+    moduleFsAllow.push(path.dirname(pagesDir));
+  }
+}
+
+export default defineConfig({
+  plugins: [react()],
+  root: __dirname,
+  build: {
+    outDir: '../static/dist',
+    manifest: true,
+    rollupOptions: {
+      input: path.resolve(__dirname, 'main.tsx'),
+    },
+  },
+  server: {
+    port: 5050,
+    strictPort: true,
+    origin: 'http://localhost:5050',
+    fs: {
+      allow: [projectRoot, ...moduleFsAllow],
+    },
+  },
+});

simple_module_cli/templates/host/main.py

@@ -0,0 +1,27 @@
+"""Host application entry point.
+
+This file was generated by `sm create-host`. Modules are discovered at boot
+via entry_points; add them to this host's pyproject.toml to install them.
+"""
+
+from simple_module_hosting import Settings, create_app
+from simple_module_hosting.logging import setup_logging
+
+settings = Settings()
+
+setup_logging(
+    level=settings.log_level,
+    json_format=settings.log_format == "json",
+)
+
+app = create_app(settings)
+
+if __name__ == "__main__":
+    import uvicorn
+
+    uvicorn.run(
+        "main:app",
+        host="0.0.0.0",
+        port=8000,
+        reload=settings.is_development,
+    )