Skip to content

quickstart.md

Latest commit

 

History

History
37 lines (25 loc) · 1.31 KB

quickstart.md

File metadata and controls

37 lines (25 loc) · 1.31 KB
Raw

Shell Game Transcripts — Quickstart

The shortest path from an empty checkout to one transcribed, summarised episode. For every install option and prerequisite, see Installation.

1. Install

git clone https://github.com/willtheorangeguy/Shell-Game-Transcripts.git
cd Shell-Game-Transcripts
pip install -r requirements.txt
pip install git+https://github.com/openai/whisper.git

You also need ffmpeg on your PATH and Ollama running locally.

2. Pull the summarisation model

ollama pull llama3.1:8b

The summarisation stage calls Ollama over HTTP and fails if the model has not been pulled. This is the most common first-run failure.

3. Run one year

python main.py 2025

What to expect

  • Audio downloads first, then transcription, then summarisation, then grammar cleanup.
  • Transcription is the slow part. On CPU it can take longer than the episode itself. See Installation for the CUDA build of PyTorch.
  • Each stage appends to a log as it finishes an item, so interrupting and re-running resumes rather than starting over.
  • Output lands beside the audio: a transcript, a summary, and a corrected transcript.

If something fails, Troubleshooting covers the usual causes.