recap-cli 1.0.0

AI Movie recap generator

🎬 RecapSaaS - AI Video Recap Generator

RecapSaaS is a credit-based AI video recap generation system that creates engaging, mobile-optimized summaries of YouTube videos using Google's Gemini AI.

✨ Features

• 📱 Mobile-Optimized: Generates 9:16 vertical videos perfect for social media
• 🗣️ Multi-Language: Support for English and Burmese voiceovers
• ⚡ Fast Processing: Optimized video processing with hardware acceleration
• 🔒 Secure: Encrypted core engine with JWT authentication
• 💳 Credit-Based: Flexible pricing with pay-per-generation model
• 🛠️ CLI Tool: Easy-to-use command-line interface
• 🔌 API Access: Full REST API for integration

🚀 Quick Start

Installation

pip install recap-cli

Setup

# Create account
recap signup

# Login
recap login

# Generate your first recap
recap generate --url "https://www.youtube.com/watch?v=VIDEO_ID"

Prerequisites

• Python 3.10 or higher
• FFmpeg for video processing
• Google Gemini API key

📖 Documentation

User Documentation

• 📚 User Guide - Complete usage instructions
• ❓ FAQ - Common questions and answers

Developer Documentation

• 🔧 Developer Guide - Architecture and development
• 🔌 API Documentation - REST API reference
• 🔒 Core Compilation - Building the encrypted core

Operations Documentation

• ⚡ Quick Setup Guide - 15-minute deployment with Aiven & x10
• 🚀 Deployment Guide - Production deployment
• 🔧 Aiven Database Setup - Aiven MySQL configuration
• 🛠️ Troubleshooting - Common issues and solutions

🏗️ Architecture

┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   CLI Client    │    │   PHP Backend   │    │  External APIs  │
│                 │    │                 │    │                 │
│ • User Interface│◄──►│ • REST API      │◄──►│ • Gemini AI     │
│ • Auth Module   │    │ • User Management│    │ • TTS Service   │
│ • API Client    │    │ • Credit System │    │ • Video Download│
│ • Video Engine  │    │ • Rate Limiting │    │                 │
└─────────────────┘    └─────────────────┘    └─────────────────┘
          │                       │
          │              ┌─────────────────┐
          │              │  Aiven MySQL    │
          └──────────────►│                 │
                         │ • Users         │
                         │ • Transactions  │
                         │ • Usage Logs    │
                         │ • Refresh Tokens│
                         │ • SSL/TLS       │
                         └─────────────────┘

Easy Deployment Options

Recommended Setup for Quick Start:

• Hosting: x10 Hosting (free tier available)
• Database: Aiven MySQL (free tier available)
• Setup Time: ~15 minutes

See Deployment Guide and Aiven Setup Guide for detailed instructions.

💳 Credit System

RecapSaaS operates on a credit-based system:

• Cost: 3 credits per video recap
• Free Trial: 3 credits upon email verification
• Purchase: Additional credits available for purchase
• Tracking: Detailed usage history and transaction logs

Credit Management

# Check balance
recap credits

# Purchase credits
recap buy

# View history
recap history

🎯 Usage Examples

Basic Usage

# Interactive generation
recap generate

# With parameters
recap generate \
  --url "https://www.youtube.com/watch?v=dQw4w9WgXcQ" \
  --speed 1.5 \
  --lang english \
  --output ./my-recaps

Advanced Usage

# Generate in Burmese with 2x speed
recap generate \
  --url "https://www.youtube.com/watch?v=VIDEO_ID" \
  --lang burmese \
  --speed 2.0

# Batch processing
for url in $(cat video_urls.txt); do
  recap generate --url "$url" --speed 1.5
done

API Integration

import requests

# Login
response = requests.post('https://api.recapsaas.com/api/auth/login', json={
    'email': '[e-mail]',
    'password': 'password123'
})
token = response.json()['data']['access_token']

