vibetuner 2.6.1__py3-none-any.whl → 2.7.0__py3-none-any.whl

vibetuner/__init__.py

@@ -0,0 +1,2 @@
+# Your code goes here (add your code between this line and the EOF comment)
+# End of file

vibetuner/__main__.py

@@ -0,0 +1,4 @@
+from .cli import app
+
+
+app()

vibetuner/cli/__init__.py

@@ -0,0 +1,68 @@
+# ABOUTME: Core CLI setup with AsyncTyper wrapper and base configuration
+# ABOUTME: Provides main CLI entry point and logging configuration
+import inspect
+from functools import partial, wraps
+from importlib import import_module
+
+import asyncer
+import typer
+from rich.console import Console
+
+from vibetuner.cli.run import run_app
+from vibetuner.config import settings
+from vibetuner.logging import LogLevel, setup_logging
+
+
+console = Console()
+
+
+class AsyncTyper(typer.Typer):
+    def __init__(self, *args, **kwargs):
+        kwargs.setdefault("no_args_is_help", True)
+        super().__init__(*args, **kwargs)
+
+    @staticmethod
+    def maybe_run_async(decorator, f):
+        if inspect.iscoroutinefunction(f):
+
+            @wraps(f)
+            def runner(*args, **kwargs):
+                return asyncer.runnify(f)(*args, **kwargs)
+
+            decorator(runner)
+        else:
+            decorator(f)
+        return f
+
+    def callback(self, *args, **kwargs):
+        decorator = super().callback(*args, **kwargs)
+        return partial(self.maybe_run_async, decorator)
+
+    def command(self, *args, **kwargs):
+        decorator = super().command(*args, **kwargs)
+        return partial(self.maybe_run_async, decorator)
+
+
+app = AsyncTyper(help=f"{settings.project.project_name.title()} CLI")
+
+LOG_LEVEL_OPTION = typer.Option(
+    LogLevel.INFO,
+    "--log-level",
+    "-l",
+    case_sensitive=False,
+    help="Set the logging level",
+)
+
+
+@app.callback()
+def callback(log_level: LogLevel | None = LOG_LEVEL_OPTION) -> None:
+    """Initialize logging and other global settings."""
+    setup_logging(level=log_level)
+
+
+app.add_typer(run_app, name="run")
+
+try:
+    import_module("app.cli")
+except (ImportError, ModuleNotFoundError):
+    pass

vibetuner/cli/run.py

