Skip to content

architecture.md

Latest commit

 

History

History
55 lines (47 loc) · 1.79 KB

architecture.md

File metadata and controls

55 lines (47 loc) · 1.79 KB

Architecture

This document describes the high-level architecture of VideoCut-CLI.

1. Layer Overview

graph TD
    CLI["CLI Layer\n(Typer)"] --> DL["Downloader Module\nyt-dlp wrapper"]
    CLI --> EDIT["Editor Module\nFFmpeg pipeline"]
    CLI --> DR["Doctor Command\nHealth Check"]
    CLI --> AI["AI Module\nElevenLabs + Vision"]
    CLI --> PUB["Publisher Module\nPlatform APIs"]

    DL --> FS["File System\nDownloads/{platform}/{id}/"]
    EDIT --> FS
    AI --> FS
    PUB --> EXT["External Platforms\nYouTube / IG / TikTok / X"]

    AI --> EL["ElevenLabs API"]
    AI --> VIS["Vision/AI\nMediaPipe / YOLO"]
Loading

2. Directory Structure

videocut-cli/
├── videocut/
│   ├── __init__.py
│   ├── cli.py               # Entry point, all command groups
│   ├── config.py            # Global configuration & paths
│   │
│   ├── modules/
│   │   ├── downloader.py    # yt-dlp wrapper (Android player bypass)
│   │   ├── editor.py        # FFmpeg pipeline (watermark)
│   │   ├── ai_crop.py       # (Soon) Re-frame 16:9 → 9:16
│   │   ├── ai_highlights.py # (Soon) Auto-highlights from transcript
│   │   ├── ai_dub.py        # (Soon) ElevenLabs dubbing/subbing
│   │   └── publisher.py     # (Soon) Upload to social media platforms
│   │
│   ├── presets/             # (Soon) YAML presets
│   │
│   └── utils/               # Shared utilities
│
├── tests/
├── pyproject.toml
└── README.md

3. Technical Stack

  • Language: Python 3.9+
  • CLI Framework: Typer (Type-safe Click-based)
  • Downloader: yt-dlp
  • Video Engine: FFmpeg (via subprocess for maximum flexibility)
  • AI Integration (Soon): ElevenLabs, Whisper, YOLO/MediaPipe