# Generate recap
headers = {'Authorization': f'Bearer {token}'}
response = requests.post('https://api.recapsaas.com/api/recap/generate',
                        headers=headers, json={
    'youtube_url': 'https://www.youtube.com/watch?v=VIDEO_ID',
    'language': 'english',
    'speed': '1.5',
    'gemini_api_key': 'AIzaSy...'
})
segments = response.json()['data']['segments']

🔧 Configuration

Environment Variables

# Required
export RECAP_API_URL=https://api.recapsaas.com

# Optional
export RECAP_DEBUG=1                    # Enable debug logging
export RECAP_OUTPUT_DIR=~/recaps         # Default output directory
export RECAP_FFMPEG_PATH=/usr/bin/ffmpeg # Custom FFmpeg path

Configuration File

Create ~/.recap_cli/config.json:

{
  "api_url": "https://api.recapsaas.com",
  "default_speed": "1.5",
  "default_language": "english",
  "output_dir": "~/recaps",
  "ffmpeg_path": "/usr/bin/ffmpeg",
  "debug": false
}

🛠️ Development

Local Development Setup

# Clone repository
git clone https://github.com/your-org/recap-cli.git
cd recap-cli

# Setup Python environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e .
pip install -r requirements-dev.txt

# Setup PHP backend
cd server
composer install
cp .env.example .env
# Edit .env with your configuration

Running Tests

# Python tests
pytest

# PHP tests
cd server && phpunit

# Integration tests
pytest tests/integration/

Building Core Engine

# Compile core
python build_core.py build_ext --inplace

# Cross-platform builds
docker build -t recap-core-builder .
docker run --rm -v $(pwd):/app recap-core-builder

🚀 Deployment

CLI Distribution

# Build wheels
python -m build

# Upload to PyPI
twine upload dist/*

Backend Deployment

# Deploy to server
rsync -avz server/ user@server:/var/www/recap-api/

# Setup database
php server/index.php

# Configure web server
# See deployment guide for details

🔒 Security

Core Engine Protection

• Source Protection: Proprietary algorithms compiled to binary
• Encryption: Core engine encrypted and obfuscated
• Platform Distribution: Separate binaries for each platform
• Anti-Debugging: Basic protection against reverse engineering

API Security

• JWT Authentication: Secure token-based authentication
• Rate Limiting: Protection against abuse
• HTTPS Only: All communications encrypted
• Input Validation: Comprehensive input sanitization

📊 Monitoring

Health Checks

# API health
curl https://api.recapsaas.com/api/health

# CLI version
recap --version

Logging

# CLI logs
tail -f ~/.recap_cli/logs/recap.log

# Backend logs
tail -f /var/log/recap-api/error.log

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests
5. Submit a pull request

Code Standards

• Python: Follow PEP 8, use type hints
• PHP: Follow PSR-12, use strict types
• Tests: Maintain >90% coverage

📄 License

This project is licensed under the Commercial License - see the LICENSE file for details.

🆘 Support

Getting Help

• 📖 Documentation
• 🐛 Issues
• 💬 Discord
• 📧 Email

Response Times

• Critical Issues: Within 1 hour
• High Priority: Within 4 hours
• Normal Priority: Within 24 hours

🗺️ Roadmap

Upcoming Features

• 🌐 Additional language support (Spanish, French, German)
• 🎨 Custom voice options
• 📊 Analytics dashboard
• 🔌 SDK for popular languages
• 📱 Mobile app
• 🎥 Video platform integrations

Technical Improvements

• ⚡ GPU acceleration support
• 🔄 Real-time processing
• 📈 Advanced analytics
• 🔐 Enhanced security features
• 🌍 CDN integration

📈 Stats

• 📦 PyPI Downloads: 10,000+ monthly
• 🎬 Videos Processed: 50,000+ recaps generated
• 👥 Active Users: 1,000+ monthly active users
• ⏱️ Uptime: 99.9% uptime SLA

🙏 Acknowledgments

• Google Gemini AI - Video analysis
• FFmpeg - Video processing
• Cython - Core compilation
• Rich - CLI interface

---

Made with ❤️ by the RecapSaaS Team

Website • Documentation • Status