austial-cli 0.1.5__py3-none-any.whl

austial/cli/generators/__init__.py

@@ -0,0 +1,13 @@
+from austial.cli.generators.controller_gen import generate_controller
+from austial.cli.generators.module_gen import generate_module
+from austial.cli.generators.new_project import create_new_project
+from austial.cli.generators.resource_gen import generate_resource
+from austial.cli.generators.service_gen import generate_service
+
+__all__ = [
+    "create_new_project",
+    "generate_controller",
+    "generate_module",
+    "generate_resource",
+    "generate_service",
+]

austial/cli/generators/app_module_patcher.py

@@ -0,0 +1,61 @@
+"""Best-effort patcher that registers a newly generated module into the
+nearest ``app_module.py``, mirroring how the real ``nest`` CLI updates
+``app.module.ts`` after ``nest g module``/``nest g resource``.
+
+Text-based and intentionally conservative: if the file doesn't look like what
+`austial new`/`austial generate` produce, it leaves it alone and tells the
+caller so a manual edit instruction can be printed instead.
+"""
+
+from __future__ import annotations
+
+import re
+from pathlib import Path
+
+_IMPORTS_ARRAY_RE = re.compile(r"imports\s*=\s*\[(.*?)\]", re.DOTALL)
+
+
+def register_module(app_module_path: Path, class_name: str, import_line: str) -> bool:
+    """Returns True if the patch was applied, False if it was already present
+    or the file couldn't be safely patched."""
+    text = app_module_path.read_text()
+
+    if import_line in text:
+        return False  # already registered, nothing to do
+
+    lines = text.splitlines()
+
+    # Group the new import with its isort "block" (contiguous run of
+    # from/import lines sharing the same top-level package as `import_line`,
+    # e.g. all `from src...` lines) and re-sort that block alphabetically, so
+    # the patched file stays isort-clean instead of just tacking the new line
+    # onto the end of the whole import section.
+    package = import_line.split()[1].split(".")[0]
+    prefixes = (f"from {package}.", f"import {package}.")
+    block_indices = [i for i, line in enumerate(lines) if line.startswith(prefixes)]
+
+    if block_indices:
+        first, last = block_indices[0], block_indices[-1]
+        block = [lines[i] for i in block_indices] + [import_line]
+        block = sorted(set(block))
+        lines[first : last + 1] = block
+    else:
+        last_import_idx = 0
+        for i, line in enumerate(lines):
+            if line.startswith("from ") or line.startswith("import "):
+                last_import_idx = i
+        lines.insert(last_import_idx + 1, import_line)
+
+    text = "\n".join(lines) + "\n"
+
+    match = _IMPORTS_ARRAY_RE.search(text)
+    if not match:
+        app_module_path.write_text(text)
+        return False
+
+    inner = match.group(1)
+    new_inner = f"{inner.rstrip()}, {class_name}" if inner.strip() else class_name
+    text = text[: match.start(1)] + new_inner + text[match.end(1) :]
+
+    app_module_path.write_text(text)
+    return True

austial/cli/generators/base.py

@@ -0,0 +1,61 @@
+"""Shared helpers for every generator: template rendering + project-root
+discovery, mirroring what the ``nest`` CLI's schematics engine does."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from jinja2 import Environment, FileSystemLoader
+
+TEMPLATES_DIR = Path(__file__).resolve().parent.parent / "templates"
+
+_env = Environment(
+    loader=FileSystemLoader(str(TEMPLATES_DIR)),
+    keep_trailing_newline=True,
+    trim_blocks=True,
+    lstrip_blocks=True,
+)
+
+
+def render(template_relpath: str, **context: Any) -> str:
+    template = _env.get_template(template_relpath)
+    return template.render(**context)
+
+
+def write_file(path: Path, content: str, *, force: bool = False) -> bool:
+    """Writes `content` to `path`, creating parent directories as needed.
+    Returns False (and leaves the file untouched) if it already exists and
+    `force` wasn't given -- mirrors `nest g`'s "already exists" guard."""
+    if path.exists() and not force:
+        return False
+    path.parent.mkdir(parents=True, exist_ok=True)
+    path.write_text(content)
+    return True
+
+
+def ensure_package_init(directory: Path) -> None:
+    """Creates an empty ``__init__.py`` in `directory` (and does *not* recurse
+    -- callers create the full chain explicitly) if one doesn't exist yet."""
+    init_file = directory / "__init__.py"
+    if not init_file.exists():
+        directory.mkdir(parents=True, exist_ok=True)
+        init_file.write_text("")
+
+
+class ProjectNotFoundError(Exception):
+    pass
+
+
+def find_project_root(start: Path | None = None) -> Path:
+    """Walks upward from `start` (default: cwd) looking for `src/app_module.py`,
+    the marker of an Austial project root."""
+    current = (start or Path.cwd()).resolve()
+    for candidate in (current, *current.parents):
+        if (candidate / "src" / "app_module.py").exists():
+            return candidate
+    raise ProjectNotFoundError(
+        "Couldn't find an Austial project in this or any parent directory "
+        "(looked for `src/app_module.py`). Run this inside a project created "
+        "with `austial new`, or create `src/app_module.py` by hand first."
+    )

austial/cli/generators/controller_gen.py

