rapidkit 0.40.1 → 0.41.1

package/templates/kits/fastapi-ddd/README.md.j2

@@ -0,0 +1,122 @@
+# {{ project_name }}
+
+Domain-driven FastAPI service generated with [RapidKit](https://github.com/rapidkitlabs/rapidkit-core).
+
+## Quick start
+
+```bash
+# Load the project-aware RapidKit CLI (adds .rapidkit/rapidkit to PATH)
+source .rapidkit/activate
+
+# Bootstrap dependencies (creates .venv + installs Poetry deps)
+rapidkit init  # use make init if you prefer a Make target
+
+# Copy env templates and install hooks/tooling
+./bootstrap.sh
+
+# Type-check, lint, and test
+make lint
+make typecheck
+make test
+
+# Run the service
+make dev
+
+# Use the RapidKit CLI helpers when you prefer auto-detected environments
+rapidkit dev
+rapidkit lint
+rapidkit test
+
+# Run supply-chain and dependency audits
+make audit
+```
+
+> Re-source `.rapidkit/activate` whenever you open a new shell so the project-local `rapidkit` launcher is always on your PATH.
+
+> Re-run `rapidkit init` (or `make init`) when dependencies change. If you only need to refresh tooling/hooks, run `SKIP_INIT=1 make install` or rely on `./bootstrap.sh`.
+
+> Lockfiles are generated automatically during scaffolding. Set `RAPIDKIT_SKIP_LOCKS=1` (or `RAPIDKIT_GENERATE_LOCKS=0`) before running `rapidkit create` if you want to skip the lockfile attempt.
+
+> Need to see every RapidKit CLI command? Run `rapidkit --help` or check the CLI reference in the docs for the full catalog.
+
+## Project structure
+
+```
+src/
+  app/
+    application/   # Use cases and service contracts
+    domain/        # Aggregates, entities, and value objects
+    infrastructure/ # Adapters and repositories
+    presentation/  # API routers and dependencies
+    shared/        # Cross-cutting primitives (Result, types, etc.)
+  routing/         # Glue for module-provided routers
+  modules/         # RapidKit module bootstrapping
+```
+
+## Layer overview
+
+- **Domain** – Pure business rules (`src/app/domain`).
+- **Application** – Orchestrates use-cases and enforces boundaries (`src/app/application`).
+- **Infrastructure** – Implements gateways and repositories (`src/app/infrastructure`).
+- **Presentation** – Exposes the API using FastAPI (`src/app/presentation`).
+
+Modules added via `rapidkit add module ...` integrate automatically using the preserved
+injection anchors inside `src/main.py` and `src/routing/__init__.py`.
+
+## Example feature
+
+An in-memory notes module is included under `/api/examples/notes` to demonstrate how the domain, application, infrastructure, and presentation layers collaborate:
+
+```bash
+# Create a note
+curl -s -X POST http://localhost:8000/api/examples/notes \
+  -H "Content-Type: application/json" \
+  -d '{"title":"design","body":"Describe your bounded context here."}'
+
+# Retrieve the newly created note
+curl -s http://localhost:8000/api/examples/notes/1 | jq
+```
+
+Swap the in-memory repository with a RapidKit database module when you are ready for persistence.
+
+## Deployment
+
+- `Dockerfile` packages the service for container hosting with production-ready defaults.
+- `docker-compose.yml` provisions the FastAPI app plus dependencies (for example PostgreSQL) for local production parity.
+- Run `docker compose up --build` to start the stack; copy `.env.example` to `.env` to configure credentials before deploying.
+- CI/CD workflows under `.github/workflows/` demonstrate automated deployment pipelines.
+
+## Testing
+
+```bash
+rapidkit test
+```
+
+The scaffold ships with a smoke test (`tests/test_app_factory.py`) that validates the
+health endpoint and the application factory.
+
+---
+
+## Local development
+
+- `rapidkit init` bootstraps dependencies via the project-local CLI (run it after sourcing `.rapidkit/activate`).
+- `make init` is an optional alias for `rapidkit init` when you prefer Make targets.
+- `make install` re-runs `rapidkit init` unless `SKIP_INIT=1` is set and refreshes developer tooling such as pre-commit hooks.
+- `./bootstrap.sh` copies `.env.example` to `.env` (when missing) and runs `SKIP_INIT=1 make install` for you.
+- `make dev` or `rapidkit dev` starts the FastAPI server with hot-reload and ensures environment variables from `.env` are loaded.
+- `make lint`, `make typecheck`, and `make test` (or `rapidkit lint` / `rapidkit test`) are thin wrappers around Ruff, mypy, and pytest for consistent CI parity.
+- `make audit` runs `pip-audit` and `npm audit` to surface vulnerable dependencies early.
+
+Pre-commit is configured with Ruff, Black, mypy, and hygiene hooks; `./bootstrap.sh` installs them automatically (or run `SKIP_INIT=1 make install`). Use the RapidKit CLI variants when you need it to auto-discover the right virtual environment inside automation scripts.
+
+<!-- <<<inject:module-snippet>>> -->
+
+## 📄 License
+
+This project is licensed under the **{{ license }}** License - see the `LICENSE` file included at the project root for details.
+
+## 🔒 Security & secrets
+
+- Copy `.env.example` to `.env` and populate secrets (`SECRET_KEY`, DB credentials, etc.) before deploying.
+- **Do not** commit real secrets or `.env` to git; `.gitignore` already contains `.env` to protect accidental commits.
+- For production, tighten CORS and allowed hosts rather than using wildcard settings provided for convenience in dev.

package/templates/kits/fastapi-ddd/common/env.example.j2

@@ -0,0 +1,10 @@
+# RapidKit environment defaults
+PROJECT_NAME="{{ project_name | default('rapidkit-app') }}"
+ENV="development"
+DEBUG="true"
+APP_HOST="0.0.0.0"
+APP_PORT="8000"
+LOG_LEVEL="info"
+
+# Module-specific environment variables
+# <<<inject:module-env>>>

package/templates/kits/fastapi-ddd/env.example.j2

@@ -0,0 +1 @@
+{% include 'common/env.example.j2' %}

package/templates/kits/fastapi-ddd/pyproject.toml.j2

@@ -0,0 +1,64 @@
+[tool.poetry]
+name = "{{ project_name }}"
+version = "{{ app_version }}"
+description = "{{ description }}"
+authors = ["{{ author }} <you@example.com>"]
+license = "{{ license }}"
+packages = [{ include = "src" }]
+
+[tool.poetry.scripts]
+dev = "src.cli:dev"
+start = "src.cli:start"
+build = "src.cli:build"
+test = "src.cli:test"
+lint = "src.cli:lint"
+format = "src.cli:format"
+help = "src.cli:help_cmd"
+
+[tool.poetry.dependencies]
+python = "^{{ python_version }}"
+fastapi = "^0.128.0"
+uvicorn = { extras = ["standard"], version = "^0.40.0" }
+pydantic = "^2.12.5"
+{% if has_settings -%}
+pydantic-settings = { version = "^2.12.0", extras = ["yaml"] }
+{% endif %}
+# <<<inject:poetry-dependencies>>>
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^9.0.2"
+pytest-asyncio = "^1.3.0"
+pytest-cov = "^7.0.0"
+httpx = "^0.28.1"
+ruff = "^0.14.10"
+black = "^25.12.0"
+isort = "^7.0.0"
+mypy = "^1.19.1"
+build = "^1.3.0"
+
+# <<<inject:poetry-dev-dependencies>>>
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+markers = [
+	"integration: mark tests as integration tests",
+	"template_integration: mark template integration tests",
+]
+
+[tool.ruff]
+line-length = 100
+exclude = [".rapidkit/vendor"]
+
+[tool.ruff.lint]
+ignore = ["E501"]
+
+[tool.mypy]
+python_version = "{{ python_version }}"
+ignore_missing_imports = true
+warn_unused_configs = false
+show_error_codes = true
+# Ignore vendor snapshots and generated health shims from strict static checking
+exclude = "(^\\.rapidkit/vendor/|src/health/|src/main.py$|src/app/)"

package/templates/kits/fastapi-ddd/src/__init__.py.j2

@@ -0,0 +1,3 @@
+"""{{ project_name }} package."""
+
+__all__ = ["app", "main"]

package/templates/kits/fastapi-ddd/src/app/__init__.py.j2

@@ -0,0 +1,11 @@
+"""Domain-driven application layers for {{ project_name }}."""
+
+__all__ = [
+    "main",
+    "config",
+    "application",
+    "domain",
+    "infrastructure",
+    "presentation",
+    "shared",
+]

package/templates/kits/fastapi-ddd/src/app/application/__init__.py.j2

@@ -0,0 +1,5 @@
+"""Application layer orchestrating use cases and service contracts."""
+
+from .interfaces import HealthStatusProvider, NoteRepository, ServiceContext
+
+__all__ = ["HealthStatusProvider", "NoteRepository", "ServiceContext"]

package/templates/kits/fastapi-ddd/src/app/application/interfaces.py.j2

@@ -0,0 +1,43 @@
+"""Contracts between the application layer and infrastructure adapters."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Protocol
+
+from src.app.domain.models import HealthStatus, Note, NoteDraft
+
+
+class HealthStatusProvider(Protocol):
+    """Protocol describing how to obtain the current health status."""
+
+    def get_status(self) -> HealthStatus:
+        """Return the latest domain health status snapshot."""
+        ...
+
+
+class NoteRepository(Protocol):
+    """Protocol for managing example notes."""
+
+    def create(self, draft: NoteDraft) -> Note:
+        """Persist a note draft and return the resulting entity."""
+        ...
+
+    def list(self) -> list[Note]:
+        """Return all available notes."""
+        ...
+
+    def get(self, note_id: int) -> Note | None:
+        """Return a single note or None if it does not exist."""
+        ...
+
+
+@dataclass(slots=True)
+class ServiceContext:
+    """Aggregates infrastructure adapters used by application use-cases."""
+
+    health_provider: HealthStatusProvider
+    note_repository: NoteRepository
+
+
+__all__ = ["HealthStatusProvider", "NoteRepository", "ServiceContext"]

package/templates/kits/fastapi-ddd/src/app/application/use_cases/__init__.py.j2

@@ -0,0 +1,6 @@
+"""Application use-cases exposed to delivery mechanisms."""
+
+from .health import get_service_health
+from .notes import create_note, get_note, list_notes
+
+__all__ = ["get_service_health", "create_note", "get_note", "list_notes"]

package/templates/kits/fastapi-ddd/src/app/application/use_cases/health.py.j2

@@ -0,0 +1,14 @@
+"""Example use-case exposing service health information."""
+
+from __future__ import annotations
+
+from src.app.application.interfaces import ServiceContext
+from src.app.domain.models import HealthStatus
+
+
+def get_service_health(context: ServiceContext) -> dict[str, str]:
+    """Retrieve an immutable health snapshot for presentation layers."""
+    status = context.health_provider.get_status()
+    if isinstance(status, HealthStatus):
+        return status.to_dict()
+    return {"status": str(status)}

package/templates/kits/fastapi-ddd/src/app/application/use_cases/notes.py.j2

@@ -0,0 +1,24 @@
+"""Application use-cases orchestrating the example notes feature."""
+
+from __future__ import annotations
+
+from src.app.application.interfaces import ServiceContext
+from src.app.domain.models import Note, NoteDraft
+
+
+def list_notes(context: ServiceContext) -> list[Note]:
+    """Return every note currently stored."""
+
+    return context.note_repository.list()
+
+
+def create_note(context: ServiceContext, draft: NoteDraft) -> Note:
+    """Create a new note."""
+
+    return context.note_repository.create(draft)
+
+
+def get_note(context: ServiceContext, note_id: int) -> Note | None:
+    """Retrieve a single note by identifier."""
+
+    return context.note_repository.get(note_id)

package/templates/kits/fastapi-ddd/src/app/config/__init__.py.j2

@@ -0,0 +1,16 @@
+"""Configuration primitives for the application layer."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(slots=True)
+class AppConfig:
+    """Application-level configuration aggregated from RapidKit settings."""
+
+    environment: str = "development"
+    service_name: str = "{{ project_name }}"
+
+
+__all__ = ["AppConfig"]

package/templates/kits/fastapi-ddd/src/app/domain/__init__.py.j2

@@ -0,0 +1,3 @@
+"""Domain layer primitives for {{ project_name }}."""
+
+__all__ = ["models"]

package/templates/kits/fastapi-ddd/src/app/domain/models/__init__.py.j2

@@ -0,0 +1,6 @@
+"""Domain models and value objects."""
+
+from .health import HealthStatus
+from .note import Note, NoteDraft
+
+__all__ = ["HealthStatus", "Note", "NoteDraft"]

package/templates/kits/fastapi-ddd/src/app/domain/models/health.py.j2

@@ -0,0 +1,16 @@
+"""Domain entity representing system health."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True, slots=True)
+class HealthStatus:
+    """Immutable representation of the service health state."""
+
+    status: str = "ok"
+
+    def to_dict(self) -> dict[str, str]:
+        """Serialize the status for transport layers."""
+        return {"status": self.status}

package/templates/kits/fastapi-ddd/src/app/domain/models/note.py.j2

@@ -0,0 +1,27 @@
+"""Domain entity and value object for example notes."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(slots=True)
+class NoteDraft:
+    """Value object describing the data needed to create a note."""
+
+    title: str
+    body: str
+
+
+@dataclass(slots=True)
+class Note:
+    """Domain entity representing an immutable note."""
+
+    id: int
+    title: str
+    body: str
+
+    def to_dict(self) -> dict[str, str | int]:
+        """Serialize the note for presentation layers."""
+
+        return {"id": self.id, "title": self.title, "body": self.body}

package/templates/kits/fastapi-ddd/src/app/infrastructure/__init__.py.j2

@@ -0,0 +1,5 @@
+"""Infrastructure adapters for the application layer."""
+
+from .repositories import StaticHealthRepository
+
+__all__ = ["StaticHealthRepository"]

package/templates/kits/fastapi-ddd/src/app/infrastructure/repositories/__init__.py.j2

@@ -0,0 +1,6 @@
+"""Repository implementations bridging the domain and infrastructure."""
+
+from .health import StaticHealthRepository
+from .notes import InMemoryNoteRepository
+
+__all__ = ["StaticHealthRepository", "InMemoryNoteRepository"]

package/templates/kits/fastapi-ddd/src/app/infrastructure/repositories/health.py.j2

@@ -0,0 +1,17 @@
+"""Infrastructure repository providing health status data."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from src.app.domain.models import HealthStatus
+
+
+@dataclass(slots=True)
+class StaticHealthRepository:
+    """Simple repository returning a constant health status."""
+
+    status: str = "ok"
+
+    def get_status(self) -> HealthStatus:
+        return HealthStatus(status=self.status)

package/templates/kits/fastapi-ddd/src/app/infrastructure/repositories/notes.py.j2

@@ -0,0 +1,28 @@
+"""In-memory repository backing the example notes use-case."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Dict, List
+
+from src.app.domain.models import Note, NoteDraft
+
+
+@dataclass(slots=True)
+class InMemoryNoteRepository:
+    """Very small repository storing notes in process memory."""
+
+    _store: Dict[int, Note] = field(default_factory=dict)
+    _next_id: int = 1
+
+    def create(self, draft: NoteDraft) -> Note:
+        note = Note(id=self._next_id, title=draft.title, body=draft.body)
+        self._store[self._next_id] = note
+        self._next_id += 1
+        return note
+
+    def list(self) -> List[Note]:
+        return list(self._store.values())
+
+    def get(self, note_id: int) -> Note | None:
+        return self._store.get(note_id)

package/templates/kits/fastapi-ddd/src/app/main.py.j2

@@ -0,0 +1,61 @@
+"""Application factory wiring the FastAPI instance for DDD layers."""
+
+from __future__ import annotations
+
+from collections.abc import AsyncIterator, Callable
+
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from src.routing import api_router as root_api_router
+
+try:
+    # canonical health package
+    from src.health import register_health_routes as _core_register_health_routes
+except ImportError:  # pragma: no cover - health package not generated yet
+
+    def _register_health_routes(_: FastAPI) -> None:
+        return None
+
+else:
+
+    def _register_health_routes(app: FastAPI) -> None:
+        try:
+            _core_register_health_routes(app)
+        except Exception:  # pragma: no cover - defensive best-effort registration
+            return None
+
+
+LifespanHandler = Callable[[FastAPI], AsyncIterator[None]]
+
+
+def create_app(
+    *,
+    title: str,
+    description: str,
+    version: str,
+    lifespan: LifespanHandler | None = None,
+) -> FastAPI:
+    """Build the FastAPI application configured with shared middlewares and routers."""
+
+    app = FastAPI(
+        title=title,
+        description=description,
+        version=version,
+        docs_url="/docs",
+        redoc_url="/redoc",
+        lifespan=lifespan,
+    )
+
+    app.add_middleware(
+        CORSMiddleware,
+        allow_origins=["*"],
+        allow_credentials=True,
+        allow_methods=["*"],
+        allow_headers=["*"],
+    )
+
+    app.include_router(root_api_router, prefix="/api")
+    _register_health_routes(app)
+
+    return app

package/templates/kits/fastapi-ddd/src/app/presentation/__init__.py.j2

@@ -0,0 +1,3 @@
+"""Presentation layer packages (HTTP, CLI, messaging, ...)."""
+
+__all__ = ["api"]

package/templates/kits/fastapi-ddd/src/app/presentation/api/__init__.py.j2

@@ -0,0 +1,5 @@
+"""HTTP-facing presentation layer."""
+
+from .router import get_api_router
+
+__all__ = ["get_api_router"]

package/templates/kits/fastapi-ddd/src/app/presentation/api/dependencies/__init__.py.j2

@@ -0,0 +1,19 @@
+"""FastAPI dependencies that wire infrastructure to application use-cases."""
+
+from __future__ import annotations
+
+from functools import lru_cache
+
+from src.app.application.interfaces import ServiceContext
+from src.app.infrastructure.repositories import InMemoryNoteRepository, StaticHealthRepository
+
+
+@lru_cache(maxsize=1)
+def get_service_context() -> ServiceContext:
+    """Return a cached service context for request handlers."""
+    health_repository = StaticHealthRepository()
+    note_repository = InMemoryNoteRepository()
+    return ServiceContext(health_provider=health_repository, note_repository=note_repository)
+
+
+__all__ = ["get_service_context"]

package/templates/kits/fastapi-ddd/src/app/presentation/api/router.py.j2

@@ -0,0 +1,10 @@
+"""Factory for the root API router."""
+
+from __future__ import annotations
+
+from fastapi import APIRouter
+
+
+def get_api_router() -> APIRouter:
+    """Return an API router ready for versioned sub-routers."""
+    return APIRouter()

package/templates/kits/fastapi-ddd/src/app/presentation/api/routes/__init__.py.j2

@@ -0,0 +1,5 @@
+"""HTTP routes exposed by the presentation layer."""
+
+from . import health, notes
+
+__all__ = ["health", "notes"]

package/templates/kits/fastapi-ddd/src/app/presentation/api/routes/health.py.j2

@@ -0,0 +1,27 @@
+"""Health endpoints bridging the DDD layers."""
+
+from __future__ import annotations
+
+from time import monotonic
+
+from fastapi import APIRouter, Depends
+
+from src.app.application.interfaces import ServiceContext
+from src.app.application.use_cases import get_service_health
+from src.app.presentation.api.dependencies import get_service_context
+
+router = APIRouter(tags=["health"])
+
+_START_TIME = monotonic()
+
+
+@router.get("/", summary="Health check")
+async def heartbeat(
+    context: ServiceContext = Depends(get_service_context),
+) -> dict[str, object]:
+    """Return the current service health decal."""
+    payload: dict[str, object] = dict(get_service_health(context))
+    payload.setdefault("version", "{{ app_version }}")
+    payload.setdefault("uptime", monotonic() - _START_TIME)
+    payload.setdefault("module", "service")
+    return payload

package/templates/kits/fastapi-ddd/src/app/presentation/api/routes/notes.py.j2

@@ -0,0 +1,50 @@
+"""HTTP handlers for the example notes feature."""
+
+from __future__ import annotations
+
+from fastapi import APIRouter, Depends, HTTPException, status
+from pydantic import BaseModel, Field
+
+from src.app.application.interfaces import ServiceContext
+from src.app.application.use_cases import create_note, get_note, list_notes
+from src.app.domain.models import NoteDraft
+from src.app.presentation.api.dependencies import get_service_context
+
+router = APIRouter(tags=["examples"])
+
+
+class NotePayload(BaseModel):
+    title: str = Field(..., max_length=80)
+    body: str = Field(..., max_length=500)
+
+
+class NoteResponse(NotePayload):
+    id: int
+
+
+@router.post("/notes", response_model=NoteResponse, status_code=status.HTTP_201_CREATED)
+async def create_example_note(
+    payload: NotePayload,
+    context: ServiceContext = Depends(get_service_context),
+) -> NoteResponse:
+    note = create_note(context, NoteDraft(title=payload.title, body=payload.body))
+    return NoteResponse(**note.to_dict())
+
+
+@router.get("/notes", response_model=list[NoteResponse])
+async def list_example_notes(
+    context: ServiceContext = Depends(get_service_context),
+) -> list[NoteResponse]:
+    notes = list_notes(context)
+    return [NoteResponse(**note.to_dict()) for note in notes]
+
+
+@router.get("/notes/{note_id}", response_model=NoteResponse)
+async def get_example_note(
+    note_id: int,
+    context: ServiceContext = Depends(get_service_context),
+) -> NoteResponse:
+    note = get_note(context, note_id)
+    if not note:
+        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail="Note not found")
+    return NoteResponse(**note.to_dict())

package/templates/kits/fastapi-ddd/src/app/shared/__init__.py.j2

@@ -0,0 +1,5 @@
+"""Shared utilities across layers."""
+
+from .result import Result
+
+__all__ = ["Result"]