How smuhammadtaha3/video-to-guided-docs works
YouTube Video to Guided Doc accepts a video URL through its web form or API, validates processing options, retrieves video metadata and transcripts (and optionally comments), then formats AI-friendly documentation for display or S3 publication. The main processing path is visible in the excerpts; the README documents caching, multilingual transcripts, comments, rate limits, and cloud integrations. Some utility-module usage and cache wiring are not shown, so those relationships are omitted or marked unverified.
Main entry points: dynamic.py Video routes · query_processor.py Query processing · main.py FastAPI app · index.py Home routes
Components 16
Web application
- FastAPI app
src/server/main.py - Home routes
src/server/routers/index.py - Video routes
src/server/routers/dynamic.py - Web templates
src/server/templates
Video processing
- Query processing
src/server/query_processor.py - Query and video schemas
src/youtubedoc/schemas/video_schema.py - YouTube extraction
src/youtubedoc/youtube_processor.py
Documentation output
- Markdown generation
src/server/query_processor.py - S3 publishing and cache
src/youtubedoc/utils/s3_uploader.py
Shared utilities
- Server configuration
src/server/server_config.py - Rate limiting and lifecycle
src/server/server_utils.py - Text utilities
src/youtubedoc/utils/text_utils.py - URL utilities
src/youtubedoc/utils/url_utils.py
Other components
- User or API client
- YouTube
- AWS S3
Connections 19
- User or API client → FastAPI app: sends request
README.md - FastAPI app → Home routes: registers routes
src/server/main.py - FastAPI app → Video routes: registers routes
src/server/main.py - Home routes → Query processing: processes submission
src/server/routers/index.py - Video routes → Query processing: processes submission
src/server/routers/dynamic.py - Home routes → Web templates: renders page
src/server/routers/index.py - Video routes → Web templates: renders page
src/server/routers/dynamic.py - Query processing → YouTube extraction: processes video
src/server/query_processor.py - Video routes → YouTube extraction: streams processing
src/server/routers/dynamic.py - YouTube extraction → YouTube: retrieves video data
README.md - Query processing → Markdown generation: generates Markdown
src/server/query_processor.py - Query processing → S3 publishing and cache: uploads Markdown
src/server/query_processor.py - S3 publishing and cache → AWS S3: checks and writes objects
README.md - Video routes → S3 publishing and cache: checks cache
src/server/routers/dynamic.py - FastAPI app → Rate limiting and lifecycle: configures lifecycle
src/server/main.py - Home routes → Rate limiting and lifecycle: applies rate limit
src/server/routers/index.py - Video routes → Rate limiting and lifecycle: applies rate limit
src/server/routers/dynamic.py - Query processing → Query and video schemas: uses query schema
src/server/query_processor.py - FastAPI app → Server configuration: uses templates
src/server/main.py