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

vibetuner/models/AGENTS.md

@@ -1,165 +0,0 @@
-# Core Models Module
-
-**IMMUTABLE SCAFFOLDING CODE** - These are the framework's core models that provide essential functionality.
-
-## What's Here
-
-This module contains the scaffolding's core models:
-
-- **UserModel** - Base user model with authentication support
-- **OAuthAccountModel** - OAuth provider account linking
-- **EmailVerificationTokenModel** - Magic link authentication tokens
-- **BlobModel** - File storage and blob management
-- **Mixins** - Reusable model behaviors (TimeStampMixin, etc.)
-- **Types** - Common field types and validators
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core models directly.
-
-**For changes to core models:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application models:**
-
-- Create them in `src/app/models/` instead
-- Import core models when needed: `from vibetuner.models import UserModel`
-- Use mixins from here: `from vibetuner.models.mixins import TimeStampMixin`
-
-## User Model Pattern (for reference)
-
-Your application models in `src/app/models/` should follow this pattern:
-
-```python
-from beanie import Document
-from pydantic import Field
-from vibetuner.models.mixins import TimeStampMixin
-
-class Product(Document, TimeStampMixin):
-    name: str
-    price: float = Field(gt=0)
-    stock: int = Field(ge=0)
-
-    class Settings:
-        name = "products"
-        indexes = ["name"]
-```
-
-## Available Mixins
-
-### TimeStampMixin
-
-Automatic timestamps for all models:
-
-- `db_insert_dt` - Created at (UTC)
-- `db_update_dt` - Updated at (UTC)
-- Methods: `age()`, `age_in()`, `is_older_than()`
-
-Import in your app models:
-
-```python
-from vibetuner.models.mixins import TimeStampMixin
-```
-
-## Queries
-
-### Finding Documents
-
-```python
-from beanie.operators import Eq, In, Gt, Lt
-
-# By ID (preferred method)
-product = await Product.get(product_id)
-
-# By field (use Beanie operators)
-product = await Product.find_one(Eq(Product.name, "Widget"))
-products = await Product.find(Lt(Product.price, 100)).to_list()
-
-# Multiple conditions
-results = await Product.find(
-    Eq(Product.category, "electronics"),
-    Gt(Product.price, 50)
-).to_list()
-
-# With In operator
-products = await Product.find(
-    In(Product.category, ["electronics", "gadgets"])
-).to_list()
-```
-
-### Save/Delete
-
-```python
-# Create
-product = Product(name="Widget", price=9.99, stock=100)
-await product.insert()
-
-# Update
-product.price = 19.99
-await product.save()
-
-# Delete
-await product.delete()
-```
-
-### Aggregation
-
-```python
-results = await Product.aggregate([
-    {"$match": {"price": {"$gt": 50}}},
-    {"$group": {"_id": "$category", "total": {"$sum": 1}}}
-]).to_list()
-```
-
-## Indexes
-
-```python
-from pymongo import IndexModel, TEXT
-
-class Settings:
-    indexes = [
-        "field_name",  # Simple index
-        [("field1", 1), ("field2", -1)],  # Compound index
-        IndexModel([("text_field", TEXT)])  # Text search
-    ]
-```
-
-## Relationships
-
-```python
-from beanie import Link
-
-class Order(Document):
-    user: Link[User]
-    products: list[Link[Product]]
-
-# Fetch with relations
-order = await Order.get(order_id, fetch_links=True)
-print(order.user.email)  # Automatically loaded
-```
-
-## Extending Core Models
-
-If you need to add fields to User or other core models:
-
-1. **Option A**: File an issue at `https://github.com/alltuner/scaffolding` for widely useful fields
-2. **Option B**: Create a related model in `src/app/models/` that links to the core model:
-
-```python
-from beanie import Document, Link
-from vibetuner.models import UserModel
-
-class UserProfile(Document):
-    user: Link[UserModel]
-    bio: str
-    avatar_url: str
-
-    class Settings:
-        name = "user_profiles"
-```
-
-## MongoDB MCP
-
-Claude Code has MongoDB MCP access for database operations, queries, and debugging.

vibetuner/models/CLAUDE.md