@@ -0,0 +1,161 @@
+# ABOUTME: Run commands for starting the application in different modes
+# ABOUTME: Supports dev/prod modes for frontend and worker services
+import os
+from typing import Annotated
+
+import typer
+from rich.console import Console
+
+
+console = Console()
+
+run_app = typer.Typer(
+    help="Run the application in different modes", no_args_is_help=True
+)
+
+
+@run_app.command(name="dev")
+def dev(
+    service: Annotated[
+        str, typer.Argument(help="Service to run: 'frontend' or 'worker'")
+    ] = "frontend",
+    port: int = typer.Option(
+        None, help="Port to run on (8000 for frontend, 11111 for worker)"
+    ),
+    host: str = typer.Option("0.0.0.0", help="Host to bind to (frontend only)"),  # noqa: S104
+    workers_count: int = typer.Option(
+        1, "--workers", help="Number of worker processes"
+    ),
+) -> None:
+    """Run in development mode with hot reload (frontend or worker)."""
+    os.environ["DEBUG"] = "1"
+
+    if service == "worker":
+        # Worker mode
+        from streaq.cli import main as streaq_main
+
+        worker_port = port if port else 11111
+        console.print(
+            f"[green]Starting worker in dev mode on port {worker_port}[/green]"
+        )
+        console.print("[dim]Hot reload enabled[/dim]")
+
+        if workers_count > 1:
+            console.print(
+                "[yellow]Warning: Multiple workers not supported in dev mode, using 1[/yellow]"
+            )
+
+        # Call streaq programmatically
+        streaq_main(
+            worker_path="app.tasks.worker.worker",
+            workers=1,
+            reload=True,
+            verbose=True,
+            web=True,
+            host="0.0.0.0",  # noqa: S104
+            port=worker_port,
+        )
+    elif service == "frontend":
+        # Frontend mode
+        from pathlib import Path
+
+        from granian import Granian
+        from granian.constants import Interfaces
+
+        frontend_port = port if port else 8000
+        console.print(
+            f"[green]Starting frontend in dev mode on {host}:{frontend_port}[/green]"
+        )
+        console.print("[dim]Watching for changes in src/ and templates/[/dim]")
+
+        # Define paths to watch for changes
+        reload_paths = [
+            Path("src/vibetuner"),
+            Path("src/app"),
+            Path("templates/frontend"),
+            Path("templates/email"),
+            Path("templates/markdown"),
+        ]
+
+        server = Granian(
+            target="vibetuner.frontend:app",
+            address=host,
+            port=frontend_port,
+            interface=Interfaces.ASGI,
+            workers=workers_count,
+            reload=True,
+            reload_paths=reload_paths,
+            log_level="info",
+            log_access=True,
+        )
+
+        server.serve()
+    else:
+        console.print(f"[red]Error: Unknown service '{service}'[/red]")
+        console.print("[yellow]Valid services: 'frontend' or 'worker'[/yellow]")
+        raise typer.Exit(code=1)
+
+
+@run_app.command(name="prod")
+def prod(
+    service: Annotated[
+        str, typer.Argument(help="Service to run: 'frontend' or 'worker'")
+    ] = "frontend",
+    port: int = typer.Option(
+        None, help="Port to run on (8000 for frontend, 11111 for worker)"
+    ),
+    host: str = typer.Option("0.0.0.0", help="Host to bind to (frontend only)"),  # noqa: S104
+    workers_count: int = typer.Option(
+        4, "--workers", help="Number of worker processes"
+    ),
+) -> None:
+    """Run in production mode (frontend or worker)."""
+    os.environ["ENVIRONMENT"] = "production"
+
+    if service == "worker":
+        # Worker mode
+        from streaq.cli import main as streaq_main
+
+        worker_port = port if port else 11111
+        console.print(
+            f"[green]Starting worker in prod mode on port {worker_port}[/green]"
+        )
+        console.print(f"[dim]Workers: {workers_count}[/dim]")
+
+        # Call streaq programmatically
+        streaq_main(
+            worker_path="app.tasks.worker.worker",
+            workers=workers_count,
+            reload=False,
+            verbose=False,
+            web=True,
+            host="0.0.0.0",  # noqa: S104
+            port=worker_port,
+        )
+    elif service == "frontend":
+        # Frontend mode
+        from granian import Granian
+        from granian.constants import Interfaces
+
+        frontend_port = port if port else 8000
+        console.print(
+            f"[green]Starting frontend in prod mode on {host}:{frontend_port}[/green]"
+        )
+        console.print(f"[dim]Workers: {workers_count}[/dim]")
+
+        server = Granian(
+            target="vibetuner.frontend:app",
+            address=host,
+            port=frontend_port,
+            interface=Interfaces.ASGI,
+            workers=workers_count,
+            reload=False,
+            log_level="info",
+            log_access=True,
+        )
+
+        server.serve()
+    else:
+        console.print(f"[red]Error: Unknown service '{service}'[/red]")
+        console.print("[yellow]Valid services: 'frontend' or 'worker'[/yellow]")
+        raise typer.Exit(code=1)

vibetuner/config.py

