wappa 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

wappa/cli/examples/wappa_full_example/.dockerignore

@@ -0,0 +1,171 @@
+# ================================================================
+# DOCKERIGNORE - Optimize Docker Build Context
+# ================================================================
+
+# Version Control
+.git
+.gitignore
+.gitattributes
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.venv/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Environments
+.env.local
+.env.development
+.env.test
+.env.production
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs (keep structure but ignore actual log files)
+logs/*.log
+logs/*.txt
+*.log
+
+# Temporary files
+*.tmp
+*.temp
+.tmp/
+.temp/
+
+# Docker (keep Dockerfile for Railway)
+docker-compose*.yml
+nginx.conf
+
+# Documentation (included in image via COPY if needed)
+README.md
+docs/
+*.md
+
+# Development files
+.editorconfig
+.prettierrc
+.eslintrc*
+.flake8
+.mypy.ini
+tox.ini
+
+# CI/CD
+.github/
+.gitlab-ci.yml
+Jenkinsfile
+.travis.yml
+
+# Node.js (if any)
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Media files (selectively copied)
+# Keep app/media/ structure but ignore large files
+app/media/**/*.mov
+app/media/**/*.avi
+app/media/**/*.mkv
+app/media/**/*.mp4
+
+# Backup files
+*.bak
+*.backup
+*.old
+
+# Database files
+*.sqlite
+*.sqlite3
+*.db
+
+# Cache directories
+.cache/
+.npm/
+.yarn/
+
+# Coverage reports
+.nyc_output
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# Security files
+*.pem
+*.key
+*.crt
+*.p12
+*.pfx
+
+# Configuration overrides
+config.local.*
+.env.override

wappa/cli/examples/wappa_full_example/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

wappa/cli/examples/wappa_full_example/Dockerfile

