vibetuner 2.14.1__py3-none-any.whl → 2.18.1__py3-none-any.whl

vibetuner/services/AGENTS.md

@@ -1,104 +0,0 @@
-# Core Services Module
-
-**IMMUTABLE SCAFFOLDING CODE** - These are the framework's core services that provide essential functionality.
-
-## What's Here
-
-This module contains the scaffolding's core services:
-
-- **email.py** - Email sending via AWS SES
-- **blob.py** - File storage and blob management
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core services directly.
-
-**For changes to core services:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application services:**
-
-- Create them in `src/app/services/` instead
-- Import core services when needed: `from vibetuner.services.email import send_email`
-
-## User Service Pattern (for reference)
-
-Your application services in `src/app/services/` should follow this pattern:
-
-```python
-from vibetuner.models import UserModel
-
-class NotificationService:
-    async def send_notification(
-        self,
-        user: UserModel,
-        message: str,
-        priority: str = "normal"
-    ) -> bool:
-        # Implementation
-        return True
-
-# Singleton
-notification_service = NotificationService()
-```
-
-## Using Core Services
-
-### Email Service
-
-```python
-from vibetuner.services.email import send_email
-
-await send_email(
-    to_email="user@example.com",
-    subject="Welcome",
-    html_content="<h1>Welcome!</h1>",
-    text_content="Welcome!"
-)
-```
-
-### Blob Service
-
-```python
-from vibetuner.services.blob import blob_service
-
-# Upload file
-blob = await blob_service.upload(file_data, "image.png")
-
-# Get file URL
-url = await blob_service.get_url(blob.id)
-```
-
-## Creating Your Own Services
-
-Place your application services in `src/app/services/`:
-
-```python
-# src/app/services/external_api.py
-import httpx
-
-async def call_api(api_url: str, api_key: str, data: dict) -> dict:
-    async with httpx.AsyncClient() as client:
-        response = await client.post(
-            api_url,
-            json=data,
-            headers={"Authorization": f"Bearer {api_key}"}
-        )
-        response.raise_for_status()
-        return response.json()
-```
-
-## Dependency Injection
-
-```python
-from fastapi import Depends
-
-@router.post("/notify")
-async def notify(
-    message: str,
-    service=Depends(lambda: notification_service)
-):
-    await service.send_notification(user, message)
-```

vibetuner/services/CLAUDE.md

@@ -1,104 +0,0 @@
-# Core Services Module
-
-**IMMUTABLE SCAFFOLDING CODE** - These are the framework's core services that provide essential functionality.
-
-## What's Here
-
-This module contains the scaffolding's core services:
-
-- **email.py** - Email sending via AWS SES
-- **blob.py** - File storage and blob management
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core services directly.
-
-**For changes to core services:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application services:**
-
-- Create them in `src/app/services/` instead
-- Import core services when needed: `from vibetuner.services.email import send_email`
-
-## User Service Pattern (for reference)
-
-Your application services in `src/app/services/` should follow this pattern:
-
-```python
-from vibetuner.models import UserModel
-
-class NotificationService:
-    async def send_notification(
-        self,
-        user: UserModel,
-        message: str,
-        priority: str = "normal"
-    ) -> bool:
-        # Implementation
-        return True
-
-# Singleton
-notification_service = NotificationService()
-```
-
-## Using Core Services
-
-### Email Service
-
-```python
-from vibetuner.services.email import send_email
-
-await send_email(
-    to_email="user@example.com",
-    subject="Welcome",
-    html_content="<h1>Welcome!</h1>",
-    text_content="Welcome!"
-)
-```
-
-### Blob Service
-
-```python
-from vibetuner.services.blob import blob_service
-
-# Upload file
-blob = await blob_service.upload(file_data, "image.png")
-
-# Get file URL
-url = await blob_service.get_url(blob.id)
-```
-
-## Creating Your Own Services
-
-Place your application services in `src/app/services/`:
-
-```python
-# src/app/services/external_api.py
-import httpx
-
-async def call_api(api_url: str, api_key: str, data: dict) -> dict:
-    async with httpx.AsyncClient() as client:
-        response = await client.post(
-            api_url,
-            json=data,
-            headers={"Authorization": f"Bearer {api_key}"}
-        )
-        response.raise_for_status()
-        return response.json()
-```
-
-## Dependency Injection
-
-```python
-from fastapi import Depends
-
-@router.post("/notify")
-async def notify(
-    message: str,
-    service=Depends(lambda: notification_service)
-):
-    await service.send_notification(user, message)
-```

vibetuner/tasks/AGENTS.md

