diff --git a/README.md b/README.md index e4b4999..b92e701 100644 --- a/README.md +++ b/README.md @@ -13,20 +13,39 @@ *Extracted from the demostar Django application, now a standalone powerhouse for video encoding, thumbnail generation, and sprite creation.* -## πŸŽ‰ **NEW in v0.3.0**: Complete Test Infrastructure! -βœ… **52 passing tests** (0 failures!) β€’ βœ… **108+ test video fixtures** β€’ βœ… **Full Docker integration** β€’ βœ… **CI/CD pipeline** +## πŸš€ **LATEST: v0.4.0 - Complete Multimedia Platform!** +πŸ€– **AI Analysis** β€’ πŸŽ₯ **AV1/HEVC/HDR** β€’ πŸ“‘ **Adaptive Streaming** β€’ 🌐 **360Β° Video Processing** β€’ βœ… **Production Ready** -[Features](#-features) β€’ -[Installation](#-installation) β€’ -[Quick Start](#-quick-start) β€’ -[Testing](#-testing) β€’ -[Examples](#-examples) β€’ -[API Reference](#-api-reference) +[πŸ“š **Full Documentation**](docs/) β€’ +[πŸš€ Features](#-features) β€’ +[⚑ Quick Start](#-quick-start) β€’ +[πŸ’» Examples](#-examples) β€’ +[πŸ”„ Migration](#-migration-to-v040) --- +## πŸ“š Documentation + +### **Complete Documentation Suite Available in [`docs/`](docs/)** + +| Documentation | Description | +|---------------|-------------| +| **[πŸ“– User Guide](docs/user-guide/)** | Complete getting started guides and feature overviews | +| **[πŸ”„ Migration](docs/migration/)** | Upgrade instructions and migration guides | +| **[πŸ› οΈ Development](docs/development/)** | Technical implementation details and architecture | +| **[πŸ“‹ Reference](docs/reference/)** | API references, roadmaps, and feature lists | +| **[πŸ’» Examples](docs/examples/)** | 11 comprehensive examples covering all features | + +### **Quick Links** +- **[πŸš€ NEW_FEATURES_v0.4.0.md](docs/user-guide/NEW_FEATURES_v0.4.0.md)** - Complete v0.4.0 feature overview +- **[πŸ“˜ README_v0.4.0.md](docs/user-guide/README_v0.4.0.md)** - Comprehensive getting started guide +- **[πŸ”„ MIGRATION_GUIDE_v0.4.0.md](docs/migration/MIGRATION_GUIDE_v0.4.0.md)** - Upgrade instructions +- **[πŸ’» Examples Documentation](docs/examples/README.md)** - Hands-on usage examples + +--- + ## ✨ Features @@ -712,6 +731,38 @@ This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) --- +## πŸ”„ Migration to v0.4.0 + +### **Upgrading from Previous Versions** + +Video Processor v0.4.0 maintains **100% backward compatibility** while adding powerful new features: + +```python +# Your existing code continues to work unchanged +processor = VideoProcessor(config) +result = await processor.process_video("video.mp4", "./output/") + +# But now you get additional features automatically: +if result.is_360_video: + print(f"360Β° projection: {result.video_360.projection_type}") + +if result.quality_analysis: + print(f"Quality score: {result.quality_analysis.overall_quality:.1f}/10") +``` + +### **New Features Available** +- **πŸ€– AI Analysis**: Automatic scene detection and quality assessment +- **πŸŽ₯ Modern Codecs**: AV1, HEVC, and HDR support +- **πŸ“‘ Streaming**: HLS and DASH adaptive streaming +- **🌐 360Β° Processing**: Complete immersive video pipeline + +### **Migration Resources** +- **[πŸ“‹ Complete Migration Guide](docs/migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions +- **[πŸš€ New Features Overview](docs/user-guide/NEW_FEATURES_v0.4.0.md)** - What's new in v0.4.0 +- **[πŸ’» Updated Examples](docs/examples/README.md)** - New capabilities in action + +--- +
### πŸ™‹β€β™€οΈ Questions? Issues? Ideas? diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..ec0f23b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,213 @@ +# πŸ“š Video Processor Documentation + +Welcome to the comprehensive documentation for **Video Processor v0.4.0** - the ultimate Python library for professional video processing and immersive media. + +## πŸ—‚οΈ Documentation Structure + +### πŸ“– [User Guide](user-guide/) +Complete guides for end users and developers getting started with the video processor. + +| Document | Description | +|----------|-------------| +| **[πŸš€ NEW_FEATURES_v0.4.0.md](user-guide/NEW_FEATURES_v0.4.0.md)** | Complete feature overview with examples for v0.4.0 | +| **[πŸ“˜ README_v0.4.0.md](user-guide/README_v0.4.0.md)** | Comprehensive getting started guide and API reference | +| **[πŸ† FINAL_PROJECT_SHOWCASE.md](user-guide/FINAL_PROJECT_SHOWCASE.md)** | Project completion showcase and achievement summary | + +### πŸ”„ [Migration & Upgrades](migration/) +Guides for upgrading between versions and migrating existing installations. + +| Document | Description | +|----------|-------------| +| **[πŸ”„ MIGRATION_GUIDE_v0.4.0.md](migration/MIGRATION_GUIDE_v0.4.0.md)** | Step-by-step upgrade instructions from previous versions | +| **[⬆️ UPGRADE.md](migration/UPGRADE.md)** | General upgrade procedures and best practices | + +### πŸ› οΈ [Development](development/) +Technical documentation for developers working on or extending the video processor. + +| Document | Description | +|----------|-------------| +| **[πŸ—οΈ COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** | Complete development history and architecture decisions | +| **[πŸ€– AI_IMPLEMENTATION_SUMMARY.md](development/AI_IMPLEMENTATION_SUMMARY.md)** | AI content analysis implementation details | +| **[πŸŽ₯ PHASE_2_CODECS_SUMMARY.md](development/PHASE_2_CODECS_SUMMARY.md)** | Advanced codec implementation (AV1, HEVC, HDR) | +| **[πŸ“‹ PROJECT_COMPLETION_v0.4.0.md](development/PROJECT_COMPLETION_v0.4.0.md)** | Project completion summary and success metrics | + +### πŸ“‹ [Reference](reference/) +API references, feature lists, and project roadmaps. + +| Document | Description | +|----------|-------------| +| **[⚑ ADVANCED_FEATURES.md](reference/ADVANCED_FEATURES.md)** | Complete list of advanced features and capabilities | +| **[πŸ—ΊοΈ ROADMAP.md](reference/ROADMAP.md)** | Project roadmap and future development plans | +| **[πŸ“ CHANGELOG.md](reference/CHANGELOG.md)** | Detailed version history and changes | + +### πŸ’» [Examples](examples/) +Comprehensive examples demonstrating all features and capabilities. + +| Category | Examples | Description | +|----------|----------|-------------| +| **πŸš€ Getting Started** | [examples/](examples/README.md) | Complete example documentation with 11 detailed examples | +| **πŸ€– AI Features** | `ai_enhanced_processing.py` | AI-powered content analysis and optimization | +| **πŸŽ₯ Advanced Codecs** | `advanced_codecs_demo.py` | AV1, HEVC, and HDR processing | +| **πŸ“‘ Streaming** | `streaming_demo.py` | Adaptive streaming (HLS/DASH) creation | +| **🌐 360Β° Video** | `360_video_examples.py` | Complete 360Β° processing with 7 examples | +| **🐳 Production** | `docker_demo.py`, `worker_compatibility.py` | Deployment and scaling | + +--- + +## 🎯 Quick Navigation + +### **New to Video Processor?** +Start here for a complete introduction: +1. **[πŸ“˜ User Guide](user-guide/README_v0.4.0.md)** - Complete getting started guide +2. **[πŸ’» Basic Examples](examples/README.md)** - Hands-on examples to get you started +3. **[πŸš€ New Features](user-guide/NEW_FEATURES_v0.4.0.md)** - What's new in v0.4.0 + +### **Upgrading from Previous Version?** +Follow our migration guides: +1. **[πŸ”„ Migration Guide](migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions +2. **[πŸ“ Changelog](reference/CHANGELOG.md)** - See what's changed + +### **Looking for Specific Features?** +- **πŸ€– AI Analysis**: [AI Implementation Summary](development/AI_IMPLEMENTATION_SUMMARY.md) +- **πŸŽ₯ Modern Codecs**: [Codec Implementation](development/PHASE_2_CODECS_SUMMARY.md) +- **πŸ“‘ Streaming**: [Streaming Examples](examples/README.md#-streaming-examples) +- **🌐 360Β° Video**: [360Β° Examples](examples/README.md#-360-video-processing) + +### **Need Technical Details?** +- **πŸ—οΈ Architecture**: [Development Summary](development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md) +- **⚑ Advanced Features**: [Feature Reference](reference/ADVANCED_FEATURES.md) +- **πŸ—ΊοΈ Roadmap**: [Future Plans](reference/ROADMAP.md) + +--- + +## 🎬 Video Processor Capabilities + +The Video Processor v0.4.0 provides a complete multimedia processing platform with four integrated phases: + +### **πŸ€– Phase 1: AI-Powered Content Analysis** +- Intelligent scene detection and boundary identification +- Comprehensive quality assessment (sharpness, brightness, contrast) +- Motion analysis with intensity scoring +- AI-powered thumbnail selection for optimal engagement +- 360Β° content intelligence with automatic detection + +### **πŸŽ₯ Phase 2: Next-Generation Codecs** +- **AV1 encoding** with 50% better compression than H.264 +- **HEVC/H.265** support with hardware acceleration +- **HDR10 processing** with tone mapping and metadata preservation +- **Multi-color space** support (Rec.2020, P3, sRGB) +- **Two-pass optimization** for intelligent bitrate allocation + +### **πŸ“‘ Phase 3: Adaptive Streaming** +- **HLS & DASH** adaptive streaming with multi-bitrate support +- **Smart bitrate ladders** based on content analysis +- **Real-time processing** with Procrastinate async tasks +- **Multi-device optimization** for mobile, desktop, TV +- **Progressive upload** capabilities + +### **🌐 Phase 4: Complete 360Β° Video Processing** +- **Multi-projection support**: Equirectangular, Cubemap, EAC, Stereographic, Fisheye +- **Spatial audio processing**: Ambisonic, binaural, object-based, head-locked +- **Viewport-adaptive streaming** with up to 75% bandwidth savings +- **Tiled encoding** for streaming only visible regions +- **Stereoscopic 3D** support for immersive content + +--- + +## πŸš€ Quick Start + +### **Installation** +```bash +# Install with all features +uv add video-processor[all] + +# Or install specific feature sets +uv add video-processor[ai,360,streaming] +``` + +### **Basic Usage** +```python +from video_processor import VideoProcessor +from video_processor.config import ProcessorConfig + +# Initialize with all features +config = ProcessorConfig( + quality_preset="high", + enable_ai_analysis=True, + enable_360_processing=True, + output_formats=["mp4", "av1_mp4"] +) + +processor = VideoProcessor(config) + +# Process any video (2D or 360Β°) with full analysis +result = await processor.process_video("input.mp4", "./output/") + +# Automatic optimization based on content type +if result.is_360_video: + print(f"🌐 360Β° {result.video_360.projection_type} processed") +else: + print("πŸŽ₯ Standard video processed with AI analysis") + +print(f"Quality: {result.quality_analysis.overall_quality:.1f}/10") +``` + +For complete examples, see the **[Examples Documentation](examples/README.md)**. + +--- + +## πŸ”§ Development & Contributing + +### **Development Setup** +```bash +git clone https://git.supported.systems/MCP/video-processor +cd video-processor +uv sync --dev +``` + +### **Running Tests** +```bash +# Full test suite +uv run pytest + +# Specific feature tests +uv run pytest tests/test_360_basic.py -v +uv run pytest tests/unit/test_ai_content_analyzer.py -v +``` + +### **Code Quality** +```bash +uv run ruff check . # Linting +uv run mypy src/ # Type checking +uv run ruff format . # Code formatting +``` + +See the **[Development Documentation](development/)** for detailed technical information. + +--- + +## 🀝 Community & Support + +- **πŸ“– Documentation**: You're here! Complete guides and references +- **πŸ’» Examples**: [examples/](examples/) - 11 comprehensive examples +- **πŸ› Issues**: Report bugs and request features on the repository +- **πŸš€ Discussions**: Share use cases and get help from the community +- **πŸ“§ Support**: Tag issues with appropriate labels for faster response + +--- + +## πŸ“œ License + +MIT License - see [LICENSE](../LICENSE) for details. + +--- + +
+ +**🎬 Video Processor v0.4.0** + +*From Simple Encoding to Immersive Experiences* + +**Complete Multimedia Processing Platform** | **Production Ready** | **Open Source** + +
\ No newline at end of file diff --git a/AI_IMPLEMENTATION_SUMMARY.md b/docs/development/AI_IMPLEMENTATION_SUMMARY.md similarity index 100% rename from AI_IMPLEMENTATION_SUMMARY.md rename to docs/development/AI_IMPLEMENTATION_SUMMARY.md diff --git a/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md b/docs/development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md similarity index 100% rename from COMPREHENSIVE_DEVELOPMENT_SUMMARY.md rename to docs/development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md diff --git a/PHASE_2_CODECS_SUMMARY.md b/docs/development/PHASE_2_CODECS_SUMMARY.md similarity index 100% rename from PHASE_2_CODECS_SUMMARY.md rename to docs/development/PHASE_2_CODECS_SUMMARY.md diff --git a/PROJECT_COMPLETION_v0.4.0.md b/docs/development/PROJECT_COMPLETION_v0.4.0.md similarity index 98% rename from PROJECT_COMPLETION_v0.4.0.md rename to docs/development/PROJECT_COMPLETION_v0.4.0.md index 3a5ec4f..d6c32dd 100644 --- a/PROJECT_COMPLETION_v0.4.0.md +++ b/docs/development/PROJECT_COMPLETION_v0.4.0.md @@ -219,9 +219,9 @@ This project has successfully evolved from a **simple video processor** extracte ## πŸ“š Documentation Excellence ### **User Documentation** -- **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)**: Comprehensive feature overview with examples -- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)**: Step-by-step upgrade instructions -- **[README_v0.4.0.md](README_v0.4.0.md)**: Complete getting started guide +- **[NEW_FEATURES_v0.4.0.md](../user-guide/NEW_FEATURES_v0.4.0.md)**: Comprehensive feature overview with examples +- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)**: Step-by-step upgrade instructions +- **[README_v0.4.0.md](../user-guide/README_v0.4.0.md)**: Complete getting started guide - **20+ Examples**: Real-world usage patterns and workflows ### **Developer Documentation** diff --git a/docs/examples/README.md b/docs/examples/README.md new file mode 100644 index 0000000..d11b12b --- /dev/null +++ b/docs/examples/README.md @@ -0,0 +1,200 @@ +# πŸ“š Examples Documentation + +This directory contains comprehensive examples demonstrating all features of the Video Processor v0.4.0. + +## πŸš€ Getting Started Examples + +### [basic_usage.py](../../examples/basic_usage.py) +**Start here!** Shows the fundamental video processing workflow with the main `VideoProcessor` class. + +```python +# Simple video processing +processor = VideoProcessor(config) +result = await processor.process_video("input.mp4", "./output/") +``` + +### [custom_config.py](../../examples/custom_config.py) +Demonstrates advanced configuration options and quality presets. + +```python +# Custom configuration for different use cases +config = ProcessorConfig( + quality_preset="ultra", + output_formats=["mp4", "av1_mp4"], + enable_ai_analysis=True +) +``` + +## πŸ€– AI-Powered Features + +### [ai_enhanced_processing.py](../../examples/ai_enhanced_processing.py) +Complete AI content analysis with scene detection and quality assessment. + +```python +# AI-powered content analysis +analysis = await analyzer.analyze_content(video_path) +print(f"Scenes: {analysis.scenes.scene_count}") +print(f"Quality: {analysis.quality_metrics.overall_quality}") +``` + +## πŸŽ₯ Advanced Codec Examples + +### [advanced_codecs_demo.py](../../examples/advanced_codecs_demo.py) +Demonstrates AV1, HEVC, and HDR processing capabilities. + +```python +# Modern codec encoding +config = ProcessorConfig( + output_formats=["mp4", "av1_mp4", "hevc"], + enable_av1_encoding=True, + enable_hdr_processing=True +) +``` + +## πŸ“‘ Streaming Examples + +### [streaming_demo.py](../../examples/streaming_demo.py) +Shows how to create adaptive streaming packages (HLS/DASH) for web delivery. + +```python +# Create adaptive streaming +streaming_package = await stream_processor.create_adaptive_stream( + video_path, output_dir, formats=["hls", "dash"] +) +``` + +## 🌐 360Β° Video Processing + +### [360_video_examples.py](../../examples/360_video_examples.py) +**Comprehensive 360Β° showcase** with 7 detailed examples: + +1. **Basic 360Β° Analysis** - Detect and analyze spherical videos +2. **Projection Conversion** - Convert between equirectangular, cubemap, etc. +3. **Viewport Extraction** - Extract flat videos from specific viewing angles +4. **Spatial Audio Processing** - Handle ambisonic and binaural audio +5. **360Β° Adaptive Streaming** - Viewport-adaptive streaming with bandwidth optimization +6. **Batch Processing** - Convert multiple projections in parallel +7. **Quality Analysis** - Assess 360Β° video quality and get optimization recommendations + +### [video_360_example.py](../../examples/video_360_example.py) +Focused example showing core 360Β° processing features. + +## 🐳 Production Deployment + +### [docker_demo.py](../../examples/docker_demo.py) +Production deployment with Docker containers and environment configuration. + +### [worker_compatibility.py](../../examples/worker_compatibility.py) +Distributed processing with Procrastinate workers for scalable deployments. + +### [async_processing.py](../../examples/async_processing.py) +Advanced async patterns for high-throughput video processing. + +## 🌐 Web Integration + +### [web_demo.py](../../examples/web_demo.py) +Flask web application demonstrating video processing API integration. + +```python +# Web API endpoint +@app.post("/process") +async def process_video_api(file: UploadFile): + result = await processor.process_video(file.path, output_dir) + return {"status": "success", "formats": list(result.encoded_files.keys())} +``` + +## πŸƒβ€β™‚οΈ Running the Examples + +### Prerequisites +```bash +# Install with all features +uv add video-processor[all] + +# Or install specific feature sets +uv add video-processor[ai,360,streaming] +``` + +### Basic Examples +```bash +# Run basic usage example +uv run python examples/basic_usage.py + +# Test AI analysis +uv run python examples/ai_enhanced_processing.py + +# Try 360Β° processing +uv run python examples/360_video_examples.py +``` + +### Advanced Examples +```bash +# Set up Docker environment +uv run python examples/docker_demo.py + +# Test streaming capabilities +uv run python examples/streaming_demo.py + +# Run web demo (requires Flask) +uv add flask +uv run python examples/web_demo.py +``` + +## 🎯 Example Categories + +| Category | Examples | Features Demonstrated | +|----------|----------|----------------------| +| **Basics** | `basic_usage.py`, `custom_config.py` | Core processing, configuration | +| **AI Features** | `ai_enhanced_processing.py` | Scene detection, quality analysis | +| **Modern Codecs** | `advanced_codecs_demo.py` | AV1, HEVC, HDR processing | +| **Streaming** | `streaming_demo.py` | HLS, DASH adaptive streaming | +| **360Β° Video** | `360_video_examples.py`, `video_360_example.py` | Immersive video processing | +| **Production** | `docker_demo.py`, `worker_compatibility.py` | Deployment, scaling | +| **Integration** | `web_demo.py`, `async_processing.py` | Web APIs, async patterns | + +## πŸ’‘ Tips for Learning + +1. **Start Simple**: Begin with `basic_usage.py` to understand the core concepts +2. **Progress Gradually**: Move through AI β†’ Codecs β†’ Streaming β†’ 360Β° features +3. **Experiment**: Modify the examples with your own video files +4. **Check Logs**: Enable logging to see detailed processing information +5. **Read Comments**: Each example includes detailed explanations and best practices + +## πŸ”§ Troubleshooting + +### Common Issues + +**Missing Dependencies** +```bash +# AI features require OpenCV +pip install opencv-python + +# 360Β° processing needs additional packages +pip install numpy opencv-python +``` + +**FFmpeg Not Found** +```bash +# Install FFmpeg (varies by OS) +# Ubuntu/Debian: sudo apt install ffmpeg +# macOS: brew install ffmpeg +# Windows: Download from ffmpeg.org +``` + +**Import Errors** +```bash +# Ensure video-processor is installed +uv add video-processor + +# For development +uv sync --dev +``` + +### Getting Help + +- Check the [migration guide](../migration/MIGRATION_GUIDE_v0.4.0.md) for upgrade instructions +- See [user guide](../user-guide/NEW_FEATURES_v0.4.0.md) for complete feature documentation +- Review [development docs](../development/) for technical implementation details + +--- + +*These examples demonstrate the full capabilities of Video Processor v0.4.0 - from simple format conversion to advanced 360Β° immersive experiences with AI optimization.* \ No newline at end of file diff --git a/MIGRATION_GUIDE_v0.4.0.md b/docs/migration/MIGRATION_GUIDE_v0.4.0.md similarity index 100% rename from MIGRATION_GUIDE_v0.4.0.md rename to docs/migration/MIGRATION_GUIDE_v0.4.0.md diff --git a/UPGRADE.md b/docs/migration/UPGRADE.md similarity index 94% rename from UPGRADE.md rename to docs/migration/UPGRADE.md index 7578dba..9c8ed33 100644 --- a/UPGRADE.md +++ b/docs/migration/UPGRADE.md @@ -163,9 +163,9 @@ uv run pytest --collect-only ### πŸ“š Additional Resources -- **[CHANGELOG.md](CHANGELOG.md)** - Complete list of changes -- **[README.md](README.md)** - Updated documentation -- **[tests/README.md](tests/README.md)** - Testing guide +- **[CHANGELOG.md](../reference/CHANGELOG.md)** - Complete list of changes +- **[README.md](../../README.md)** - Updated documentation +- **[tests/README.md](../../tests/README.md)** - Testing guide - **[Makefile](Makefile)** - Available commands ### πŸŽ‰ Benefits of Upgrading @@ -179,7 +179,7 @@ uv run pytest --collect-only If you encounter any issues during the upgrade: 1. Check this upgrade guide first -2. Review the [CHANGELOG.md](CHANGELOG.md) for detailed changes +2. Review the [CHANGELOG.md](../reference/CHANGELOG.md) for detailed changes 3. Run the test suite to verify functionality 4. Open an issue if problems persist diff --git a/ADVANCED_FEATURES.md b/docs/reference/ADVANCED_FEATURES.md similarity index 100% rename from ADVANCED_FEATURES.md rename to docs/reference/ADVANCED_FEATURES.md diff --git a/CHANGELOG.md b/docs/reference/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to docs/reference/CHANGELOG.md diff --git a/ROADMAP.md b/docs/reference/ROADMAP.md similarity index 100% rename from ROADMAP.md rename to docs/reference/ROADMAP.md diff --git a/FINAL_PROJECT_SHOWCASE.md b/docs/user-guide/FINAL_PROJECT_SHOWCASE.md similarity index 98% rename from FINAL_PROJECT_SHOWCASE.md rename to docs/user-guide/FINAL_PROJECT_SHOWCASE.md index bc3c4f4..449caa4 100644 --- a/FINAL_PROJECT_SHOWCASE.md +++ b/docs/user-guide/FINAL_PROJECT_SHOWCASE.md @@ -320,12 +320,12 @@ async def create_vr_trailer(source_360_video): ### **πŸ“– User Documentation** - **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)** - Complete feature overview with examples -- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions +- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)** - Step-by-step upgrade instructions - **[README_v0.4.0.md](README_v0.4.0.md)** - Getting started and API reference - **20+ Examples** - Real-world usage patterns and workflows ### **πŸ”§ Developer Documentation** -- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** - Full development history +- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](../development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)** - Full development history - **API Reference** - Complete method documentation with type hints - **Architecture Guides** - System design and integration patterns - **Testing Documentation** - Test suite overview and extension guide diff --git a/NEW_FEATURES_v0.4.0.md b/docs/user-guide/NEW_FEATURES_v0.4.0.md similarity index 100% rename from NEW_FEATURES_v0.4.0.md rename to docs/user-guide/NEW_FEATURES_v0.4.0.md diff --git a/README_v0.4.0.md b/docs/user-guide/README_v0.4.0.md similarity index 97% rename from README_v0.4.0.md rename to docs/user-guide/README_v0.4.0.md index a9089c2..9db3e71 100644 --- a/README_v0.4.0.md +++ b/docs/user-guide/README_v0.4.0.md @@ -343,8 +343,8 @@ graph TB ### **πŸ“š Core Guides** - **[NEW_FEATURES_v0.4.0.md](NEW_FEATURES_v0.4.0.md)**: Complete feature overview with examples -- **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)**: Upgrade from previous versions -- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)**: Full architecture and development history +- **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)**: Upgrade from previous versions +- **[COMPREHENSIVE_DEVELOPMENT_SUMMARY.md](../development/COMPREHENSIVE_DEVELOPMENT_SUMMARY.md)**: Full architecture and development history ### **πŸ”§ API Reference** - **Core Processing**: `VideoProcessor`, `ProcessorConfig`, processing results @@ -398,7 +398,7 @@ config.enable_360_processing = True streaming_package = await stream_processor.create_adaptive_stream(...) ``` -See **[MIGRATION_GUIDE_v0.4.0.md](MIGRATION_GUIDE_v0.4.0.md)** for complete migration instructions. +See **[MIGRATION_GUIDE_v0.4.0.md](../migration/MIGRATION_GUIDE_v0.4.0.md)** for complete migration instructions. --- diff --git a/pyproject.toml b/pyproject.toml index ae0f921..5c8b3d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "hatchling.build" name = "video-processor" version = "0.3.0" description = "Standalone video processing pipeline with multiple format encoding" -authors = [{name = "Video Processor", email = "dev@example.com"}] +authors = [{name = "Ryan Malloy", email = "ryan@malloys.us"}] readme = "README.md" requires-python = ">=3.11" dependencies = [