@@ -0,0 +1,21 @@
+"""``austial generate controller <name>`` -- mirrors ``nest g controller``."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from austial.cli.generators.base import find_project_root, render, write_file
+from austial.cli.naming import to_kebab_case, to_pascal_case, to_snake_case
+
+
+def generate_controller(name: str, *, project_root: Path | None = None) -> Path:
+    root = project_root or find_project_root()
+    snake_name = to_snake_case(name)
+    class_name = to_pascal_case(name)
+    ctx = {"snake_name": snake_name, "class_name": class_name, "kebab_name": to_kebab_case(name)}
+
+    module_dir = root / "src" / "modules" / snake_name
+    write_file(module_dir / "__init__.py", "")
+    file_path = module_dir / f"{snake_name}_controller.py"
+    write_file(file_path, render("controller/controller.py.j2", **ctx))
+    return file_path

austial/cli/generators/module_gen.py

@@ -0,0 +1,30 @@
+"""``austial generate module <name>`` -- mirrors ``nest g module``."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from austial.cli.generators.app_module_patcher import register_module
+from austial.cli.generators.base import find_project_root, render, write_file
+from austial.cli.naming import to_kebab_case, to_pascal_case, to_snake_case
+
+
+def generate_module(name: str, *, project_root: Path | None = None) -> Path:
+    root = project_root or find_project_root()
+    snake_name = to_snake_case(name)
+    class_name = to_pascal_case(name)
+    ctx = {"snake_name": snake_name, "class_name": class_name, "kebab_name": to_kebab_case(name)}
+
+    module_dir = root / "src" / "modules" / snake_name
+    write_file(module_dir / "__init__.py", "")
+    file_path = module_dir / f"{snake_name}_module.py"
+    write_file(file_path, render("module/module.py.j2", **ctx))
+
+    app_module_path = root / "src" / "app_module.py"
+    if app_module_path.exists():
+        register_module(
+            app_module_path,
+            f"{class_name}Module",
+            f"from src.modules.{snake_name}.{snake_name}_module import {class_name}Module",
+        )
+    return file_path

austial/cli/generators/new_project.py

@@ -0,0 +1,67 @@
+"""``austial new <name>`` -- mirrors ``nest new <name>``."""
+
+from __future__ import annotations
+
+import subprocess
+from pathlib import Path
+
+from austial.cli.generators.base import render, write_file
+from austial.cli.naming import to_kebab_case
+
+
+def create_new_project(
+    name: str,
+    *,
+    directory: Path | None = None,
+    austial_source_path: str | None = None,
+    skip_install: bool = False,
+    skip_git: bool = False,
+) -> Path:
+    project_dir = (directory or Path.cwd() / name).resolve()
+    project_slug = to_kebab_case(name)
+    ctx = {"project_name": name, "project_slug": project_slug, "austial_source_path": austial_source_path}
+
+    write_file(project_dir / "pyproject.toml", render("project/pyproject.toml.j2", **ctx))
+    write_file(project_dir / "README.md", render("project/readme.j2", **ctx))
+    write_file(project_dir / ".env.example", render("project/env_example.j2", **ctx))
+    write_file(project_dir / ".gitignore", render("project/gitignore.j2", **ctx))
+    write_file(project_dir / ".pre-commit-config.yaml", render("project/pre_commit_config.yaml.j2", **ctx))
+
+    write_file(project_dir / "src" / "__init__.py", "")
+    write_file(project_dir / "src" / "main.py", render("project/main.py.j2", **ctx))
+    write_file(project_dir / "src" / "app_module.py", render("project/app_module.py.j2", **ctx))
+    write_file(project_dir / "src" / "app_controller.py", render("project/app_controller.py.j2", **ctx))
+    write_file(project_dir / "src" / "app_service.py", render("project/app_service.py.j2", **ctx))
+
+    write_file(project_dir / "src" / "modules" / "__init__.py", "")
+    health_dir = project_dir / "src" / "modules" / "health"
+    write_file(health_dir / "__init__.py", "")
+    write_file(health_dir / "health_module.py", render("project/modules/health/health_module.py.j2", **ctx))
+    write_file(health_dir / "health_controller.py", render("project/modules/health/health_controller.py.j2", **ctx))
+    write_file(health_dir / "health_service.py", render("project/modules/health/health_service.py.j2", **ctx))
+    write_file(health_dir / "health_dto.py", render("project/modules/health/health_dto.py.j2", **ctx))
+    write_file(health_dir / "guards" / "__init__.py", "")
+    write_file(
+        health_dir / "guards" / "api_key_guard.py",
+        render("project/modules/health/guards/api_key_guard.py.j2", **ctx),
+    )
+
+    write_file(project_dir / "tests" / "__init__.py", "")
+    write_file(project_dir / "tests" / "unit" / "__init__.py", "")
+    write_file(project_dir / "tests" / "e2e" / "__init__.py", "")
+    write_file(
+        project_dir / "tests" / "unit" / "health_service_spec.py",
+        render("project/tests/unit/health_service_spec.py.j2", **ctx),
+    )
+    write_file(
+        project_dir / "tests" / "e2e" / "app_e2e_spec.py",
+        render("project/tests/e2e/app_e2e_spec.py.j2", **ctx),
+    )
+
+    if not skip_git:
+        subprocess.run(["git", "init", "-q"], cwd=project_dir, check=False)
+
+    if not skip_install:
+        subprocess.run(["uv", "sync"], cwd=project_dir, check=False)
+
+    return project_dir

austial/cli/generators/resource_gen.py

