@weirdfingers/baseboards 0.9.5 → 0.9.7

package/templates/api/docs/storage_providers.md

@@ -1,337 +0,0 @@
-# Storage Providers
-
-Boards supports multiple storage providers for artifact storage through a pluggable architecture. This document describes the available providers and their configuration options.
-
-## Available Providers
-
-### Local Storage
-
-The local filesystem provider is ideal for development and testing.
-
-**Features:**
-
-- Stores files on the local filesystem
-- Optional public URL serving for development
-- No external dependencies
-- Fast for small to medium files
-
-**Configuration:**
-
-```yaml
-providers:
-  local:
-    type: "local"
-    config:
-      base_path: "/tmp/boards/storage" # Storage directory
-      public_url_base: "http://localhost:8088/api/storage" # Optional: base URL for serving files
-```
-
-**Use Cases:**
-
-- Local development
-- Testing environments
-- Small deployments without cloud requirements
-
----
-
-### AWS S3
-
-The S3 provider offers robust cloud storage with optional CloudFront CDN integration.
-
-**Features:**
-
-- Scalable cloud storage
-- Server-side encryption
-- CloudFront CDN integration
-- Presigned URLs for direct client uploads
-- Multiple storage classes for cost optimization
-- Cross-region replication support
-
-**Dependencies:**
-
-```bash
-pip install boto3 aioboto3
-# or
-pip install boards-backend[storage-s3]
-```
-
-**Configuration:**
-
-```yaml
-providers:
-  s3:
-    type: "s3"
-    config:
-      bucket: "my-boards-bucket" # Required: S3 bucket name
-      region: "us-east-1" # AWS region
-      aws_access_key_id: "${AWS_ACCESS_KEY_ID}" # AWS credentials
-      aws_secret_access_key: "${AWS_SECRET_ACCESS_KEY}"
-      aws_session_token: "${AWS_SESSION_TOKEN}" # Optional: for temporary credentials
-      endpoint_url: "https://s3.amazonaws.com" # Optional: custom endpoint (for S3-compatible services)
-      cloudfront_domain: "d123.cloudfront.net" # Optional: CloudFront distribution
-      upload_config: # Optional: S3 upload parameters
-        ServerSideEncryption: "AES256"
-        StorageClass: "STANDARD"
-        # Or use KMS encryption:
-        # ServerSideEncryption: "aws:kms"
-        # SSEKMSKeyId: "arn:aws:kms:region:account:key/key-id"
-```
-
-**Environment Variables:**
-
-- `AWS_ACCESS_KEY_ID`: AWS access key (if not in config)
-- `AWS_SECRET_ACCESS_KEY`: AWS secret key (if not in config)
-- `AWS_SESSION_TOKEN`: Temporary session token (optional)
-- `AWS_REGION`: Default region (if not in config)
-
-**Use Cases:**
-
-- Production deployments
-- Large file storage
-- Global content distribution with CloudFront
-- Compliance requirements (encryption, audit trails)
-- Integration with other AWS services
-
----
-
-### Google Cloud Storage (GCS)
-
-The GCS provider integrates with Google Cloud Platform and Cloud CDN.
-
-**Features:**
-
-- Google Cloud native storage
-- Automatic encryption at rest
-- Cloud CDN integration
-- Multi-regional storage options
-- IAM integration with fine-grained permissions
-- Lifecycle management policies
-
-**Dependencies:**
-
-```bash
-pip install google-cloud-storage
-# or
-pip install boards-backend[storage-gcs]
-```
-
-**Configuration:**
-
-```yaml
-providers:
-  gcs:
-    type: "gcs"
-    config:
-      bucket: "my-boards-gcs-bucket" # Required: GCS bucket name
-      project_id: "my-gcp-project" # GCP project ID
-      # Authentication options (choose one):
-      credentials_path: "/path/to/service-account-key.json" # Service account key file
-      credentials_json: "${GCP_SERVICE_ACCOUNT_JSON}" # Service account JSON as string
-      # Or use default credentials (gcloud, environment, etc.)
-      cdn_domain: "cdn.example.com" # Optional: Cloud CDN domain
-      upload_config: # Optional: GCS upload parameters
-        cache_control: "public, max-age=3600"
-        predefined_acl: "bucket-owner-read"
-```
-
-**Authentication Methods:**
-
-1. **Service Account Key File:**
-
-   ```yaml
-   credentials_path: "/path/to/service-account-key.json"
-   ```
-
-2. **Service Account JSON String:**
-
-   ```yaml
-   credentials_json: "${GCP_SERVICE_ACCOUNT_JSON}"
-   ```
-
-3. **Default Credentials (recommended for production):**
-   - Google Cloud SDK (`gcloud auth application-default login`)
-   - Environment variable `GOOGLE_APPLICATION_CREDENTIALS`
-   - Compute Engine/GKE service accounts
-   - Cloud Run/Cloud Functions default credentials
-
-**Use Cases:**
-
-- Google Cloud Platform deployments
-- Integration with other GCP services
-- Global content distribution
-- Machine learning workflows (easy integration with AI Platform)
-- Multi-regional applications
-
----
-
-### Supabase Storage
-
-The Supabase provider integrates with Supabase's storage and authentication system.
-
-**Features:**
-
-- Integrated with Supabase auth
-- Built-in CDN
-- Row Level Security (RLS) integration
-- Real-time subscriptions
-- Automatic image transformations
-
-**Dependencies:**
-
-```bash
-pip install supabase
-```
-
-**Configuration:**
-
-```yaml
-providers:
-  supabase:
-    type: "supabase"
-    config:
-      url: "${SUPABASE_URL}" # Supabase project URL
-      key: "${SUPABASE_ANON_KEY}" # Supabase anon key
-      bucket: "boards-artifacts" # Storage bucket name
-```
-
-**Use Cases:**
-
-- Supabase-based applications
-- Real-time collaborative features
-- Integrated authentication and storage
-- Rapid prototyping
-
-## Provider Selection and Routing
-
-Boards supports intelligent provider selection through routing rules:
-
-```yaml
-routing_rules:
-  # Large files go to S3
-  - condition:
-      size_gt: "50MB"
-    provider: "s3"
-
-  # Images go to GCS with CDN
-  - condition:
-      artifact_type: "image"
-    provider: "gcs"
-
-  # Videos go to S3 for CloudFront streaming
-  - condition:
-      artifact_type: "video"
-    provider: "s3"
-
-  # Default fallback
-  - provider: "local"
-```
-
-## Best Practices
-
-### Security
-
-1. **Never hardcode credentials** in configuration files
-2. **Use environment variables** or secure credential management
-3. **Enable encryption at rest** for sensitive data
-4. **Use IAM roles** instead of access keys when possible
-5. **Implement bucket policies** for additional security
-
-### Performance
-
-1. **Choose regions close to your users** for better latency
-2. **Use CDN/CloudFront** for frequently accessed content
-3. **Consider storage classes** for cost optimization
-4. **Implement caching** at the application level
-5. **Use presigned URLs** for direct client uploads
-
-### Cost Optimization
-
-1. **Use appropriate storage classes** (Standard, IA, Glacier, etc.)
-2. **Implement lifecycle policies** for automatic data management
-3. **Monitor usage and costs** regularly
-4. **Use compression** for text-based content
-5. **Clean up unused files** periodically
-
-### Development vs Production
-
-**Development:**
-
-```yaml
-default_provider: "local"
-providers:
-  local:
-    type: "local"
-    config:
-      base_path: "/tmp/boards/storage"
-```
-
-**Production:**
-
-```yaml
-default_provider: "s3"
-providers:
-  s3:
-    type: "s3"
-    config:
-      bucket: "prod-boards-artifacts"
-      cloudfront_domain: "cdn.example.com"
-  gcs:
-    type: "gcs"
-    config:
-      bucket: "prod-boards-media"
-      cdn_domain: "media.example.com"
-```
-
-## Migration Between Providers
-
-When migrating between providers, consider:
-
-1. **Gradual migration** using routing rules
-2. **Data consistency** during the migration
-3. **URL updates** for existing references
-4. **Testing** with non-critical data first
-5. **Backup strategies** for data safety
-
-Example gradual migration:
-
-```yaml
-# Phase 1: Route new uploads to S3, keep existing on local
-routing_rules:
-  - condition:
-      artifact_type: "image"
-    provider: "s3"
-  - provider: "local"  # Existing files
-
-# Phase 2: Migrate all new uploads to S3
-routing_rules:
-  - provider: "s3"
-```
-
-## Troubleshooting
-
-### Common Issues
-
-1. **Authentication errors**: Check credentials and permissions
-2. **Bucket access denied**: Verify bucket policies and IAM permissions
-3. **Network timeouts**: Check network connectivity and endpoint URLs
-4. **Large file uploads**: Consider chunked uploads and timeout settings
-5. **CDN cache issues**: Check cache headers and purge policies
-
-### Debugging
-
-Enable debug logging:
-
-```python
-import logging
-logging.getLogger("boards.storage").setLevel(logging.DEBUG)
-```
-
-### Monitoring
-
-Key metrics to monitor:
-
-- Upload success rates
-- Download latency
-- Storage costs
-- Error rates by provider
-- CDN hit rates (if applicable)