@@ -0,0 +1,128 @@
+import base64
+import hashlib
+from datetime import datetime
+from functools import cached_property
+from typing import Annotated
+
+import yaml
+from pydantic import (
+    UUID4,
+    Field,
+    HttpUrl,
+    MongoDsn,
+    RedisDsn,
+    SecretStr,
+    computed_field,
+)
+from pydantic_extra_types.language_code import LanguageAlpha2
+from pydantic_settings import BaseSettings, SettingsConfigDict
+
+from vibetuner.paths import config_vars as config_vars_path
+from vibetuner.versioning import version
+
+
+current_year: int = datetime.now().year
+
+
+def _load_project_config() -> "ProjectConfiguration":
+    if not config_vars_path.exists():
+        return ProjectConfiguration()
+    return ProjectConfiguration(
+        **yaml.safe_load(config_vars_path.read_text(encoding="utf-8"))
+    )
+
+
+class ProjectConfiguration(BaseSettings):
+    project_slug: str = "default_project"
+    project_name: str = "default_project"
+
+    project_description: str = "A default project description."
+
+    # Language Related Settings
+    supported_languages: set[LanguageAlpha2] | None = None
+    default_language: LanguageAlpha2 = LanguageAlpha2("en")
+
+    mongodb_url: MongoDsn | None = None
+    redis_url: RedisDsn | None = None
+
+    # AWS Parameters
+    aws_default_region: str = "eu-central-1"
+
+    # Company Name
+    company_name: str = "Acme Corp"
+
+    # From Email for transactional emails
+    from_email: str = "no-reply@example.com"
+
+    # Copyright
+    copyright_start: Annotated[int, Field(strict=True, gt=1714, lt=2048)] = current_year
+
+    # Analytics
+    umami_website_id: UUID4 | None = None
+
+    # Fully Qualified Domain Name
+    fqdn: str | None = None
+
+    @cached_property
+    def languages(self) -> set[str]:
+        if self.supported_languages is None:
+            return {self.language}
+
+        return {
+            str(lang) for lang in (*self.supported_languages, self.default_language)
+        }
+
+    @cached_property
+    def language(self) -> str:
+        return str(self.default_language)
+
+    @cached_property
+    def copyright(self) -> str:
+        year_part = (
+            f"{self.copyright_start}-{current_year}"
+            if self.copyright_start and self.copyright_start != current_year
+            else str(current_year)
+        )
+        return f"© {year_part}{f' {self.company_name}' if self.company_name else ''}"
+
+    model_config = SettingsConfigDict(extra="ignore")
+
+
+class CoreConfiguration(BaseSettings):
+    project: ProjectConfiguration
+
+    debug: bool = False
+    version: str = version
+    session_key: SecretStr = SecretStr("ct-!secret-must-change-me")
+
+    aws_access_key_id: SecretStr | None = None
+    aws_secret_access_key: SecretStr | None = None
+
+    r2_default_bucket_name: str | None = None
+    r2_bucket_endpoint_url: HttpUrl | None = None
+    r2_access_key: SecretStr | None = None
+    r2_secret_key: SecretStr | None = None
+    r2_default_region: str = "auto"
+
+    @computed_field
+    @cached_property
+    def v_hash(self) -> str:
+        hash_object = hashlib.sha256(self.version.encode("utf-8"))
+        hash_bytes = hash_object.digest()
+
+        b64_hash = base64.urlsafe_b64encode(hash_bytes).decode("utf-8")
+
+        url_safe_hash = b64_hash.rstrip("=")[:8]
+
+        return url_safe_hash
+
+    @cached_property
+    def mongo_dbname(self) -> str:
+        return self.project.project_slug
+
+    model_config = SettingsConfigDict(
+        case_sensitive=False, extra="ignore", env_file=".env"
+    )
+
+
+settings = CoreConfiguration(project=_load_project_config())

vibetuner/context.py

