Youtube-sum / README.md
simplytaps's picture
Upload README.md with huggingface_hub
6875741 verified
---
title: YouTube to Book Summary Converter
emoji: πŸ“š
colorFrom: purple
colorTo: blue
sdk: docker
pinned: false
license: mit
---
# πŸ“š YouTube to Book Summary Converter
Transform any YouTube video into a comprehensive, book-style summary using AI (Groq LLM).
**Live Demo**: [simplytaps/Youtube-sum](https://huggingface.co/spaces/simplytaps/Youtube-sum)
---
## ⚠️ Important: Use Manual Transcript Tab
**Hugging Face Spaces blocks YouTube access.** The YouTube URL tab will NOT work.
### How to Use This App:
1. **Open YouTube video** in another tab
2. **Click "Show transcript"** button below the video
3. **Copy the transcript text**
4. **Go to "πŸ“ Manual Transcript" tab** in this app
5. **Paste the transcript** and click "Generate Summary"
---
## Step-by-Step Guide
### Step 1: Get Transcript from YouTube
1. Open any YouTube video (e.g., https://www.youtube.com/watch?v=example)
2. Click the **"..." (more)** button below the video
3. Click **"Show transcript"**
4. Click anywhere in the transcript box
5. Press **Ctrl+A** to select all
6. Press **Ctrl+C** to copy
### Step 2: Generate Summary
1. In this app, go to **"πŸ“ Manual Transcript"** tab
2. **Paste** the transcript (Ctrl+V)
3. Add **video title** (optional)
4. Add **video duration** like `10:30` (optional)
5. Click **"πŸš€ Generate Summary from Transcript"**
### Step 3: Download Results
- **πŸ“„ PDF** - Formatted book-style summary
- **πŸ“ Word** - Editable document
- **πŸ“‹ Markdown** - For note-taking apps
- **πŸ“œ Transcript** - Original text
---
## Required Setup (One-Time)
### Get Groq API Key (FREE)
1. Visit [console.groq.com](https://console.groq.com/)
2. Sign up for **FREE** account
3. Click **"API Keys"** β†’ **"Create API Key"**
4. Copy the key (starts with `gsk_`)
### Add to Space Secrets
1. Go to [Space Settings](https://huggingface.co/spaces/simplytaps/Youtube-sum/settings)
2. Scroll to **"Repository Secrets"**
3. Add secret:
- **Name**: `GROQ_API_KEY`
- **Value**: Your API key
4. Click **"Add Secret"**
5. **Restart** the Space
---
## Output Structure
| Section | Description |
|---------|-------------|
| Executive Overview | High-level summary |
| Introduction | Background and context |
| Chapter-by-Chapter | Detailed breakdown |
| Key Concepts | Important terms |
| Key Takeaways | Main insights |
| Memorable Quotations | Notable quotes |
| Practical Applications | How to apply |
| Critical Analysis | Strengths/limitations |
| Quick Summary | TL;DR bullets |
---
## Troubleshooting
| Problem | Solution |
|---------|----------|
| "YouTube URL not working" | Use Manual Transcript tab instead |
| "API key error" | Add GROQ_API_KEY to secrets |
| "Rate limit exceeded" | Get your own API key |
| App not loading | Wait 1-2 minutes for startup |
---
## Technical Stack
- **Frontend**: Gradio 4.x
- **LLM**: Groq API (Llama 3.3 70B)
- **Documents**: python-docx, reportlab
---
**Powered by Groq LLM** | Built with ❀️ using Gradio