@@ -0,0 +1,39 @@
+"""``austial generate resource <name>`` -- mirrors ``nest g resource``:
+scaffolds a full CRUD module (module + controller + service + dto + entity)
+in one shot and registers it into the nearest ``app_module.py``."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from austial.cli.generators.app_module_patcher import register_module
+from austial.cli.generators.base import find_project_root, render, write_file
+from austial.cli.naming import to_kebab_case, to_pascal_case, to_snake_case
+
+
+def generate_resource(name: str, *, project_root: Path | None = None) -> Path:
+    root = project_root or find_project_root()
+    snake_name = to_snake_case(name)
+    class_name = to_pascal_case(name)
+    ctx = {"snake_name": snake_name, "class_name": class_name, "kebab_name": to_kebab_case(name)}
+
+    module_dir = root / "src" / "modules" / snake_name
+    write_file(module_dir / "__init__.py", "")
+    write_file(module_dir / "dto" / "__init__.py", "")
+    write_file(module_dir / "entities" / "__init__.py", "")
+
+    write_file(module_dir / "entities" / f"{snake_name}_entity.py", render("resource/entity.py.j2", **ctx))
+    write_file(module_dir / "dto" / f"create_{snake_name}_dto.py", render("resource/create_dto.py.j2", **ctx))
+    write_file(module_dir / "dto" / f"update_{snake_name}_dto.py", render("resource/update_dto.py.j2", **ctx))
+    write_file(module_dir / f"{snake_name}_service.py", render("resource/service.py.j2", **ctx))
+    write_file(module_dir / f"{snake_name}_controller.py", render("resource/controller.py.j2", **ctx))
+    write_file(module_dir / f"{snake_name}_module.py", render("resource/module.py.j2", **ctx))
+
+    app_module_path = root / "src" / "app_module.py"
+    if app_module_path.exists():
+        register_module(
+            app_module_path,
+            f"{class_name}Module",
+            f"from src.modules.{snake_name}.{snake_name}_module import {class_name}Module",
+        )
+    return module_dir / f"{snake_name}_module.py"

austial/cli/generators/service_gen.py

@@ -0,0 +1,21 @@
+"""``austial generate service <name>`` -- mirrors ``nest g service``."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from austial.cli.generators.base import find_project_root, render, write_file
+from austial.cli.naming import to_kebab_case, to_pascal_case, to_snake_case
+
+
+def generate_service(name: str, *, project_root: Path | None = None) -> Path:
+    root = project_root or find_project_root()
+    snake_name = to_snake_case(name)
+    class_name = to_pascal_case(name)
+    ctx = {"snake_name": snake_name, "class_name": class_name, "kebab_name": to_kebab_case(name)}
+
+    module_dir = root / "src" / "modules" / snake_name
+    write_file(module_dir / "__init__.py", "")
+    file_path = module_dir / f"{snake_name}_service.py"
+    write_file(file_path, render("service/service.py.j2", **ctx))
+    return file_path

austial/cli/main.py

@@ -0,0 +1,133 @@
+"""``austial`` -- the CLI, mirrors the ``nest`` command.
+
+austial new my-app
+austial generate module cats      (alias: austial g module cats)
+austial generate controller cats
+austial generate service cats
+austial generate resource cats
+austial serve
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import typer
+from rich.console import Console
+
+from austial.cli.generators import (
+    create_new_project,
+    generate_controller,
+    generate_module,
+    generate_resource,
+    generate_service,
+)
+from austial.cli.generators.base import ProjectNotFoundError, find_project_root
+
+console = Console()
+app = typer.Typer(
+    name="austial",
+    help="Austial CLI -- scaffold and run NestJS-style Python projects, built on FastAPI.",
+    add_completion=False,
+    no_args_is_help=True,
+)
+
+_SCHEMATICS = {
+    "module": generate_module,
+    "controller": generate_controller,
+    "service": generate_service,
+    "resource": generate_resource,
+}
+
+
+@app.command("new")
+def new_project(
+    name: str = typer.Argument(..., help="Name of the new project/directory to create."),
+    directory: str | None = typer.Option(None, "--directory", "-d", help="Target directory (defaults to ./<name>)."),
+    skip_install: bool = typer.Option(False, "--skip-install", help="Don't run `uv sync` after scaffolding."),
+    skip_git: bool = typer.Option(False, "--skip-git", help="Don't run `git init` after scaffolding."),
+    link: str | None = typer.Option(
+        None,
+        "--link",
+        help="Path to a local Austial framework checkout to depend on via `uv`'s editable path sources "
+        "(useful before the framework is published to PyPI).",
+    ),
+) -> None:
+    """Scaffold a brand-new Austial project -- mirrors `nest new <name>`."""
+    console.print(f"[bold green]CREATE[/bold green] {name}/ ...")
+    target = Path(directory).resolve() if directory else None
+    project_dir = create_new_project(
+        name,
+        directory=target,
+        austial_source_path=link,
+        skip_install=skip_install,
+        skip_git=skip_git,
+    )
+    console.print(f"[bold green]\u2714[/bold green] Project created at [bold]{project_dir}[/bold]")
+    console.print("\nNext steps:")
+    console.print(f"  cd {project_dir.name}")
+    if skip_install:
+        console.print("  uv sync")
+    console.print("  cp .env.example .env")
+    console.print("  uv run austial serve\n")
+
+
+def _generate(schematic: str, name: str) -> None:
+    schematic = schematic.lower()
+    if schematic not in _SCHEMATICS:
+        console.print(f"[bold red]Unknown schematic[/bold red] '{schematic}'. Choose one of: {', '.join(_SCHEMATICS)}.")
+        raise typer.Exit(code=1)
+    try:
+        path = _SCHEMATICS[schematic](name)
+    except ProjectNotFoundError as exc:
+        console.print(f"[bold red]\u2716[/bold red] {exc}")
+        raise typer.Exit(code=1) from exc
+    console.print(f"[bold green]CREATE[/bold green] {path}")
+
+
+@app.command("generate")
+def generate(
+    schematic: str = typer.Argument(..., help="One of: module, controller, service, resource"),
+    name: str = typer.Argument(..., help="Name for the generated artifact, e.g. 'cats'."),
+) -> None:
+    """Generate a module/controller/service/resource -- mirrors `nest generate`."""
+    _generate(schematic, name)
+
+
+@app.command("g", hidden=True)
+def generate_alias(
+    schematic: str = typer.Argument(..., help="One of: module, controller, service, resource"),
+    name: str = typer.Argument(..., help="Name for the generated artifact, e.g. 'cats'."),
+) -> None:
+    """Alias for `generate` -- mirrors Nest CLI's `nest g`."""
+    _generate(schematic, name)
+
+
+@app.command("serve")
+def serve(
+    host: str = typer.Option("0.0.0.0", help="Bind host."),
+    port: int = typer.Option(8000, help="Bind port."),
+    reload: bool = typer.Option(True, help="Auto-reload on file changes (dev mode)."),
+) -> None:
+    """Runs the current project (mirrors `nest start --watch`)."""
+    import uvicorn
+
+    try:
+        project_root = find_project_root()
+    except ProjectNotFoundError as exc:
+        console.print(f"[bold red]\u2716[/bold red] {exc}")
+        raise typer.Exit(code=1) from exc
+
+    import sys
+
+    sys.path.insert(0, str(project_root))
+    console.print(f"[bold green]\u25b6[/bold green] Serving {project_root.name} on http://{host}:{port}")
+    uvicorn.run("src.main:app", host=host, port=port, reload=reload, app_dir=str(project_root))
+
+
+def run() -> None:
+    app()
+
+
+if __name__ == "__main__":
+    run()