package/templates/api/pyproject.toml

@@ -1,205 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0", "wheel"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "weirdfingers-boards"
-dynamic = ["version"]
-description = "Backend API server for Boards - AI creative toolkit with GraphQL, auth adapters, and generation workers"
-readme = "README.md"
-requires-python = ">=3.12"
-license = { text = "MIT" }
-authors = [
-    { name = "Boards Contributors", email = "ai.overlord@weirdfingers.com" },
-]
-keywords = [
-    "ai",
-    "creative",
-    "toolkit",
-    "graphql",
-    "fastapi",
-    "strawberry",
-    "auth",
-    "generation",
-]
-classifiers = [
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
-    "Topic :: Internet :: WWW/HTTP :: HTTP Servers",
-    "Topic :: Software Development :: Libraries :: Application Frameworks",
-    "Topic :: Scientific/Engineering :: Artificial Intelligence",
-    "Framework :: FastAPI",
-    "Framework :: AsyncIO",
-]
-dependencies = [
-    "sqlalchemy>=2.0.0",
-    "pydantic>=2.0.0",
-    "pydantic-settings>=2.0.0",
-    "httpx>=0.24.0",
-    "python-dotenv>=1.0.0",
-    "strawberry-graphql[fastapi]>=0.200.0",
-    "fastapi>=0.100.0",
-    "uvicorn[standard]>=0.23.0",
-    "dramatiq[redis,watch]>=1.15.0",
-    "pillow>=10.0.0",
-    "numpy>=1.24.0",
-    "psycopg[binary]>=3.1.0",
-    "structlog>=23.0.0",
-    "asyncpg>=0.29.0",
-    "alembic>=1.13.2",
-    "aiofiles>=23.0.0",
-    "pyyaml>=6.0.0",
-    "click>=8.0.0",
-    "redis>=5.0.0",
-    "pyjwt[crypto]>=2.8.0",
-    "psutil>=7.0.0",
-]
-
-[project.optional-dependencies]
-# Generator providers (per-provider)
-generators-replicate = ["replicate>=1.0.4"]
-generators-openai = ["openai>=1.60.1"]
-generators-fal = ["fal-client>=0.5.0"]
-generators-anthropic = ["anthropic>=0.25.0"]
-generators-together = ["together>=1.0.0"]
-
-# Convenience: all generators
-generators-all = [
-    "replicate>=1.0.4",
-    "openai>=1.60.1",
-    "fal-client>=0.5.0",
-    "anthropic>=0.25.0",
-    "together>=1.0.0",
-]
-
-# Storage providers (per-provider)
-storage-supabase = ["supabase>=2.0.0"]
-storage-s3 = ["boto3>=1.34.0", "aioboto3>=12.0.0"]
-storage-gcs = ["google-cloud-storage>=2.10.0"]
-
-# Convenience: all storage backends
-storage-all = [
-    "supabase>=2.0.0",
-    "boto3>=1.34.0",
-    "aioboto3>=12.0.0",
-    "google-cloud-storage>=2.10.0",
-]
-
-# Auth providers (only Supabase needs extra deps beyond core httpx/pyjwt)
-auth-supabase = ["supabase>=2.0.0"]
-
-# Convenience: everything
-all = [
-    "replicate>=1.0.4",
-    "openai>=1.60.1",
-    "fal-client>=0.5.0",
-    "anthropic>=0.25.0",
-    "together>=1.0.0",
-    "supabase>=2.0.0",
-    "boto3>=1.34.0",
-    "aioboto3>=12.0.0",
-    "google-cloud-storage>=2.10.0",
-]
-
-# Development dependencies
-dev = [
-    "pytest>=7.0.0",
-    "pytest-asyncio>=0.21.0",
-    "pytest-postgresql>=6.0.0",
-    "pytest-cov>=4.0.0",
-    "ruff>=0.1.0",
-    "pyright>=1.1.0",
-    "black>=23.0.0",
-    "pre-commit>=3.0.0",
-    # Include all provider deps for typecheck
-    "openai>=1.60.1",
-    "anthropic>=0.25.0",
-    "replicate>=1.0.4",
-    "together>=1.0.0",
-    "fal-client>=0.5.0",
-    # Include all storage deps for typecheck
-    "supabase>=2.0.0",
-    "boto3>=1.34.0",
-    "aioboto3>=12.0.0",
-    "google-cloud-storage>=2.10.0",
-    # Type stubs
-    "types-redis>=4.6.0",
-]
-
-[project.urls]
-Homepage = "https://github.com/weirdfingers/boards"
-Documentation = "https://docs.boards.io"
-Repository = "https://github.com/weirdfingers/boards"
-Issues = "https://github.com/weirdfingers/boards/issues"
-Changelog = "https://github.com/weirdfingers/boards/blob/main/CHANGELOG.md"
-
-[project.scripts]
-boards-server = "boards.cli:main"
-boards-worker = "boards.workers.cli:main"
-boards-migrate = "boards.database.cli:main"
-
-[tool.setuptools.packages.find]
-where = ["src"]
-
-[tool.ruff]
-line-length = 100
-target-version = "py312"
-exclude = ["alembic"]
-
-[tool.ruff.lint]
-select = [
-    "E",  # pycodestyle errors
-    "W",  # pycodestyle warnings
-    "F",  # pyflakes
-    "I",  # isort
-    "B",  # flake8-bugbear
-    "C4", # flake8-comprehensions
-    "UP", # pyupgrade
-]
-
-[tool.ruff.lint.per-file-ignores]
-# FastAPI uses Depends in function signatures
-"src/boards/api/**/*.py" = ["B008"]
-"tests/**/test_*.py" = ["B008"]
-# Alembic needs imports after path manipulation
-"alembic/env.py" = ["E402"]
-# __init__.py files often have unused imports for re-export
-"**/__init__.py" = ["F401"]
-
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-pythonpath = ["src"]
-asyncio_mode = "auto"
-
-[tool.setuptools.dynamic]
-version = { attr = "boards.__version__" }
-
-[tool.uv]
-dev-dependencies = [
-    "pytest>=7.0.0",
-    "pytest-asyncio>=0.21.0",
-    "pytest-postgresql>=6.0.0",
-    "pytest-cov>=4.0.0",
-    "ruff>=0.1.0",
-    "pyright>=1.1.0",
-    "black>=23.0.0",
-    "pre-commit>=3.0.0",
-    "build>=1.3.0",
-    "twine>=6.1.0",
-    "watchfiles>=1.1.0",
-    # Include all provider deps for typecheck
-    "openai>=1.60.1",
-    "anthropic>=0.25.0",
-    "replicate>=1.0.4",
-    "together>=1.0.0",
-    "fal-client>=0.5.0",
-    # Include all storage deps for typecheck
-    "boto3>=1.34.0",
-    "aioboto3>=12.0.0",
-    "google-cloud-storage>=2.10.0",
-    # Type stubs
-    "types-redis>=4.6.0",
-]

package/templates/api/src/boards/__init__.py

@@ -1,10 +0,0 @@
-"""
-Boards Backend SDK
-Open-source creative toolkit for AI-generated content
-"""
-
-__version__ = "0.9.5"
-
-from .config import settings
-
-__all__ = ["settings", "__version__"]