@@ -1,98 +0,0 @@
-# Core Tasks Module
-
-**IMMUTABLE SCAFFOLDING CODE** - This is the framework's core background task infrastructure.
-
-## What's Here
-
-This module contains the scaffolding's core task components:
-
-- **worker.py** - Streaq worker setup and configuration
-- **context.py** - Task context management (DB, HTTP client, etc.)
-- ****init**.py** - Task infrastructure exports
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core task components directly.
-
-**For changes to core tasks:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application tasks:**
-
-- Create them in `src/app/tasks/` instead
-- Import the worker from vibetuner: `from vibetuner.tasks.worker import worker`
-
-## Quick Reference
-
-Tasks are only available if job queue was enabled during scaffolding.
-
-The worker is defined in `vibetuner.tasks.worker` and should be imported from there in your app tasks.
-
-## User Task Pattern (for reference)
-
-Your application tasks in `src/app/tasks/` should follow this pattern:
-
-```python
-# src/app/tasks/emails.py
-from vibetuner.models import UserModel
-from vibetuner.tasks.worker import worker
-
-@worker.task()
-async def send_welcome_email(user_id: str) -> dict[str, str]:
-    """Example background job."""
-
-    # Access context
-    res = await worker.context.http_client.get(url)
-
-    if user := await UserModel.get(user_id):
-        # Perform side effects
-        return {"status": "sent", "user": user.email}
-    return {"status": "skipped"}
-```
-
-## Queueing Tasks
-
-```python
-# In your routes: src/app/frontend/routes/auth.py
-from app.tasks.emails import send_welcome_email
-
-@router.post("/signup")
-async def signup(email: str):
-    user = await create_user(email)
-
-    task = await send_welcome_email.enqueue(user.id)
-    # Optional: await task.result() or check task.id
-
-    return {"status": "registered", "job_id": task.id}
-```
-
-Note: Import your task functions from `src/app/tasks/` but the worker itself comes from `vibetuner.tasks.worker`.
-
-## Worker Management
-
-```bash
-just worker-dev    # Run worker locally with auto-reload
-```
-
-## Task Registration
-
-Add new task modules at the end of `src/app/tasks/__init__.py`:
-
-```python
-# src/app/tasks/__init__.py
-# Import your task modules so decorators register with worker
-from . import emails  # noqa: F401
-from . import new_tasks  # noqa: F401
-```
-
-## Monitoring
-
-```python
-task = await send_digest_email.enqueue(account_id)
-
-status = await task.status()
-result = await task.result(timeout=30)
-await task.abort()  # Cancel if needed
-```

vibetuner/tasks/CLAUDE.md

@@ -1,98 +0,0 @@
-# Core Tasks Module
-
-**IMMUTABLE SCAFFOLDING CODE** - This is the framework's core background task infrastructure.
-
-## What's Here
-
-This module contains the scaffolding's core task components:
-
-- **worker.py** - Streaq worker setup and configuration
-- **context.py** - Task context management (DB, HTTP client, etc.)
-- ****init**.py** - Task infrastructure exports
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core task components directly.
-
-**For changes to core tasks:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application tasks:**
-
-- Create them in `src/app/tasks/` instead
-- Import the worker from vibetuner: `from vibetuner.tasks.worker import worker`
-
-## Quick Reference
-
-Tasks are only available if job queue was enabled during scaffolding.
-
-The worker is defined in `vibetuner.tasks.worker` and should be imported from there in your app tasks.
-
-## User Task Pattern (for reference)
-
-Your application tasks in `src/app/tasks/` should follow this pattern:
-
-```python
-# src/app/tasks/emails.py
-from vibetuner.models import UserModel
-from vibetuner.tasks.worker import worker
-
-@worker.task()
-async def send_welcome_email(user_id: str) -> dict[str, str]:
-    """Example background job."""
-
-    # Access context
-    res = await worker.context.http_client.get(url)
-
-    if user := await UserModel.get(user_id):
-        # Perform side effects
-        return {"status": "sent", "user": user.email}
-    return {"status": "skipped"}
-```
-
-## Queueing Tasks
-
-```python
-# In your routes: src/app/frontend/routes/auth.py
-from app.tasks.emails import send_welcome_email
-
-@router.post("/signup")
-async def signup(email: str):
-    user = await create_user(email)
-
-    task = await send_welcome_email.enqueue(user.id)
-    # Optional: await task.result() or check task.id
-
-    return {"status": "registered", "job_id": task.id}
-```
-
-Note: Import your task functions from `src/app/tasks/` but the worker itself comes from `vibetuner.tasks.worker`.
-
-## Worker Management
-
-```bash
-just worker-dev    # Run worker locally with auto-reload
-```
-
-## Task Registration
-
-Add new task modules at the end of `src/app/tasks/__init__.py`:
-
-```python
-# src/app/tasks/__init__.py
-# Import your task modules so decorators register with worker
-from . import emails  # noqa: F401
-from . import new_tasks  # noqa: F401
-```
-
-## Monitoring
-
-```python
-task = await send_digest_email.enqueue(account_id)
-
-status = await task.status()
-result = await task.result(timeout=30)
-await task.abort()  # Cancel if needed
-```