austial/cli/naming.py

@@ -0,0 +1,33 @@
+"""Naming helpers shared by every generator -- turns whatever the user typed
+(``cats``, ``cat-breed``, ``CatBreed``, ``cat_breed``) into the forms needed
+for file names, class names and route prefixes, mirroring how ``nest g``
+normalizes its ``<name>`` argument."""
+
+from __future__ import annotations
+
+import re
+
+_BOUNDARY_RE = re.compile(r"[-_\s]+|(?<=[a-z0-9])(?=[A-Z])")
+
+
+def _words(name: str) -> list[str]:
+    return [w for w in _BOUNDARY_RE.split(name.strip()) if w]
+
+
+def to_snake_case(name: str) -> str:
+    return "_".join(w.lower() for w in _words(name))
+
+
+def to_kebab_case(name: str) -> str:
+    return "-".join(w.lower() for w in _words(name))
+
+
+def to_pascal_case(name: str) -> str:
+    return "".join(w.capitalize() for w in _words(name))
+
+
+def to_camel_case(name: str) -> str:
+    words = _words(name)
+    if not words:
+        return name
+    return words[0].lower() + "".join(w.capitalize() for w in words[1:])

austial/cli/templates/controller/controller.py.j2

@@ -0,0 +1,8 @@
+from austial import Controller, Get
+
+
+@Controller("{{ kebab_name }}")
+class {{ class_name }}Controller:
+    @Get()
+    async def find_all(self):
+        return []

austial/cli/templates/module/module.py.j2

@@ -0,0 +1,6 @@
+from austial import Module
+
+
+@Module()
+class {{ class_name }}Module:
+    pass

austial/cli/templates/project/app_controller.py.j2

@@ -0,0 +1,13 @@
+from austial import Controller, Get
+
+from src.app_service import AppService
+
+
+@Controller()
+class AppController:
+    def __init__(self, app_service: AppService):
+        self.app_service = app_service
+
+    @Get()
+    async def get_hello(self):
+        return self.app_service.get_hello()

austial/cli/templates/project/app_module.py.j2

@@ -0,0 +1,19 @@
+"""Root application module -- mirrors Nest's ``src/app.module.ts``."""
+
+from austial import Module
+from austial.common.middleware import LoggingMiddleware, MiddlewareConsumer
+from austial.config import ConfigModule
+
+from src.app_controller import AppController
+from src.app_service import AppService
+from src.modules.health.health_module import HealthModule
+
+
+@Module(
+    imports=[ConfigModule.for_root(), HealthModule],
+    controllers=[AppController],
+    providers=[AppService],
+)
+class AppModule:
+    def configure(self, consumer: MiddlewareConsumer) -> None:
+        consumer.apply(LoggingMiddleware).for_routes("*")

austial/cli/templates/project/app_service.py.j2

@@ -0,0 +1,7 @@
+from austial import Injectable
+
+
+@Injectable()
+class AppService:
+    def get_hello(self) -> dict:
+        return {"message": "Hello from {{ project_name }}, built with Austial!"}

austial/cli/templates/project/env_example.j2

@@ -0,0 +1,2 @@
+PORT=8000
+API_KEY=changeme

