summary

youtube_summary/README.md

@@ -0,0 +1,30 @@
+# Youtube Summary
+
+This notebook can be used as a template to summarise YouTube videos. It was orignally
+used to fetch summaries for some [keyboard reviews](https://www.youtube.com/playlist?list=PLGj5nRqy15j93TD0iReqfLL9lU1lZFEs6) but the notebook itself can be adapted
+for many other use-cases too. 
+
+![](assets/youtube_summary.png)
+
+## Running this notebook
+
+The only want to run this notebook is to run it locally. This demo uses Claude as
+an LLM backend which requires a `ANTHROPIC_API_KEY` set in a `.env` file. Finally, 
+this notebook also assumes that `ffmpeg` is available on your system ([details](https://github.com/openai/whisper/blob/main/README.md#setup)). 
+
+Once that's taken care of you can run this notebook in a sandbox. The requirements of each notebook are serialized in them as a top-level
+comment. Here are the steps to run the notebook:
+
+1. [Install `uv`](https://github.com/astral-sh/uv/?tab=readme-ov-file#installation)
+2. Open an example with `uvx marimo edit --sandbox <notebook-url>`
+
+> [!TIP]
+> The [`--sandbox`
+> flag](https://docs.marimo.io/guides/package_reproducibility/) opens the
+> notebook in an isolated virtual environment, automatically installing the
+> notebook's dependencies 📦
+
+You can also open notebooks without `uv`, in which case you'll need to
+manually [install marimo](https://docs.marimo.io/getting_started/index.html#installation)
+first. Then run `marimo edit <notebook-url>`; however, you'll also need to
+install the requirements yourself.

youtube_summary/youtube_summary.py

@@ -0,0 +1,236 @@
+# /// script
+# requires-python = ">=3.12"
+# dependencies = [
+#     "anthropic==0.45.2",
+#     "instructor==1.7.2",
+#     "jinja2==3.1.5",
+#     "marimo",
+#     "matplotlib==3.10.0",
+#     "mohtml==0.1.2",
+#     "openai-whisper",
+#     "opencv-python==4.11.0.86",
+#     "pydantic==2.10.6",
+#     "python-dotenv==1.0.1",
+#     "wigglystuff==0.1.9",
+#     "yt-dlp==2025.1.26",
+# ]
+# ///
+
+import marimo
+
+__generated_with = "0.10.19"
+app = marimo.App()
+
+
+@app.cell
+def _():
+    import matplotlib.pylab as plt
+    import cv2
+    from yt_dlp import YoutubeDL
+    from pathlib import Path
+
+    def download_yt(yt_url: str): 
+        yt_id = yt_url[-11:]
+        video_path = f"{yt_id}.m4a"
+
+        ydl_opts = {
+            'format': 'm4a/bestaudio/best',
+            'postprocessors': [{
+                'key': 'FFmpegExtractAudio',
+                'preferredcodec': 'm4a',
+            }]
+        }
+
+        if not Path(video_path).exists():
+            URLS = [yt_url]
+            with YoutubeDL(ydl_opts) as ydl:
+                ydl.download(URLS)
+            for vid in Path().glob("*.m4a"):
+                if yt_id in str(vid):
+                    vid.rename(video_path)
+        else:
+            print("Video has been downloaded already")
+    return Path, YoutubeDL, cv2, download_yt, plt
+
+
+@app.cell
+def _():
+    import marimo as mo
+    return (mo,)
+
+
+@app.cell
+def _(mo):
+    text_input = mo.ui.text(label="YouTube URL")
+
+    mo.md(f"""
+    Fill in the YouTube URL or pass the video id here: 
+
+    {text_input} 
+
+    In our experience sofar it can help to make sure that you are downloading a video that is set to "public". Unlisted videos caused download errors in the past. 
+    """).batch(text_input=text_input).form()
+    return (text_input,)
+
+
+@app.cell
+def _(download_yt, mo, text_input):
+    with mo.status.spinner(subtitle="Downloading ...") as _spinner:
+        if text_input.value:
+            download_yt(text_input.value)
+    return
+
+
+@app.cell
+def _(mo, text_input):
+    import whisper
+
+    with mo.status.spinner(subtitle="Running Whisper ...") as _spinner:
+        model = whisper.load_model("base")
+        result = model.transcribe(f"{text_input.value[-11:]}.m4a")
+    return model, result, whisper
+
+
+@app.cell
+def _(YoutubeDL, text_input):
+    with YoutubeDL() as ydl:
+        info = ydl.extract_info(text_input.value, download=False)
+    return info, ydl
+
+
+@app.cell
+def _():
+    from typing import List
+    import instructor
+    from pydantic import BaseModel
+
+
+    class YouTubeOutput(BaseModel):
+        """
+        Output of a YouTube video that reviews ergonomic keyboards.
+
+        Make sure that you have a clear summary that highlights some of the findings. Refer to the reviewer as "me" and write as if it was written by the reviewer. But not in the present tense, it needs to be past tense. Avoid a formal style, write as if it was written on an informal tech-blog. Also make sure that you create a sequences of pros and cons of the keyboard. No more than 4 pros and 4 cons. Also add a oneliner tldr for the review, typically you can just copy what is in the title. The name of the keyboard should also include the brand if there is one. 
+        """
+        summary: str
+        pros: List[str]
+        cons: List[str]
+        tldr: str
+        keyboard_name: str
+    return BaseModel, List, YouTubeOutput, instructor
+
+
+@app.cell
+def _(instructor):
+    from instructor import Instructor, Mode, patch
+    from anthropic import Anthropic
+    from dotenv import load_dotenv
+    import os
+
+    load_dotenv(".env")
+
+    client = instructor.from_anthropic(
+        Anthropic(api_key=os.environ["ANTHROPIC_API_KEY"]),
+    )
+    return Anthropic, Instructor, Mode, client, load_dotenv, os, patch
+
+
+@app.cell
+def _(mo):
+    mo.md("Once the downloading/parsing/generating is done, you can see the results below together with a 'copy to clipboard' button.")
+    return
+
+
+@app.cell
+def _(
+    CopyToClipboard,
+    YouTubeOutput,
+    client,
+    info,
+    mo,
+    result,
+    text_input,
+):
+    from mohtml import pre, p, code, div
+    from jinja2 import Template
+
+    template = Template("""
+    ---
+    hide:
+    - toc
+    - navigation
+    title: {{keyboard_name}}
+    ---
+
+    ## {{tldr}}
+
+
+    <iframe width="100%" height="500" src="https://www.youtube.com/embed/{{video_idx}}" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+
+
+    {{summary}}
+
+    ## Pros
+    {% for pro in pros %}
+    - {{ pro }}
+    {% endfor %}
+
+    ## Cons
+    {% for con in cons %}
+    - {{ con }}
+    {% endfor %}
+
+    """)
+
+
+    with mo.status.spinner(subtitle="Running LLM ...") as _spinner:
+        response = client.chat.completions.create(
+            model="claude-3-5-sonnet-20241022",
+            messages=[
+                {
+                    "role": "user",
+                    "content": f"Create a proper summary of the following keyboard review. This is the title: {info['title']}. This is the text for the full review: {result['text']}",
+                }
+            ],
+            max_tokens=1500,
+            response_model=YouTubeOutput,
+        )
+        rendered = template.render(
+            summary=response.summary, 
+            pros=response.pros, 
+            cons=response.cons,
+            title=info["title"], 
+            thumbnail=info["thumbnail"],
+            keyboard_name=response.keyboard_name,
+            tldr=response.tldr, 
+            video_idx=f"{text_input.value[-11:]}"
+        )
+        clipboard_btn = CopyToClipboard(rendered)
+
+    rendered
+    return (
+        Template,
+        clipboard_btn,
+        code,
+        div,
+        p,
+        pre,
+        rendered,
+        response,
+        template,
+    )
+
+
+@app.cell
+def _():
+    from wigglystuff import CopyToClipboard
+    return (CopyToClipboard,)
+
+
+@app.cell
+def _(clipboard_btn):
+    clipboard_btn
+    return
+
+
+if __name__ == "__main__":
+    app.run()