HearYourPaper

Drop in a paper. Get summaries, highlights, margin notes, searchable embeddings, and a full audio walkthrough. Fully offline, fully yours.

Features

• Process PDFs from local path or URL.
• High-level summary of the entire paper using Gemini.
• Paragraph-by-paragraph walkthrough:
  • Narration of each paragraph.
  • Explanation of each paragraph (using Gemini with Ollama fallback).
• Visual Highlighting: The current paragraph is highlighted on the page.
• Full Video Output: Generates a single MP4 video combining audio and visuals.
• Offline-first: Core functionality works offline. Gemini API is used when available for higher quality explanations.

Project Structure

hearyourpaper/
├── main.py
├── cli/
│   └── process.py
├── core/
│   ├── config.py
│   ├── fetch_pdf.py
│   ├── pdf_parser.py
│   ├── explainer.py
│   ├── llm_gemini.py
│   ├── llm_ollama.py
│   ├── tts.py
│   ├── highlight.py
│   ├── video_builder.py
│   ├── pipeline.py
│   └── utils.py
├── storage/
│   ├── raw/
│   ├── parsed/
│   ├── text/
│   ├── audio/
│   ├── frames/
│   └── video/
├── config.yaml
├── LICENSE
└── README.md

Usage

python3 main.py <PATH_TO_PDF_OR_URL>
# example:
python3 main.py https://arxiv.org/pdf/2401.10166