@@ -0,0 +1,85 @@
+# ================================================================
+# WAPPA FULL EXAMPLE - RAILWAY OPTIMIZED DOCKERFILE
+# ================================================================
+# Simple, single-stage production build optimized for Railway.app
+# ================================================================
+
+FROM python:3.12-slim
+
+# Set build arguments
+ARG BUILD_DATE
+ARG VCS_REF
+
+# Labels for metadata
+LABEL org.opencontainers.image.title="Wappa Full Example"
+LABEL org.opencontainers.image.description="Production-ready WhatsApp Business API application using Wappa framework"
+LABEL org.opencontainers.image.version="1.0.0"
+LABEL org.opencontainers.image.created=$BUILD_DATE
+LABEL org.opencontainers.image.revision=$VCS_REF
+LABEL org.opencontainers.image.vendor="Mimeia"
+LABEL org.opencontainers.image.source="https://github.com/mimeia/wappa"
+LABEL maintainer="contact@mimeia.com"
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    curl \
+    ca-certificates \
+    && rm -rf /var/lib/apt/lists/* \
+    && apt-get clean
+
+# Install uv for fast Python package management
+RUN pip install --no-cache-dir uv
+
+# Create non-root user for security
+RUN groupadd --gid 1000 wappa \
+    && useradd --uid 1000 --gid 1000 --create-home --shell /bin/bash wappa
+
+# Set working directory
+WORKDIR /app
+
+# Copy dependency files
+COPY pyproject.toml ./
+COPY uv.lock ./
+
+# Install Python dependencies
+RUN uv venv /opt/venv
+ENV PATH="/opt/venv/bin:$PATH"
+RUN uv pip install --no-cache-dir -r pyproject.toml
+
+# Copy application code
+COPY --chown=wappa:wappa . .
+
+# Create required directories with proper permissions
+RUN mkdir -p /app/logs /app/media/buttons /app/media/list \
+    && chown -R wappa:wappa /app \
+    && chmod -R 755 /app
+
+# Set environment variables for production
+ENV PYTHONUNBUFFERED=1
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV ENVIRONMENT=PROD
+ENV LOG_LEVEL=INFO
+ENV PORT=8000
+
+# Health check configuration
+HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
+    CMD curl -f http://localhost:$PORT/health || exit 1
+
+# Expose application port
+EXPOSE 8000
+
+# Switch to non-root user
+USER wappa
+
+# Railway-optimized startup command
+CMD ["uv", "run", "uvicorn", "app.main:app.asgi", "--host", "0.0.0.0", "--port", "8000", "--workers", "1"]
+
+# ================================================================
+# RAILWAY DEPLOYMENT NOTES:
+# ================================================================
+# 1. Railway automatically detects this Dockerfile
+# 2. PORT environment variable is automatically set by Railway
+# 3. No need for nginx - Railway handles load balancing
+# 4. Environment variables set via Railway dashboard
+# 5. Redis can be added as a Railway plugin
+# ================================================================

wappa/cli/examples/wappa_full_example/RAILWAY_DEPLOYMENT.md

@@ -0,0 +1,366 @@
+# 🚂 Railway Deployment Guide - Wappa Full Example
+
+Simple and fast deployment of your Wappa WhatsApp Business application to Railway.app
+
+## 🚀 Quick Railway Deployment
+
+### 1. Prerequisites
+
+- Railway CLI installed: `npm install -g @railway/cli`
+- Railway account: [railway.app](https://railway.app)
+- WhatsApp Business API credentials
+
+### 2. One-Command Deployment
+
+```bash
+# Deploy to Railway
+railway up
+
+# Follow the prompts to create a new project
+```
+
+## ⚙️ Environment Variables Setup
+
+After deployment, configure these environment variables in Railway Dashboard:
+
+### Required Variables
+
+```bash
+# WhatsApp Business API
+WP_ACCESS_TOKEN=your_access_token_here
+WP_PHONE_ID=your_phone_number_id_here
+WP_BID=your_business_id_here
+WHATSAPP_WEBHOOK_VERIFY_TOKEN=your_webhook_token_here
+
+# Redis (if using Railway Redis plugin)
+REDIS_URL=redis://redis.railway.internal:6379
+
+# Optional: AI Integration
+OPENAI_API_KEY=your_openai_key_here
+```
+
+### Railway Auto-Set Variables
+
+Railway automatically configures:
+- `PORT` - Dynamic port assignment
+- `RAILWAY_ENVIRONMENT` - Environment detection
+- Domain and SSL certificates
+
+## 📡 Adding Redis
+
+### Option 1: Railway Redis Plugin
+
+```bash
+# Add Redis plugin via CLI
+railway add --plugin redis
+
+# Or via Railway Dashboard:
+# Project → Plugins → Add Redis
+```
+
+### Option 2: External Redis
+
+Set `REDIS_URL` to your external Redis provider:
+```bash
+# Redis Cloud
+REDIS_URL=redis://username:password@redis-host:port
+
+# AWS ElastiCache
+REDIS_URL=rediss://cache-cluster.amazonaws.com:6380
+
+# Upstash Redis
+REDIS_URL=rediss://username:password@host:port
+```
+
+## 🔗 Webhook Configuration
+
+After deployment, configure your WhatsApp webhook:
+
+1. **Get your Railway URL**: `https://your-app-name.up.railway.app`
+
+2. **Set webhook in Facebook Developer Console**:
+   ```
+   Webhook URL: https://your-app-name.up.railway.app/webhook/messenger/YOUR_PHONE_ID/whatsapp
+   Verify Token: your_webhook_token_here
+   ```
+
+3. **Test webhook**:
+   ```bash
+   curl "https://your-app-name.up.railway.app/health"
+   ```
+
+## 📋 Step-by-Step Setup
+
+### Step 1: Login to Railway
+
+```bash
+railway login
+```
+
+### Step 2: Initialize Project
+
+```bash
+# In your wappa_full_example directory
+railway init
+
+# Select "Create new project"
+# Choose a project name
+```
+
+### Step 3: Deploy
+
+```bash
+railway up
+```
+
+### Step 4: Configure Environment
+
+```bash
+# Set variables via CLI
+railway variables set WP_ACCESS_TOKEN=your_token
+railway variables set WP_PHONE_ID=your_phone_id
+railway variables set WP_BID=your_business_id
+railway variables set WHATSAPP_WEBHOOK_VERIFY_TOKEN=your_webhook_token
+
+# Or use Railway Dashboard for easier management
+```
+
+### Step 5: Add Redis
+
+```bash
+# Add Redis plugin
+railway add redis
+
+# Redis URL will be auto-configured as:
+# REDIS_URL=redis://redis.railway.internal:6379
+```
+
+### Step 6: Configure Custom Domain (Optional)
+
+```bash
+# Add custom domain
+railway domain
+
+# Or via Dashboard: Settings → Domains
+```
+
+## 🔍 Monitoring & Debugging
+
+### View Logs
+
+```bash
+# Real-time logs
+railway logs
+
+# Or via Railway Dashboard: Deployments → View Logs
+```
+
+### Health Checks
+
+```bash
+# Check application health
+curl https://your-app.up.railway.app/health
+
+# Detailed health check
+curl https://your-app.up.railway.app/health/detailed
+```
+
+### Environment Info
+
+```bash
+# List all variables
+railway variables
+
+# Show deployment info
+railway status
+```
+
+## 🛠️ Development Workflow
+
+### Local Development
+
+```bash
+# Link to Railway project
+railway link
+
+# Pull environment variables
+railway run --service your-service-name
+
+# Start local development
+uv run python -m app.main
+```
+
+### Deploy Updates
+
+```bash
+# Deploy latest changes
+railway up
+
+# Or enable auto-deploy via GitHub integration
+```
+
+## 📊 Scaling on Railway
+
+Railway automatically handles:
+- **Auto-scaling**: Based on CPU/memory usage
+- **Load balancing**: Multiple instance management
+- **SSL certificates**: Automatic HTTPS
+- **CDN**: Global edge caching
+
+### Manual Scaling
+
+```bash
+# Scale replicas (Pro plan required)
+railway scale --replicas 3
+```
+
+## 🚨 Troubleshooting
+
+### Common Issues
+
+#### 1. Build Fails
+
+```bash
+# Check build logs
+railway logs --deployment
+
+# Common fixes:
+# - Ensure Dockerfile is optimized
+# - Check uv.lock exists
+# - Verify Python version compatibility
+```
+
+#### 2. Environment Variables Missing
+
+```bash
+# Check current variables
+railway variables
+
+# Set missing variables
+railway variables set VARIABLE_NAME=value
+```
+
+#### 3. Redis Connection Issues
+
+```bash
+# Verify Redis plugin is added
+railway plugins
+
+# Check Redis URL format
+railway variables get REDIS_URL
+```
+
+#### 4. Webhook Not Working
+
+```bash
+# Check application logs
+railway logs
+
+# Verify webhook URL format:
+# https://your-app.up.railway.app/webhook/messenger/PHONE_ID/whatsapp
+
+# Test webhook endpoint
+curl -X GET "https://your-app.up.railway.app/webhook/messenger/YOUR_PHONE_ID/whatsapp?hub.verify_token=YOUR_TOKEN&hub.challenge=test"
+```
+
+## 💰 Railway Pricing Considerations
+
+### Hobby Plan (Free Tier)
+- $5 credit/month
+- 21 days uptime limit per month
+- 1GB RAM, 1 vCPU
+- Perfect for development/testing
+
+### Pro Plan ($20/month)
+- No usage limits
+- Custom domains
+- Multiple environments
+- Priority support
+- Auto-scaling
+
+## 🔒 Security Best Practices
+
+### Environment Variables
+- Never commit sensitive data to Git
+- Use Railway's encrypted environment variables
+- Rotate access tokens regularly
+
+### Access Control
+- Enable two-factor authentication
+- Use team management for collaboration
+- Set up deployment notifications
+
+## 📚 Useful Railway Commands
+
+```bash
+# Project management
+railway init          # Initialize new project
+railway link          # Link to existing project
+railway unlink        # Unlink from project
+
+# Deployment
+railway up            # Deploy application
+railway logs          # View application logs
+railway status        # Show deployment status
+
+# Environment
+railway variables     # List all variables
+railway variables set KEY=value  # Set variable
+railway variables delete KEY     # Delete variable
+
+# Services
+railway add redis     # Add Redis plugin
+railway remove redis  # Remove Redis plugin
+
+# Domains
+railway domain        # Manage custom domains
+railway open          # Open deployed application
+```
+
+## 🎯 Webhook URLs for WhatsApp
+
+After Railway deployment, use these URLs:
+
+```bash
+# Primary webhook URL
+https://your-app.up.railway.app/webhook/messenger/YOUR_PHONE_ID/whatsapp
+
+# Health check
+https://your-app.up.railway.app/health
+
+# API documentation
+https://your-app.up.railway.app/docs
+```
+
+## ✅ Deployment Checklist
+
+### Pre-Deployment
+- [ ] Railway CLI installed and authenticated
+- [ ] WhatsApp Business API credentials ready
+- [ ] Project tested locally
+
+### Deployment
+- [ ] `railway up` completed successfully
+- [ ] All environment variables configured
+- [ ] Redis plugin added (if needed)
+- [ ] Application health check passes
+
+### Post-Deployment
+- [ ] WhatsApp webhook configured and verified
+- [ ] Test message flow end-to-end
+- [ ] Interactive commands working (buttons, lists)
+- [ ] Monitoring and alerting configured
+
+## 🆘 Getting Help
+
+- **Railway Docs**: [docs.railway.app](https://docs.railway.app)
+- **Railway Discord**: [discord.gg/railway](https://discord.gg/railway)
+- **Wappa Framework**: [wappa.mimeia.com](https://wappa.mimeia.com)
+
+---
+
+**🚂 Your Wappa app is now live on Railway!**
+
+Railway provides the easiest path to production for your WhatsApp Business application with automatic scaling, SSL, and global CDN.
+
+**Built with ❤️ using the Wappa Framework**