vibetuner/templates/email/AGENTS.md

@@ -1,48 +0,0 @@
-# Core Email Templates - DO NOT MODIFY
-
-**⚠️ IMPORTANT**: Package-managed files. Changes will be lost on package updates.
-
-## How to Override
-
-**NEVER modify files in this directory!** Instead:
-
-1. Copy template to your project's `templates/email/`
-2. Maintain the same directory structure
-3. Your version overrides automatically
-
-### Example
-
-```bash
-# Core template (DO NOT EDIT, bundled in vibetuner package):
-vibetuner/templates/email/default/magic_link.html.jinja
-
-# Your override (CREATE THIS in your project):
-templates/email/default/magic_link.html.jinja
-```
-
-## Template Structure
-
-```text
-vibetuner/email/
-└── default/
-    ├── magic_link.html.jinja  # Passwordless login email (HTML)
-    └── magic_link.txt.jinja   # Passwordless login email (text)
-```
-
-## Magic Link Email
-
-The core provides magic link authentication emails used by the auth system.
-
-### Variables Available
-
-- `login_url` - The magic link URL for authentication
-- `project_name` - Your project's display name
-
-Override these templates to customize branding, styling, and content.
-
-## Best Practices
-
-1. Always provide both HTML and text versions
-2. Test overrides after scaffolding updates
-3. Keep branding consistent across all emails
-4. Use inline styles for HTML emails

vibetuner/templates/email/CLAUDE.md

@@ -1,48 +0,0 @@
-# Core Email Templates - DO NOT MODIFY
-
-**⚠️ IMPORTANT**: Package-managed files. Changes will be lost on package updates.
-
-## How to Override
-
-**NEVER modify files in this directory!** Instead:
-
-1. Copy template to your project's `templates/email/`
-2. Maintain the same directory structure
-3. Your version overrides automatically
-
-### Example
-
-```bash
-# Core template (DO NOT EDIT, bundled in vibetuner package):
-vibetuner/templates/email/default/magic_link.html.jinja
-
-# Your override (CREATE THIS in your project):
-templates/email/default/magic_link.html.jinja
-```
-
-## Template Structure
-
-```text
-vibetuner/email/
-└── default/
-    ├── magic_link.html.jinja  # Passwordless login email (HTML)
-    └── magic_link.txt.jinja   # Passwordless login email (text)
-```
-
-## Magic Link Email
-
-The core provides magic link authentication emails used by the auth system.
-
-### Variables Available
-
-- `login_url` - The magic link URL for authentication
-- `project_name` - Your project's display name
-
-Override these templates to customize branding, styling, and content.
-
-## Best Practices
-
-1. Always provide both HTML and text versions
-2. Test overrides after scaffolding updates
-3. Keep branding consistent across all emails
-4. Use inline styles for HTML emails

vibetuner/templates/frontend/AGENTS.md

@@ -1,74 +0,0 @@
-# Core Frontend Templates - DO NOT MODIFY
-
-**⚠️ IMPORTANT**: Package-managed files. Changes will be lost on package updates.
-
-## How to Override
-
-**NEVER modify files in this directory!** Instead:
-
-1. Copy template to your project's `templates/frontend/`
-2. Maintain the same directory structure
-3. Your version overrides automatically
-
-### Example
-
-```bash
-# Core template (DO NOT EDIT, bundled in vibetuner package):
-vibetuner/templates/frontend/base/footer.html.jinja
-
-# Your override (CREATE THIS in your project):
-templates/frontend/base/footer.html.jinja
-```
-
-The template system searches in order:
-
-1. `templates/frontend/` (your project overrides)
-2. `vibetuner/templates/frontend/` (package defaults)
-
-## Template Structure
-
-```text
-vibetuner/frontend/
-├── base/               # Core layout
-│   ├── skeleton.html.jinja
-│   ├── header.html.jinja
-│   ├── footer.html.jinja
-│   ├── opengraph.html.jinja
-│   └── favicons.html.jinja
-├── debug/              # Dev tools (DEBUG mode only)
-│   ├── index.html.jinja
-│   ├── info.html.jinja
-│   ├── users.html.jinja
-│   ├── collections.html.jinja
-│   └── version.html.jinja
-├── email/              # Email-related pages
-│   └── magic_link templates
-├── lang/               # Language switcher
-│   └── select.html.jinja
-├── meta/               # SEO and meta files
-│   ├── robots.txt.jinja
-│   ├── sitemap.xml.jinja
-│   ├── site.webmanifest.jinja
-│   └── browserconfig.xml.jinja
-├── user/               # User account pages
-│   ├── profile.html.jinja
-│   └── edit.html.jinja
-├── index.html.jinja        # Default homepage
-├── login.html.jinja        # Login page
-└── email_sent.html.jinja   # Magic link sent confirmation
-```
-
-## Common Overrides
-
-- `base/skeleton.html.jinja` - Add meta tags, global CSS/JS
-- `base/header.html.jinja` - Customize navigation
-- `base/footer.html.jinja` - Custom footer
-- `index.html.jinja` - Custom homepage
-
-## Best Practices
-
-1. Override only what you need
-2. Document why each override exists
-3. Test after `just update-scaffolding`
-4. Use template inheritance and blocks
-5. Keep overrides minimal to ease updates

