# ebrizzzz/youtube-playlist-to-formatted-text architecture

> Architecture diagram of the GitHub repository ebrizzzz/youtube-playlist-to-formatted-text, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ebrizzzz/youtube-playlist-to-formatted-text
- Repository: https://github.com/ebrizzzz/youtube-playlist-to-formatted-text

## Overview

##### Project type and purpose
- This is a desktop Python application with a PyQt5 graphical UI.
- Its purpose is to take a YouTube playlist (or single video) URL, extract transcripts, break them into configurable chunks, send each chunk (plus context) to the Google Gemini API for “refinement,” and assemble the final output as a markdown file.

##### File structure
- Top-level files:
- main.py – entry point, UI + orchestration
- requirements.txt – Python dependencies (PyQt5, youtube-transcript-api, gemini client, etc.)
- .env – environment variables (e.g. GEMINI_API_KEY)
- gemini_processing.log – runtime log file
- Example_Output.md, Example_Transcript.txt – sample outputs
- Images/ – screenshots used in README
- No separate “backend” or “frontend” directories; everything is orchestrated in main.py, but functions can be logically separated into UI, service, and data modules.

##### README for additional insights
- Confirms a pipeline: fetch transcripts → chunk text → refine via Gemini → append to output.
- Configurable parameters: chunk size, refining style, model choice, output paths.
- Progress tracking via GUI progress bar and status messages.

##### Detail without overthinking
- Every logical component even if implemented in one file.
- Flow of configuration data and context buffers.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors and UI
    User["User"]:::actor
    GUI["PyQt5 GUI Layer"]:::ui
    Config["Configuration Loader"]:::internal
    Transcript["YouTube Transcript Service"]:::internal
    Chunk["Chunk Manager"]:::internal
    Refinement["Gemini Refinement Service"]:::internal
    Output["Output Writer (Markdown)"]:::internal
    Logger["Logging Module"]:::internal

    %% External services
    ExternalYT["YouTube API"]:::external
    ExternalGemini["Google Gemini API"]:::external

    %% Storage
    MDfile["Markdown File"]:::storage
    Logfile["Log File"]:::storage

    %% Flow
    User -->|"launch app & input"| GUI
    GUI -->|"load config & inputs"| Config
    Config -->|"provide parameters"| Transcript

    Transcript -->|"fetch transcript"| ExternalYT
    ExternalYT -->|"return transcript"| Transcript

    Transcript -->|"raw transcript"| Chunk
    Chunk -->|"for each chunk"| Refinement
    Refinement -->|"refined chunk"| Chunk

    Chunk -->|"stream chunks"| Output
    Output -->|"append refined text"| MDfile
    Output -->|"log step"| Logger
    Logger -->|"write logs"| Logfile

    Refinement -->|"refine chunk"| ExternalGemini
    ExternalGemini -->|"refined text"| Refinement

    Chunk -->|"update progress"| GUI
    Output -->|"notify completion"| GUI

    %% Documentation & References
    subgraph "Documentation & References"
        Requirements["requirements.txt"]:::docs
        Env[".env"]:::docs
        Readme["README.md"]:::docs
        SampleOut["Example_Output.md"]:::docs
        SampleTrans["Example_Transcript.txt"]:::docs
        ImagesNode["Images/"]:::docs
    end

    %% Click Events
    click GUI "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/main.py"
    click Transcript "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/main.py"
    click Chunk "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/main.py"
    click Refinement "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/main.py"
    click Output "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/main.py"
    click Logger "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/gemini_processing.log"
    click Requirements "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/requirements.txt"
    click Env "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/.env"
    click SampleOut "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/Example_Output.md"
    click SampleTrans "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/Example_Transcript.txt"
    click Readme "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/blob/main/README.md"
    click ImagesNode "https://github.com/ebrizzzz/youtube-playlist-to-formatted-text/tree/main/Images/"

    %% Styles
    classDef actor fill:#ffdddd,stroke:#bb0000,stroke-width:1px
    classDef ui fill:#ddeeff,stroke:#0033aa,stroke-width:1px,stroke-dasharray:5 5
    classDef internal fill:#ddffdd,stroke:#008800,stroke-width:1px
    classDef external fill:#fff0cc,stroke:#aa7700,stroke-width:1px,stroke-dasharray:2 2
    classDef storage fill:#e0e0ff,stroke:#0000aa,stroke-width:1px
    classDef docs fill:#eeeeee,stroke:#555555,stroke-width:1px,stroke-dasharray:1 2
```