@@ -0,0 +1,25 @@
+from pydantic import UUID4, BaseModel
+
+from vibetuner.config import settings
+
+
+class Context(BaseModel):
+    DEBUG: bool = settings.debug
+
+    project_name: str = settings.project.project_name
+    project_slug: str = settings.project.project_slug
+    project_description: str = settings.project.project_description
+
+    version: str = settings.version
+    v_hash: str = settings.v_hash
+
+    copyright: str = settings.project.copyright
+
+    default_language: str = settings.project.language
+    supported_languages: set[str] = settings.project.languages
+
+    umami_website_id: UUID4 | None = settings.project.umami_website_id
+
+    fqdn: str | None = settings.project.fqdn
+
+    model_config = {"arbitrary_types_allowed": True}

vibetuner/frontend/AGENTS.md

@@ -0,0 +1,113 @@
+# Core Frontend Module
+
+**IMMUTABLE SCAFFOLDING CODE** - This is the framework's core frontend infrastructure.
+
+## What's Here
+
+This module contains the scaffolding's core frontend components:
+
+- **routes/** - Essential default routes (auth, health, debug, language, user, meta)
+- **templates.py** - Template rendering with automatic context injection
+- **deps.py** - FastAPI dependencies (authentication, language, etc.)
+- **middleware.py** - Request/response middleware
+- **oauth.py** - OAuth provider integration
+- **email.py** - Magic link email authentication
+- **lifespan.py** - Application startup/shutdown lifecycle
+- **context.py** - Request context management
+- **hotreload.py** - Development hot-reload support
+
+## Important Rules
+
+⚠️  **DO NOT MODIFY** these core frontend components directly.
+
+**For changes to core frontend:**
+
+- File an issue at `https://github.com/alltuner/scaffolding`
+- Core changes benefit all projects using the scaffolding
+
+**For your application routes:**
+
+- Create them in `src/app/frontend/routes/` instead
+- Import core components when needed:
+  - `from vibetuner.frontend.deps import get_current_user`
+  - `from vibetuner.frontend.templates import render_template`
+
+## User Route Pattern (for reference)
+
+Your application routes in `src/app/frontend/routes/` should follow this pattern:
+
+```python
+# src/app/frontend/routes/dashboard.py
+from fastapi import APIRouter, Request, Depends
+from vibetuner.frontend.deps import get_current_user
+from vibetuner.frontend.templates import render_template
+
+router = APIRouter()
+
+@router.get("/dashboard")
+async def dashboard(request: Request, user=Depends(get_current_user)):
+    return render_template("dashboard.html.jinja", request, {"user": user})
+```
+
+## Template Rendering
+
+```python
+# Automatic context in every template:
+{
+    "request": request,
+    "DEBUG": settings.DEBUG,
+    "hotreload": hotreload,  # Dev mode
+    # ... plus your custom context
+}
+```
+
+### Template Filters
+
+- `{{ datetime | timeago }}` - "2 hours ago"
+- `{{ datetime | format_date }}` - "January 15, 2024"
+- `{{ text | markdown }}` - Convert Markdown to HTML
+
+## Core Dependencies Available
+
+Import these from `vibetuner.frontend.deps`:
+
+- `get_current_user` - Require authenticated user (raises 403 if not authenticated)
+- `get_current_user_optional` - Optional auth check (returns None if not authenticated)
+- `LangDep` - Current language from cookie/header
+- `MagicCookieDep` - Magic link cookie for authentication
+
+## HTMX Patterns
+
+```html
+<!-- Partial updates -->
+<button hx-post="/api/action" hx-target="#result">Click</button>
+
+<!-- Form submission -->
+<form hx-post="/submit" hx-swap="outerHTML">...</form>
+
+<!-- Polling -->
+<div hx-get="/status" hx-trigger="every 2s">...</div>
+```
+
+## Default Routes Provided
+
+The following routes are automatically available (DO NOT MODIFY):
+
+- **/auth/*** - OAuth and magic link authentication
+- **/health/ping** - Health check endpoint
+- **/debug/** - Debug info (only in DEBUG mode)
+- **/lang/** - Language selection
+- **/user/** - User profile routes
+- **/meta/** - Metadata endpoints
+
+## Development
+
+**CRITICAL**: Both processes required:
+
+```bash
+# Terminal 1: Frontend assets
+bun dev
+
+# Terminal 2: Backend server
+just local-dev
+```

vibetuner/frontend/CLAUDE.md

@@ -0,0 +1,113 @@
+# Core Frontend Module
+
+**IMMUTABLE SCAFFOLDING CODE** - This is the framework's core frontend infrastructure.
+
+## What's Here
+
+This module contains the scaffolding's core frontend components:
+
+- **routes/** - Essential default routes (auth, health, debug, language, user, meta)
+- **templates.py** - Template rendering with automatic context injection
+- **deps.py** - FastAPI dependencies (authentication, language, etc.)
+- **middleware.py** - Request/response middleware
+- **oauth.py** - OAuth provider integration
+- **email.py** - Magic link email authentication
+- **lifespan.py** - Application startup/shutdown lifecycle
+- **context.py** - Request context management
+- **hotreload.py** - Development hot-reload support
+
+## Important Rules
+
+⚠️  **DO NOT MODIFY** these core frontend components directly.
+
+**For changes to core frontend:**
+
+- File an issue at `https://github.com/alltuner/scaffolding`
+- Core changes benefit all projects using the scaffolding
+
+**For your application routes:**
+
+- Create them in `src/app/frontend/routes/` instead
+- Import core components when needed:
+  - `from vibetuner.frontend.deps import get_current_user`
+  - `from vibetuner.frontend.templates import render_template`
+
+## User Route Pattern (for reference)
+
+Your application routes in `src/app/frontend/routes/` should follow this pattern:
+
+```python
+# src/app/frontend/routes/dashboard.py
+from fastapi import APIRouter, Request, Depends
+from vibetuner.frontend.deps import get_current_user
+from vibetuner.frontend.templates import render_template
+
+router = APIRouter()
+
+@router.get("/dashboard")
+async def dashboard(request: Request, user=Depends(get_current_user)):
+    return render_template("dashboard.html.jinja", request, {"user": user})
+```
+
+## Template Rendering
+
+```python
+# Automatic context in every template:
+{
+    "request": request,
+    "DEBUG": settings.DEBUG,
+    "hotreload": hotreload,  # Dev mode
+    # ... plus your custom context
+}
+```
+
+### Template Filters
+
+- `{{ datetime | timeago }}` - "2 hours ago"
+- `{{ datetime | format_date }}` - "January 15, 2024"
+- `{{ text | markdown }}` - Convert Markdown to HTML
+
+## Core Dependencies Available
+
+Import these from `vibetuner.frontend.deps`:
+
+- `get_current_user` - Require authenticated user (raises 403 if not authenticated)
+- `get_current_user_optional` - Optional auth check (returns None if not authenticated)
+- `LangDep` - Current language from cookie/header
+- `MagicCookieDep` - Magic link cookie for authentication
+
+## HTMX Patterns
+
+```html
+<!-- Partial updates -->
+<button hx-post="/api/action" hx-target="#result">Click</button>
+
+<!-- Form submission -->
+<form hx-post="/submit" hx-swap="outerHTML">...</form>
+
+<!-- Polling -->
+<div hx-get="/status" hx-trigger="every 2s">...</div>
+```
+
+## Default Routes Provided
+
+The following routes are automatically available (DO NOT MODIFY):
+
+- **/auth/*** - OAuth and magic link authentication
+- **/health/ping** - Health check endpoint
+- **/debug/** - Debug info (only in DEBUG mode)
+- **/lang/** - Language selection
+- **/user/** - User profile routes
+- **/meta/** - Metadata endpoints
+
+## Development
+
+**CRITICAL**: Both processes required:
+
+```bash
+# Terminal 1: Frontend assets
+bun dev
+
+# Terminal 2: Backend server
+just local-dev
+```