# gavin-edgley/booksummarizer architecture

> Architecture diagram of the GitHub repository gavin-edgley/booksummarizer, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gavin-edgley/booksummarizer
- Repository: https://github.com/gavin-edgley/booksummarizer

## Overview

BookSummarizer is an interactive CLI that takes a text or EPUB book, plans a summary for a chosen reading time, calls Claude to produce it, and saves the summary and original. Its documented workflow also includes cost estimation, splitting large books, and resuming interrupted work. The source excerpt confirms API requests and temporary progress files; relationships for other stages are based on README workflow descriptions, since their implementation was not shown.

Main entry points: [`summarize.py`](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py) (CLI Orchestrator), [`BooksOut`](https://github.com/gavin-edgley/booksummarizer/tree/main/BooksOut) (Completed Books), [`BooksIn`](https://github.com/gavin-edgley/booksummarizer/tree/main/BooksIn) (Book Input), [`Temp`](https://github.com/gavin-edgley/booksummarizer/tree/main/Temp) (Progress Files)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_workflow["Book Workflow"]
  node_cli["CLI Orchestrator<br/>[summarize.py]"]
  node_selection["Book Selection<br/>[summarize.py]"]
  node_summary_plan["Summary Planning<br/>[summarize.py]"]
  node_recovery["Resume Handling<br/>[summarize.py]"]
end

subgraph group_processing["Summary Processing"]
  node_format_handling["Format Handling<br/>[summarize.py]"]
  node_reading_estimate["Reading Estimate<br/>[summarize.py]"]
  node_cost_estimate["Cost Estimate<br/>[summarize.py]"]
  node_splitter["Document Splitting<br/>[summarize.py]"]
  node_prompting["Prompt Generation<br/>[summarize.py]"]
  node_summary_output["Summary Output<br/>[summarize.py]"]
  node_epub_export["EPUB Export<br/>[summarize.py]"]
end

subgraph group_storage["Files and Recovery"]
  node_book_input["Book Input"]
  node_book_output["Completed Books"]
  node_temp_files[("Progress Files")]
end

subgraph group_integrations["External Services"]
  node_claude["Claude API"]
  node_pandoc["Pandoc"]
end

node_reader(("User"))

node_reader -->|"runs or configures"| node_cli
node_cli -->|"starts selection"| node_selection
node_selection -->|"lists books"| node_book_input
node_selection -->|"passes selected file"| node_format_handling
node_format_handling -.->|"converts EPUB"| node_pandoc
node_format_handling -.->|"provides text"| node_reading_estimate
node_reading_estimate -->|"informs target"| node_summary_plan
node_cli -->|"estimates cost"| node_cost_estimate
node_summary_plan -->|"chooses split strategy"| node_splitter
node_splitter -.->|"supplies text parts"| node_prompting
node_prompting -->|"requests summary"| node_claude
node_cli -->|"checks interrupted jobs"| node_recovery
node_recovery -->|"reads or writes progress"| node_temp_files
node_claude -.->|"returns generated text"| node_summary_output
node_summary_output -->|"saves summary and original"| node_book_output
node_summary_output -->|"exports EPUB"| node_epub_export
node_epub_export -.->|"converts summary"| node_pandoc
node_epub_export -.->|"saves EPUB"| node_book_output

click node_cli "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_selection "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_book_input "https://github.com/gavin-edgley/booksummarizer/tree/main/BooksIn"
click node_format_handling "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_reading_estimate "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_cost_estimate "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_summary_plan "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_splitter "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_prompting "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_summary_output "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_epub_export "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_book_output "https://github.com/gavin-edgley/booksummarizer/tree/main/BooksOut"
click node_recovery "https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py"
click node_temp_files "https://github.com/gavin-edgley/booksummarizer/tree/main/Temp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_selection,node_summary_plan,node_recovery,node_reader toneBlue
class node_format_handling,node_reading_estimate,node_cost_estimate,node_splitter,node_prompting,node_summary_output,node_epub_export toneAmber
class node_book_input,node_book_output,node_temp_files toneMint
class node_claude,node_pandoc toneRose
```

## Components

### Book Workflow

- [CLI Orchestrator](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Book Selection](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Summary Planning](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Resume Handling](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`

### Summary Processing

- [Format Handling](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Reading Estimate](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Cost Estimate](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Document Splitting](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Prompt Generation](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [Summary Output](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`
- [EPUB Export](https://github.com/gavin-edgley/booksummarizer/blob/main/summarize.py): `summarize.py`

### Files and Recovery

- [Book Input](https://github.com/gavin-edgley/booksummarizer/tree/main/BooksIn): `BooksIn`
- [Completed Books](https://github.com/gavin-edgley/booksummarizer/tree/main/BooksOut): `BooksOut`
- [Progress Files](https://github.com/gavin-edgley/booksummarizer/tree/main/Temp): `Temp`

### External Services

- **Claude API**
- **Pandoc**

### Other components

- **User**

## Connections

- User → CLI Orchestrator: runs or configures (evidence: `README.md`)
- CLI Orchestrator → Book Selection: starts selection (evidence: `README.md`)
- Book Selection → Book Input: lists books (evidence: `README.md`)
- Book Selection → Format Handling: passes selected file (evidence: `README.md`)
- Format Handling → Pandoc: converts EPUB (evidence: `summarize.py`)
- Format Handling → Reading Estimate: provides text (evidence: `summarize.py`)
- Reading Estimate → Summary Planning: informs target (evidence: `README.md`)
- CLI Orchestrator → Cost Estimate: estimates cost (evidence: `README.md`)
- Summary Planning → Document Splitting: chooses split strategy (evidence: `README.md`)
- Document Splitting → Prompt Generation: supplies text parts (evidence: `summarize.py`)
- Prompt Generation → Claude API: requests summary (evidence: `summarize.py`)
- CLI Orchestrator → Resume Handling: checks interrupted jobs (evidence: `README.md`)
- Resume Handling → Progress Files: reads or writes progress (evidence: `summarize.py`)
- Claude API → Summary Output: returns generated text
- Summary Output → Completed Books: saves summary and original (evidence: `README.md`)
- Summary Output → EPUB Export: exports EPUB (evidence: `README.md`)
- EPUB Export → Pandoc: converts summary (evidence: `README.md`)
- EPUB Export → Completed Books: saves EPUB (evidence: `README.md`)
