simple-module-hosting 0.0.1__py3-none-any.whl

simple_module_hosting/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_hosting/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_hosting/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_hosting/templates/host/migrations/versions/.gitkeep

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

simple_module_hosting/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_hosting/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_hosting/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_hosting/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_hosting/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/

simple_module_hosting/templates/module/README.md.tpl

@@ -0,0 +1,82 @@
+# simple_module_{{PACKAGE_NAME}}
+
+The `{{MODULE_NAME}}` module for SimpleModule hosts.
+
+## Installation
+
+```bash
+pip install simple_module_{{PACKAGE_NAME}}
+```
+
+A host that installs this package picks it up automatically via
+`entry_points`. No additional wiring is required.
+
+## Development
+
+```bash
+uv sync --extra dev
+uv run pytest
+```
+
+## Frontend assets (optional)
+
+If this module ships TSX pages:
+
+1. Drop them in `{{PACKAGE_NAME}}/pages/` (the scaffold created the
+   directory). One file per Inertia page — e.g. `Browse.tsx`,
+   `Detail.tsx`.
+2. Build them with your bundler of choice (Vite/esbuild/etc.) into
+   `{{PACKAGE_NAME}}/static/dist/`. This directory is **gitignored** —
+   only the wheel carries it.
+3. Before releasing (`uv build`), rebuild the assets. Your
+   `publish.yml` CI should run the bundler before `uv build`; add
+   a step after "Install project + dev deps" such as
+   `npm ci && npm run build`.
+
+Hosts mount the bundle automatically at
+`/modules/{{MODULE_SLUG}}/static` — the generated
+`{{MODULE_NAME}}Module.static_mounts()` method returns the directory
+when it exists, an empty dict otherwise (so dev without a build step
+doesn't fail).
+
+## Continuous integration
+
+Two workflows live under `.github/workflows/`:
+
+- **`ci.yml`** — runs on every push to `main` and on every pull request.
+  Installs deps, runs `ruff check`, then `pytest`.
+- **`publish.yml`** — runs only when a tag matching `v*` is pushed.
+  Re-runs tests, builds the wheel + sdist, and uploads to PyPI via
+  trusted publishing (no API token).
+
+## Publishing
+
+One-time PyPI setup (do this before your first release):
+
+1. Create the project's Trusted Publisher entry at
+   <https://pypi.org/manage/account/publishing/>:
+   - PyPI project name: `simple_module_{{PACKAGE_NAME}}`
+   - Owner / Repository: your GitHub org + this repo
+   - Workflow filename: `publish.yml`
+   - Environment (recommended): `pypi`
+2. On GitHub → Settings → Environments, create `pypi`. Add required
+   reviewers if you want a manual approval gate before every release.
+
+Every release after that is three commands:
+
+```bash
+# 1) bump the version in pyproject.toml, commit
+# 2) tag
+git tag v0.2.0
+git push --tags
+# 3) done — the publish workflow uploads to PyPI
+```
+
+No `PYPI_API_TOKEN` secret exists anywhere. Trusted publishing mints a
+short-lived OIDC token scoped to this repo + workflow + environment.
+
+## API-version contract
+
+The `Meta.requires_framework` field declares which `simple_module_core`
+versions this module supports. Update the spec on each framework major
+bump after verifying compatibility.

simple_module_hosting/templates/module/__PACKAGE__/endpoints/api.py.tpl

@@ -0,0 +1,11 @@
+"""API routes for the {{MODULE_NAME}} module."""
+
+from fastapi import APIRouter
+
+router = APIRouter()
+
+
+@router.get("/")
+async def list_items() -> dict:
+    """Placeholder endpoint. Replace with real resources."""
+    return {"module": "{{MODULE_NAME}}", "items": []}

simple_module_hosting/templates/module/__PACKAGE__/module.py.tpl

@@ -0,0 +1,46 @@
+"""{{MODULE_NAME}} module — generated by `sm create-module`."""
+
+from __future__ import annotations
+
+import importlib.resources
+from pathlib import Path
+
+from fastapi import APIRouter, FastAPI
+from simple_module_core import ModuleBase, ModuleMeta
+
+
+class {{MODULE_NAME}}Module(ModuleBase):
+    meta = ModuleMeta(
+        name="{{MODULE_NAME}}",
+        route_prefix="/api/{{MODULE_SLUG}}",
+        view_prefix="/{{MODULE_SLUG}}",
+        depends_on=[],
+        version="0.1.0",
+        requires_framework=">=1.0,<2.0",
+    )
+
+    def register_routes(self, api_router: APIRouter, view_router: APIRouter) -> None:
+        from {{PACKAGE_NAME}}.endpoints.api import router as api
+
+        api_router.include_router(api)
+
+    def register_settings(self, app: FastAPI) -> None:
+        from {{PACKAGE_NAME}}.services import {{MODULE_NAME}}Services
+        from {{PACKAGE_NAME}}.settings import {{MODULE_NAME}}Settings
+
+        app.state.{{PACKAGE_NAME}} = {{MODULE_NAME}}Services(settings={{MODULE_NAME}}Settings())
+
+    def static_mounts(self) -> dict[str, Path]:
+        """Expose pre-built frontend assets when they exist.
+
+        Returns an empty dict when ``static/dist/`` hasn't been built yet,
+        so ``uv run pytest`` works during development. In production, the
+        wheel ships the built bundle via ``force-include`` in
+        ``pyproject.toml`` and the host mounts it at
+        ``/modules/{{MODULE_SLUG}}/static``.
+        """
+        pkg_root = Path(str(importlib.resources.files("{{PACKAGE_NAME}}")))
+        dist = pkg_root / "static" / "dist"
+        if not dist.is_dir():
+            return {}
+        return {"/modules/{{MODULE_SLUG}}/static": dist}

simple_module_hosting/templates/module/__PACKAGE__/pages/.gitkeep

@@ -0,0 +1 @@
+# Keep this directory; TSX pages go here (e.g. Browse.tsx, Detail.tsx).

simple_module_hosting/templates/module/__PACKAGE__/services.py.tpl

@@ -0,0 +1,22 @@
+"""Module-scoped state container.
+
+Stored as ``app.state.{{PACKAGE_NAME}}`` by
+:meth:`{{MODULE_NAME}}Module.register_settings`.
+
+Not frozen — ``on_startup`` may set fields that depend on the DB or
+other framework services. Convention: set once during boot, treat as
+read-only after.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from {{PACKAGE_NAME}}.settings import {{MODULE_NAME}}Settings
+
+
+@dataclass
+class {{MODULE_NAME}}Services:
+    """{{MODULE_NAME}} module singletons."""
+
+    settings: {{MODULE_NAME}}Settings

simple_module_hosting/templates/module/package.json.tpl

@@ -0,0 +1,16 @@
+{
+  "name": "@simple-module-py/{{MODULE_SLUG}}",
+  "version": "0.1.0",
+  "private": true,
+  "description": "Frontend assets for the {{MODULE_NAME}} module",
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "react-dom": "^19.0.0",
+    "@inertiajs/react": "^2.0.0",
+    "@simple-module-py/ui": "*"
+  },
+  "devDependencies": {
+    "@simple-module-py/tsconfig": "*"
+  },
+  "dependencies": {}
+}

simple_module_hosting/templates/module/pyproject.toml.tpl

@@ -0,0 +1,39 @@
+[project]
+name = "simple_module_{{PACKAGE_NAME}}"
+version = "0.1.0"
+description = "{{MODULE_NAME}} module for SimpleModule hosts"
+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",
+    "sqlalchemy>=2.0",
+]
+
+[project.entry-points.simple_module]
+{{PACKAGE_NAME}} = "{{PACKAGE_NAME}}.module:{{MODULE_NAME}}Module"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-asyncio>=0.24",
+    # Shared fixtures (fake_event_bus, build_test_app, etc.) for testing
+    # modules in isolation. The pytest11 entry_point auto-registers them.
+    "simple_module_testing>=0.1,<1.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["{{PACKAGE_NAME}}"]
+
+# Ship the built frontend bundle + per-module JS dep manifest inside the wheel.
+# static/dist/ is gitignored, so force-include picks up the working-tree build
+# during `uv build` — run your bundler (vite/esbuild) first. package.json lives
+# at the module root so npm workspaces see it; copying it into <pkg>/ lets the
+# host discover JS deps via importlib.resources after a pip install.
+[tool.hatch.build.targets.wheel.force-include]
+"{{PACKAGE_NAME}}/static/dist" = "{{PACKAGE_NAME}}/static/dist"
+"package.json" = "{{PACKAGE_NAME}}/package.json"

simple_module_hosting/templates/module/tests/test_module.py.tpl

@@ -0,0 +1,27 @@
+"""Smoke tests for the {{MODULE_NAME}} module.
+
+The ``build_test_app`` and ``fake_event_bus`` fixtures come from the
+``simple_module_testing`` pytest plugin (registered via entry_points when
+that package is installed). No conftest.py is required.
+"""
+
+from __future__ import annotations
+
+from {{PACKAGE_NAME}}.module import {{MODULE_NAME}}Module
+
+
+class TestMeta:
+    def test_meta_name(self):
+        assert {{MODULE_NAME}}Module.meta.name == "{{MODULE_NAME}}"
+
+    def test_meta_requires_framework(self):
+        assert {{MODULE_NAME}}Module.meta.requires_framework is not None
+
+
+class TestRoutes:
+    async def test_app_boots_with_module(self, build_test_app):
+        """Module registers cleanly into a minimal FastAPI host."""
+        app = build_test_app({{MODULE_NAME}}Module)
+        paths = {getattr(r, "path", None) for r in app.routes}
+        # The placeholder GET / endpoint lives under the route_prefix.
+        assert any(p and p.startswith("/api/{{MODULE_SLUG}}") for p in paths)

simple_module_hosting/templates/module/tsconfig.json.tpl

@@ -0,0 +1,11 @@
+{
+  "extends": "@simple-module-py/tsconfig/base.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./{{PACKAGE_NAME}}/*"],
+      "@simple-module-py/ui/*": ["../../packages/ui/src/*"]
+    }
+  },
+  "include": ["{{PACKAGE_NAME}}/**/*.ts", "{{PACKAGE_NAME}}/**/*.tsx"]
+}

simple_module_hosting-0.0.1.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: simple_module_hosting
+Version: 0.0.1
+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
+Project-URL: Issues, https://github.com/antosubash/simple_module_python/issues
+Project-URL: Changelog, https://github.com/antosubash/simple_module_python/blob/main/CHANGELOG.md
+Author-email: Anto Subash <antosubash@live.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: fastapi,inertia,scaffolding,simple-module,starlette,uvicorn
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+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 :: Internet :: WWW/HTTP :: WSGI :: Application
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: click>=8.1
+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: starlette>=0.44
+Requires-Dist: tomlkit>=0.13
+Requires-Dist: uvicorn[standard]>=0.34
+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.
+
+## Install
+
+```bash
+pip install simple_module_hosting
+```
+
+For a new project, most users run the generator instead:
+
+```bash
+uvx simple-module new my-app
+```
+
+## What it provides
+
+- `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`.
+
+## Usage
+
+Minimal `main.py`:
+
+```python
+from simple_module_hosting import create_app
+from simple_module_hosting.settings import Settings
+
+settings = Settings()           # reads SM_* env vars
+app = create_app(settings)      # discovers + registers every installed module
+
+if __name__ == "__main__":
+    import uvicorn
+    uvicorn.run(app, host="0.0.0.0", port=8000)
+```
+
+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` works identically to `simple-module`.
+
+## Depends on
+
+- `simple_module_core`, `simple_module_db`
+- `fastapi`, `fastapi-inertia`, `starlette`, `uvicorn`, `click`, `jinja2`, `httpx`
+
+## License
+
+MIT — see [LICENSE](https://github.com/antosubash/simple_module_python/blob/main/LICENSE).