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

simple_module_cli-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/simple_module_cli/templates/host/client_app/main.tsx

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

simple_module_cli-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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-0.0.2.data/data/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,
+    )

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/host/migrations/env.py

@@ -0,0 +1,80 @@
+"""Alembic environment for a SimpleModule host.
+
+Discovery + metadata aggregation lives in `simple_module_db.migrations` so
+this file stays small and identical across all hosts. Don't add module-
+specific imports here — install the module package and re-run autogenerate.
+"""
+
+from __future__ import annotations
+
+import logging
+from logging.config import fileConfig
+
+from alembic import context
+from simple_module_db import build_module_metadata, make_include_object, render_item
+from simple_module_hosting.settings import Settings
+from sqlalchemy import engine_from_config, pool
+
+logger = logging.getLogger("alembic.env")
+
+config = context.config
+
+if config.config_file_name is not None:
+    fileConfig(config.config_file_name)
+
+target_metadata = build_module_metadata()
+include_object = make_include_object(target_metadata)
+
+
+def _get_url() -> str:
+    """Read database URL from settings, convert async to sync driver."""
+    settings = Settings()
+    url = settings.database_url
+    url = url.replace("+aiosqlite", "")
+    url = url.replace("+asyncpg", "+psycopg2")
+    return url
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode — generates SQL without a live DB."""
+    url = _get_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+        include_object=include_object,
+        render_item=render_item,
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations against a live database."""
+    configuration = config.get_section(config.config_ini_section, {})
+    configuration["sqlalchemy.url"] = _get_url()
+
+    connectable = engine_from_config(
+        configuration,
+        prefix="sqlalchemy.",
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            include_object=include_object,
+            render_item=render_item,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/host/migrations/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+from alembic import op
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: str | None = ${repr(down_revision)}
+branch_labels: str | Sequence[str] | None = ${repr(branch_labels)}
+depends_on: str | Sequence[str] | None = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/host/migrations/versions/.gitkeep

@@ -0,0 +1 @@
+# Keep this directory in git

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/host/pyproject.toml.tpl

@@ -0,0 +1,17 @@
+[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"

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/host/templates/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>SimpleModule</title>
+    {% inertia_head %}
+</head>
+<body class="antialiased">
+    {% inertia_body %}
+</body>
+</html>

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/module/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+# Fast feedback for pull requests and main-branch pushes.
+# No publishing here — see publish.yml.
+
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: latest
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install project + dev deps
+        run: uv sync --extra dev
+
+      - name: Lint
+        run: uv run ruff check .
+
+      - name: Tests
+        run: uv run pytest

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/module/.github/workflows/publish.yml.tpl

@@ -0,0 +1,52 @@
+# Publish simple_module_{{PACKAGE_NAME}} to PyPI on tagged releases.
+#
+# Setup (one-time, in the PyPI project settings → "Publishing"):
+#   1. Create the project on https://pypi.org/manage/account/publishing/
+#      with: PyPI project name = simple_module_{{PACKAGE_NAME}}
+#            Owner             = <your GitHub org/user>
+#            Repository name   = <this repo's name>
+#            Workflow filename = publish.yml
+#            Environment       = pypi   (optional but recommended)
+#   2. In GitHub: Settings → Environments → New environment "pypi"
+#      with required reviewers if you want a manual approval gate.
+#
+# After setup, pushing a tag like `v0.1.0` builds the wheel + sdist and
+# uploads via OIDC — no API token needs to exist anywhere.
+
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for PyPI trusted publishing
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: latest
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install project + dev deps
+        run: uv sync --extra dev
+
+      - name: Run tests
+        run: uv run pytest
+
+      - name: Build distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

simple_module_cli-0.0.2.data/data/simple_module_cli/templates/module/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+dist/
+build/
+*.db
+*.sqlite3
+.env
+
+# Built frontend assets — shipped inside the wheel via force-include but
+# NOT source-controlled. Re-run `npm run build` (or `vite build`) before
+# `uv build` to repopulate.
+*/static/dist/