@@ -1,165 +0,0 @@
-# Core Models Module
-
-**IMMUTABLE SCAFFOLDING CODE** - These are the framework's core models that provide essential functionality.
-
-## What's Here
-
-This module contains the scaffolding's core models:
-
-- **UserModel** - Base user model with authentication support
-- **OAuthAccountModel** - OAuth provider account linking
-- **EmailVerificationTokenModel** - Magic link authentication tokens
-- **BlobModel** - File storage and blob management
-- **Mixins** - Reusable model behaviors (TimeStampMixin, etc.)
-- **Types** - Common field types and validators
-
-## Important Rules
-
-⚠️  **DO NOT MODIFY** these core models directly.
-
-**For changes to core models:**
-
-- File an issue at `https://github.com/alltuner/scaffolding`
-- Core changes benefit all projects using the scaffolding
-
-**For your application models:**
-
-- Create them in `src/app/models/` instead
-- Import core models when needed: `from vibetuner.models import UserModel`
-- Use mixins from here: `from vibetuner.models.mixins import TimeStampMixin`
-
-## User Model Pattern (for reference)
-
-Your application models in `src/app/models/` should follow this pattern:
-
-```python
-from beanie import Document
-from pydantic import Field
-from vibetuner.models.mixins import TimeStampMixin
-
-class Product(Document, TimeStampMixin):
-    name: str
-    price: float = Field(gt=0)
-    stock: int = Field(ge=0)
-
-    class Settings:
-        name = "products"
-        indexes = ["name"]
-```
-
-## Available Mixins
-
-### TimeStampMixin
-
-Automatic timestamps for all models:
-
-- `db_insert_dt` - Created at (UTC)
-- `db_update_dt` - Updated at (UTC)
-- Methods: `age()`, `age_in()`, `is_older_than()`
-
-Import in your app models:
-
-```python
-from vibetuner.models.mixins import TimeStampMixin
-```
-
-## Queries
-
-### Finding Documents
-
-```python
-from beanie.operators import Eq, In, Gt, Lt
-
-# By ID (preferred method)
-product = await Product.get(product_id)
-
-# By field (use Beanie operators)
-product = await Product.find_one(Eq(Product.name, "Widget"))
-products = await Product.find(Lt(Product.price, 100)).to_list()
-
-# Multiple conditions
-results = await Product.find(
-    Eq(Product.category, "electronics"),
-    Gt(Product.price, 50)
-).to_list()
-
-# With In operator
-products = await Product.find(
-    In(Product.category, ["electronics", "gadgets"])
-).to_list()
-```
-
-### Save/Delete
-
-```python
-# Create
-product = Product(name="Widget", price=9.99, stock=100)
-await product.insert()
-
-# Update
-product.price = 19.99
-await product.save()
-
-# Delete
-await product.delete()
-```
-
-### Aggregation
-
-```python
-results = await Product.aggregate([
-    {"$match": {"price": {"$gt": 50}}},
-    {"$group": {"_id": "$category", "total": {"$sum": 1}}}
-]).to_list()
-```
-
-## Indexes
-
-```python
-from pymongo import IndexModel, TEXT
-
-class Settings:
-    indexes = [
-        "field_name",  # Simple index
-        [("field1", 1), ("field2", -1)],  # Compound index
-        IndexModel([("text_field", TEXT)])  # Text search
-    ]
-```
-
-## Relationships
-
-```python
-from beanie import Link
-
-class Order(Document):
-    user: Link[User]
-    products: list[Link[Product]]
-
-# Fetch with relations
-order = await Order.get(order_id, fetch_links=True)
-print(order.user.email)  # Automatically loaded
-```
-
-## Extending Core Models
-
-If you need to add fields to User or other core models:
-
-1. **Option A**: File an issue at `https://github.com/alltuner/scaffolding` for widely useful fields
-2. **Option B**: Create a related model in `src/app/models/` that links to the core model:
-
-```python
-from beanie import Document, Link
-from vibetuner.models import UserModel
-
-class UserProfile(Document):
-    user: Link[UserModel]
-    bio: str
-    avatar_url: str
-
-    class Settings:
-        name = "user_profiles"
-```
-
-## MongoDB MCP
-
-Claude Code has MongoDB MCP access for database operations, queries, and debugging.

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 `src/vibetuner/tasks/worker.py` 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
-```