vibetuner/templates/frontend/CLAUDE.md

@@ -1,74 +0,0 @@
-# Core Frontend Templates - DO NOT MODIFY
-
-**⚠️ IMPORTANT**: Package-managed files. Changes will be lost on package updates.
-
-## How to Override
-
-**NEVER modify files in this directory!** Instead:
-
-1. Copy template to your project's `templates/frontend/`
-2. Maintain the same directory structure
-3. Your version overrides automatically
-
-### Example
-
-```bash
-# Core template (DO NOT EDIT, bundled in vibetuner package):
-vibetuner/templates/frontend/base/footer.html.jinja
-
-# Your override (CREATE THIS in your project):
-templates/frontend/base/footer.html.jinja
-```
-
-The template system searches in order:
-
-1. `templates/frontend/` (your project overrides)
-2. `vibetuner/templates/frontend/` (package defaults)
-
-## Template Structure
-
-```text
-vibetuner/frontend/
-├── base/               # Core layout
-│   ├── skeleton.html.jinja
-│   ├── header.html.jinja
-│   ├── footer.html.jinja
-│   ├── opengraph.html.jinja
-│   └── favicons.html.jinja
-├── debug/              # Dev tools (DEBUG mode only)
-│   ├── index.html.jinja
-│   ├── info.html.jinja
-│   ├── users.html.jinja
-│   ├── collections.html.jinja
-│   └── version.html.jinja
-├── email/              # Email-related pages
-│   └── magic_link templates
-├── lang/               # Language switcher
-│   └── select.html.jinja
-├── meta/               # SEO and meta files
-│   ├── robots.txt.jinja
-│   ├── sitemap.xml.jinja
-│   ├── site.webmanifest.jinja
-│   └── browserconfig.xml.jinja
-├── user/               # User account pages
-│   ├── profile.html.jinja
-│   └── edit.html.jinja
-├── index.html.jinja        # Default homepage
-├── login.html.jinja        # Login page
-└── email_sent.html.jinja   # Magic link sent confirmation
-```
-
-## Common Overrides
-
-- `base/skeleton.html.jinja` - Add meta tags, global CSS/JS
-- `base/header.html.jinja` - Customize navigation
-- `base/footer.html.jinja` - Custom footer
-- `index.html.jinja` - Custom homepage
-
-## Best Practices
-
-1. Override only what you need
-2. Document why each override exists
-3. Test after `just update-scaffolding`
-4. Use template inheritance and blocks
-5. Keep overrides minimal to ease updates

vibetuner/templates/markdown/AGENTS.md

@@ -1,29 +0,0 @@
-# Core Markdown Templates - DO NOT MODIFY
-
-**⚠️ IMPORTANT**: Package-managed files. Changes will be lost on package updates.
-
-## How to Override
-
-**NEVER modify files in this directory!** Instead:
-
-1. Copy template to your project's `templates/markdown/`
-2. Maintain the same directory structure
-3. Your version overrides automatically
-
-### Example
-
-```bash
-# Core template (if exists, bundled in vibetuner package):
-vibetuner/templates/markdown/default/template.md.jinja
-
-# Your override (CREATE THIS in your project):
-templates/markdown/default/template.md.jinja
-```
-
-## Template Structure
-
-Currently, no core markdown templates are provided by the package.
-
-This directory is a placeholder for potential future package markdown templates.
-
-All markdown templates should be created in `templates/markdown/`.