austial/cli/templates/project/gitignore.j2

@@ -0,0 +1,11 @@
+__pycache__/
+*.py[cod]
+.venv/
+.env
+*.db
+.pytest_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.egg-info/

austial/cli/templates/project/main.py.j2

@@ -0,0 +1,37 @@
+"""Application entry point -- mirrors Nest's ``src/main.ts``.
+
+Works two ways, just like a FastAPI app:
+
+* ``python src/main.py``            -> runs ``bootstrap()``, Nest-style ``app.listen()``
+* ``uvicorn src.main:app --reload``  -> `app` is already a real ASGI callable
+
+Note: building the app graph (module scanning + DI wiring) is synchronous --
+only ``app.listen()`` (actually starting the ASGI server) is async, mirroring
+where real async work happens in Nest too.
+"""
+
+import asyncio
+
+from austial import AustialApplication, AustialFactory, ValidationPipe
+from austial.common.filters import AllExceptionsFilter
+
+from src.app_module import AppModule
+
+
+def _build() -> AustialApplication:
+    app = AustialFactory.create(AppModule, title="{{ project_name }}")
+    app.use_global_pipes(ValidationPipe())
+    app.use_global_filters(AllExceptionsFilter())
+    app.enable_cors()
+    return app
+
+
+app = _build()
+
+
+async def bootstrap() -> None:
+    await app.listen(8000)
+
+
+if __name__ == "__main__":
+    asyncio.run(bootstrap())

austial/cli/templates/project/modules/health/guards/api_key_guard.py.j2

@@ -0,0 +1,13 @@
+import os
+
+from austial import CanActivate, ExecutionContext
+
+
+class ApiKeyGuard(CanActivate):
+    """Demo guard -- protects a route with a static ``x-api-key`` header,
+    the value coming from the ``API_KEY`` environment variable."""
+
+    async def can_activate(self, context: ExecutionContext) -> bool:
+        request = context.get_request()
+        expected = os.getenv("API_KEY", "changeme")
+        return request.headers.get("x-api-key") == expected

austial/cli/templates/project/modules/health/health_controller.py.j2

@@ -0,0 +1,20 @@
+from austial import Controller, Get, UseGuards
+
+from src.modules.health.guards.api_key_guard import ApiKeyGuard
+from src.modules.health.health_dto import HealthResponseDto
+from src.modules.health.health_service import HealthService
+
+
+@Controller("health")
+class HealthController:
+    def __init__(self, health_service: HealthService):
+        self.health_service = health_service
+
+    @Get()
+    async def check(self) -> HealthResponseDto:
+        return await self.health_service.check()
+
+    @Get("protected")
+    @UseGuards(ApiKeyGuard)
+    async def protected(self):
+        return {"message": "You presented a valid x-api-key header."}

austial/cli/templates/project/modules/health/health_dto.py.j2

@@ -0,0 +1,10 @@
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class HealthResponseDto(BaseModel):
+    status: str
+    info: dict[str, Any] = {}
+    error: dict[str, Any] = {}
+    details: dict[str, Any] = {}

austial/cli/templates/project/modules/health/health_module.py.j2

@@ -0,0 +1,10 @@
+from austial import Module
+
+from src.modules.health.guards.api_key_guard import ApiKeyGuard
+from src.modules.health.health_controller import HealthController
+from src.modules.health.health_service import HealthService
+
+
+@Module(controllers=[HealthController], providers=[HealthService, ApiKeyGuard])
+class HealthModule:
+    pass

austial/cli/templates/project/modules/health/health_service.py.j2

@@ -0,0 +1,19 @@
+from austial import Injectable
+from austial.terminus import HealthCheckService, MemoryHealthIndicator
+
+from src.modules.health.health_dto import HealthResponseDto
+
+
+@Injectable()
+class HealthService:
+    def __init__(self, health_check_service: HealthCheckService, memory: MemoryHealthIndicator):
+        self.health_check_service = health_check_service
+        self.memory = memory
+
+    async def check(self) -> HealthResponseDto:
+        result = await self.health_check_service.check(
+            [
+                lambda: self.memory.check_heap("memory_heap", 300 * 1024 * 1024),
+            ]
+        )
+        return HealthResponseDto(**result)

austial/cli/templates/project/pre_commit_config.yaml.j2

@@ -0,0 +1,36 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-toml
+      - id: check-merge-conflict
+      - id: check-added-large-files
+      - id: mixed-line-ending
+      - id: debug-statements
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.21
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: uv run mypy src tests
+        language: system
+        pass_filenames: false
+        types: [python]
+
+      - id: pytest
+        name: pytest
+        entry: uv run pytest -q
+        language: system
+        pass_filenames: false
+        types: [python]
+        stages: [pre-push]

austial/cli/templates/project/pyproject.toml.j2

@@ -0,0 +1,46 @@
+[project]
+name = "{{ project_slug }}"
+version = "0.1.0"
+description = "Generated with the Austial CLI (`austial new`)."
+requires-python = ">=3.11"
+dependencies = [
+    "austial>=0.1.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.2.0",
+    "pytest-asyncio>=0.23.0",
+    "httpx>=0.27.0",
+    "ruff>=0.6.0",
+    "mypy>=1.11.0",
+    "pre-commit>=3.7.0",
+]
+{% if austial_source_path %}
+
+[tool.uv.sources]
+austial = { path = "{{ austial_source_path }}", editable = true }
+{% endif %}
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+pythonpath = ["."]
+python_files = ["*_spec.py", "test_*.py", "*_test.py"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py311"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]
+ignore = ["B008"]  # function calls in default args (`Body()`, `Query()`, ... -- FastAPI's own idiom)
+
+[tool.ruff.lint.isort]
+known-first-party = ["src"]
+
+[tool.mypy]
+python_version = "3.11"
+ignore_missing_imports = true
+check_untyped_defs = true
+warn_unused_ignores = true

austial/cli/templates/project/readme.j2

@@ -0,0 +1,68 @@
+# {{ project_name }}
+
+Generated with the [Austial](https://github.com/) CLI -- a NestJS-style, batteries-included
+web framework for Python, built on FastAPI.
+
+## Project structure
+
+```
+src/
+├── main.py                 # entry point (mirrors Nest's main.ts)
+├── app_module.py            # root module (mirrors app.module.ts)
+├── app_controller.py
+├── app_service.py
+└── modules/
+    └── health/               # GET /health, GET /health/protected
+tests/
+├── unit/
+└── e2e/
+```
+
+> Note: Python can't import filenames containing dots the way Node resolves
+> `health.controller.ts`, so Austial uses `health_controller.py` /
+> `health_service.py` / `health_module.py` instead -- same one-folder-per-feature
+> layout as Nest, just underscore-suffixed file names.
+
+## Running it
+
+```bash
+uv sync
+cp .env.example .env
+uv run austial serve          # http://localhost:8000, auto-reload
+# or
+uv run python -m src.main
+```
+
+- `GET /health` -> terminus-style health check
+- `GET /health/protected` -> requires `x-api-key: <API_KEY from .env>`
+- `GET /docs` -> Swagger UI (free from FastAPI)
+
+## Generating more artifacts
+
+```bash
+uv run austial generate module cats
+uv run austial generate controller cats
+uv run austial generate service cats
+uv run austial generate resource cats   # module + CRUD controller + service + dto
+```
+
+## Tests
+
+```bash
+uv run pytest
+```
+
+## Linting, type-checking & pre-commit hooks
+
+```bash
+uv run ruff check .      # lint
+uv run ruff format .     # format
+uv run mypy src tests    # type-check
+
+uv run pre-commit install --hook-type pre-commit --hook-type pre-push
+uv run pre-commit run --all-files   # run every hook once, on demand
+```
+
+Once installed, `git commit` runs formatting/linting/type-checks automatically,
+and `git push` also runs the test suite -- mirroring a typical Nest project's
+husky + lint-staged setup.

austial/cli/templates/project/tests/e2e/app_e2e_spec.py.j2

@@ -0,0 +1,38 @@
+"""End-to-end test -- mirrors a Nest ``*.e2e-spec.ts`` test: spin up a real
+(in-process) app via ``austial.testing`` + ``httpx``'s ASGI transport, and hit
+routes exactly like a client would, no mocking of the HTTP layer at all.
+"""
+
+from __future__ import annotations
+
+import pytest
+from austial.testing import Test
+from httpx import ASGITransport, AsyncClient
+
+from src.app_controller import AppController
+from src.app_service import AppService
+from src.modules.health.health_module import HealthModule
+
+
+@pytest.mark.asyncio
+async def test_root_and_health_endpoints():
+    module = await Test.create_testing_module(
+        imports=[HealthModule],
+        controllers=[AppController],
+        providers=[AppService],
+    ).compile()
+    app = module.create_austial_application()
+    await app.init()
+
+    transport = ASGITransport(app=app)
+    async with AsyncClient(transport=transport, base_url="http://testserver") as client:
+        root_response = await client.get("/")
+        assert root_response.status_code == 200
+        assert "message" in root_response.json()
+
+        health_response = await client.get("/health")
+        assert health_response.status_code == 200
+        assert health_response.json()["status"] == "ok"
+
+        protected_denied = await client.get("/health/protected")
+        assert protected_denied.status_code == 403

austial/cli/templates/project/tests/unit/health_service_spec.py.j2

@@ -0,0 +1,35 @@
+"""Unit test for ``HealthService`` -- mirrors a typical Nest ``*.spec.ts``
+unit test: build the provider straight from the DI container (via
+``austial.testing``) instead of hand-wiring mocks, then assert on its output.
+"""
+
+from __future__ import annotations
+
+import pytest
+from austial.testing import Test
+
+from src.modules.health.health_module import HealthModule
+from src.modules.health.health_service import HealthService
+
+
+@pytest.mark.asyncio
+async def test_health_service_reports_ok_status():
+    module = await Test.create_testing_module(imports=[HealthModule]).compile()
+    service = module.get(HealthService)
+
+    result = await service.check()
+
+    assert result.status == "ok"
+    assert result.error == {}
+    assert "memory_heap" in result.info
+    assert result.info["memory_heap"]["status"] == "up"
+    assert result.details == result.info
+
+
+@pytest.mark.asyncio
+async def test_health_service_is_resolved_as_singleton():
+    module = await Test.create_testing_module(imports=[HealthModule]).compile()
+    first = module.get(HealthService)
+    second = module.get(HealthService)
+
+    assert first is second

austial/cli/templates/resource/controller.py.j2

@@ -0,0 +1,33 @@
+from austial import Body, Controller, Delete, Get, Patch, Post
+
+from src.modules.{{ snake_name }}.{{ snake_name }}_service import {{ class_name }}Service
+from src.modules.{{ snake_name }}.dto.create_{{ snake_name }}_dto import Create{{ class_name }}Dto
+from src.modules.{{ snake_name }}.dto.update_{{ snake_name }}_dto import Update{{ class_name }}Dto
+from src.modules.{{ snake_name }}.entities.{{ snake_name }}_entity import {{ class_name }}
+
+
+@Controller("{{ kebab_name }}")
+class {{ class_name }}Controller:
+    def __init__(self, service: {{ class_name }}Service):
+        self.service = service
+
+    @Post()
+    async def create(self, dto: Create{{ class_name }}Dto = Body()) -> {{ class_name }}:
+        return self.service.create(dto)
+
+    @Get()
+    async def find_all(self) -> list[{{ class_name }}]:
+        return self.service.find_all()
+
+    @Get(":id")
+    async def find_one(self, id: int) -> {{ class_name }}:
+        return self.service.find_one(id)
+
+    @Patch(":id")
+    async def update(self, id: int, dto: Update{{ class_name }}Dto = Body()) -> {{ class_name }}:
+        return self.service.update(id, dto)
+
+    @Delete(":id")
+    async def remove(self, id: int) -> dict:
+        self.service.remove(id)
+        return {"deleted": True}

austial/cli/templates/resource/create_dto.py.j2

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class Create{{ class_name }}Dto(BaseModel):
+    name: str

austial/cli/templates/resource/entity.py.j2

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class {{ class_name }}(BaseModel):
+    id: int
+    name: str

austial/cli/templates/resource/module.py.j2

@@ -0,0 +1,9 @@
+from austial import Module
+
+from src.modules.{{ snake_name }}.{{ snake_name }}_controller import {{ class_name }}Controller
+from src.modules.{{ snake_name }}.{{ snake_name }}_service import {{ class_name }}Service
+
+
+@Module(controllers=[{{ class_name }}Controller], providers=[{{ class_name }}Service])
+class {{ class_name }}Module:
+    pass

austial/cli/templates/resource/service.py.j2

@@ -0,0 +1,39 @@
+from austial import Injectable, NotFoundException
+
+from src.modules.{{ snake_name }}.dto.create_{{ snake_name }}_dto import Create{{ class_name }}Dto
+from src.modules.{{ snake_name }}.dto.update_{{ snake_name }}_dto import Update{{ class_name }}Dto
+from src.modules.{{ snake_name }}.entities.{{ snake_name }}_entity import {{ class_name }}
+
+
+@Injectable()
+class {{ class_name }}Service:
+    """In-memory CRUD store -- swap this out for a real repository backed by
+    ``austial.orm`` (SQLAlchemy) whenever you're ready."""
+
+    def __init__(self):
+        self._items: list[{{ class_name }}] = []
+        self._next_id = 1
+
+    def create(self, dto: Create{{ class_name }}Dto) -> {{ class_name }}:
+        item = {{ class_name }}(id=self._next_id, **dto.model_dump())
+        self._next_id += 1
+        self._items.append(item)
+        return item
+
+    def find_all(self) -> list[{{ class_name }}]:
+        return self._items
+
+    def find_one(self, id: int) -> {{ class_name }}:
+        for item in self._items:
+            if item.id == id:
+                return item
+        raise NotFoundException(f"{{ class_name }} #{id} not found")
+
+    def update(self, id: int, dto: Update{{ class_name }}Dto) -> {{ class_name }}:
+        item = self.find_one(id)
+        updated = item.model_copy(update=dto.model_dump(exclude_unset=True))
+        self._items[self._items.index(item)] = updated
+        return updated
+
+    def remove(self, id: int) -> None:
+        self._items.remove(self.find_one(id))

austial/cli/templates/resource/update_dto.py.j2

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class Update{{ class_name }}Dto(BaseModel):
+    name: str | None = None

austial/cli/templates/service/service.py.j2

@@ -0,0 +1,6 @@
+from austial import Injectable
+
+
+@Injectable()
+class {{ class_name }}Service:
+    pass

austial_cli-0.1.5.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: austial-cli
+Version: 0.1.5
+Summary: The `austial` scaffolding CLI (new/generate) and its Jinja2 project templates -- mirrors the separate @nestjs/cli repo.
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: rich>=13.7.0
+Requires-Dist: typer>=0.12.0

austial_cli-0.1.5.dist-info/RECORD

@@ -0,0 +1,39 @@
+austial/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+austial/cli/main.py,sha256=tJJwLzYsEKxpmOfCKOmrEFugiXo9cYlUNMr1xnDw310,4482
+austial/cli/naming.py,sha256=YoRPUVepC7vkkWIh5fNemQnCLo_ZlxWGLdtVd1hU4Xc,931
+austial/cli/generators/__init__.py,sha256=oGrEGo9Ea-EfchWQRkS1EKhaQS30pmbcE3HxP_7SRpA,468
+austial/cli/generators/app_module_patcher.py,sha256=Ye_g-NXGfoBBZMZfE3G5Y0S-o5ix9WQk1E3XREdx6Og,2340
+austial/cli/generators/base.py,sha256=2q_7i8cw4AabKGGbfsIaJT4OzXKvWBnV37FWCxXl5z4,2158
+austial/cli/generators/controller_gen.py,sha256=OnJxa2iVTTsEmRNjzcOpn5CNNreoSivHpl71nohg0RQ,854
+austial/cli/generators/module_gen.py,sha256=51VA_TnUtMNeUl2qW5pex6LYMmZYjhFBuaNXx5dmSCQ,1178
+austial/cli/generators/new_project.py,sha256=uwY3To8OAwh0HVO_NReSq8XMjnUwYc4sCF3g4CxRAK0,3077
+austial/cli/generators/resource_gen.py,sha256=ieirmz9BpyocmwENCOO7zhqyHlfBay0MeYTmR0zHWJ8,1976
+austial/cli/generators/service_gen.py,sha256=wiJrMPQwlODBCO583d1WqfueckaCHnleztT636iuEAs,836
+austial/cli/templates/controller/controller.py.j2,sha256=gtpDJbhcnFcAKgdzHiQ_bDY4aXL4WO-1a-BcA4zN--Q,163
+austial/cli/templates/module/module.py.j2,sha256=zVXUT7K2ZPI3MwCI7D0We8QlamBBydoAjKX3mk5c8qg,78
+austial/cli/templates/project/app_controller.py.j2,sha256=K74n7LaAkchOlCNsLkeW5-Y7L7HgYSs5VH21KCeDm5o,288
+austial/cli/templates/project/app_module.py.j2,sha256=2ihi2Py-UZyKKp4lrx62CJgvQt2KPfZV7jsXDsEf7N8,623
+austial/cli/templates/project/app_service.py.j2,sha256=mjmpGFx0qHYPyI-Rp-yqDPtgALvtUe5aJljQVuT4IeM,179
+austial/cli/templates/project/env_example.j2,sha256=K8oEhPY1jDh01wRAnsYG35f-x07I1QepMBOv_mgEao0,27
+austial/cli/templates/project/gitignore.j2,sha256=ijvFZR8ycFaQMN_WooPsFuptCcYJjHTmva6fT9og7FU,99
+austial/cli/templates/project/main.py.j2,sha256=Hx3fRzHE6olZpQ5J5BEso8l0IhzWruy385rZzBkwNgU,1030
+austial/cli/templates/project/pre_commit_config.yaml.j2,sha256=YKY3UqGTaR1elShJ-n1aYhcW3FVsrwNk01K3jVxwtGA,834
+austial/cli/templates/project/pyproject.toml.j2,sha256=S82kU9DCb9-k2GhB5UJY8OWvOkJua768DDZ7HHILi_0,1029
+austial/cli/templates/project/readme.j2,sha256=1Sxa1jLpnMwYrJ6LrkeNFtsBAzhnFlIbw0z6YuXTSCU,1891
+austial/cli/templates/project/modules/health/health_controller.py.j2,sha256=rn_0fTTR4EMCQswCHmrrGQaGydYH2JvYy6kFvpgqeqA,641
+austial/cli/templates/project/modules/health/health_dto.py.j2,sha256=vgzXP-JQdtjs-MPnBDfaLEaZdu3vKrmb3hibe0t82aM,203
+austial/cli/templates/project/modules/health/health_module.py.j2,sha256=Cruo9mjpEnhesdX1aGGNoTuvGqc6Og7sAWgzQseo-c0,329
+austial/cli/templates/project/modules/health/health_service.py.j2,sha256=ahd0qgNCfTDei19RW0mq1xOmKDg4Hn9mDwc0TlMfLa8,651
+austial/cli/templates/project/modules/health/guards/api_key_guard.py.j2,sha256=prKEsSRyLWIqnklDxYvpU1MvI-uVK46wTlujGC5AfZQ,458
+austial/cli/templates/project/tests/e2e/app_e2e_spec.py.j2,sha256=gzluCGMZfKaXvJFGCs1PiZ03ZAcOxO2UwTyzExCcluI,1352
+austial/cli/templates/project/tests/unit/health_service_spec.py.j2,sha256=35fliuw9aZ7taY8NFSXU0LOC5OIOUSP8sjduzzyVXjg,1123
+austial/cli/templates/resource/controller.py.j2,sha256=6Kw1qBvR8EbqzGmoWhYiryVBAnmM2Kyg4_MNeu-hTh4,1257
+austial/cli/templates/resource/create_dto.py.j2,sha256=Di0sMu7L62UKlLRijCjpMuMqlO77LgiW_X5qw-c6MoM,91
+austial/cli/templates/resource/entity.py.j2,sha256=AKIewi5gdVmLFYJii4oqSgDNCs2yCIsWNB_hyBprinM,94
+austial/cli/templates/resource/module.py.j2,sha256=kt6cdCMsQHevwdRjrvxNEf36FM727zieE2y0lFf4ouc,342
+austial/cli/templates/resource/service.py.j2,sha256=8YGe2DXAtz-LpFU0cVLWqEccJx8M4ExcJz2jdXEXMzs,1498
+austial/cli/templates/resource/update_dto.py.j2,sha256=Sp0Qq2eiK6m4-o6Z6RblVwKploS8rp0V-o9bCJVRA2k,105
+austial/cli/templates/service/service.py.j2,sha256=SJH7NUPtSkB23SDo1ILjkdjLqcSdkfIdK5EIhWErJ1w,87
+austial_cli-0.1.5.dist-info/METADATA,sha256=GrZBEHCfjBtKjEcr6fnp1A8fR7Sh27OH5xWLmLW40uk,294
+austial_cli-0.1.5.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+austial_cli-0.1.5.dist-info/RECORD,,

austial_cli-0.1.5.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any