# ge0rg3/sans-index-creator architecture

> Architecture diagram of the GitHub repository ge0rg3/sans-index-creator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ge0rg3/sans-index-creator
- Repository: https://github.com/ge0rg3/sans-index-creator

## Overview

This small command-line toolkit creates a keyword index from SANS course text and can merge indexes from multiple books. The main workflow is text input → page splitting and word filtering → per-page index output; the separate combiner reads those index files and prints a book-aware combined index. The README documents PDF decryption and text conversion as prerequisites, not repository components. The graph reflects the shown scripts and documented workflow; no additional runtime subsystems are evident.

Main entry points: [`sans_indexer.py`](https://github.com/ge0rg3/sans-index-creator/blob/master/sans_indexer.py) (SANS indexer), [`index_combiner.py`](https://github.com/ge0rg3/sans-index-creator/blob/master/index_combiner.py) (Index combiner)

## Diagram (Mermaid)

```mermaid
flowchart TD

node_user(("Course user"))
node_text["Course text"]
node_indexer["SANS indexer<br/>[sans_indexer.py]"]
node_wordlist["English wordlist"]
node_indexfile["Course index"]
node_combiner["Index combiner<br/>[index_combiner.py]"]
node_bookindexes["Book indexes"]
node_combined["Combined index"]
node_pdf["Course PDF"]
node_conversion["PDF conversion tools"]

node_user -->|"downloads"| node_pdf
node_pdf -->|"decrypts and converts"| node_conversion
node_conversion -->|"produces text"| node_text
node_user -->|"runs"| node_indexer
node_text -->|"provides input"| node_indexer
node_indexer -->|"fetches words"| node_wordlist
node_indexer -->|"writes index"| node_indexfile
node_user -->|"runs"| node_combiner
node_bookindexes -->|"provides files"| node_combiner
node_indexfile -->|"can supply"| node_bookindexes
node_combiner -->|"prints combined index"| node_combined

click node_indexer "https://github.com/ge0rg3/sans-index-creator/blob/master/sans_indexer.py"
click node_combiner "https://github.com/ge0rg3/sans-index-creator/blob/master/index_combiner.py"

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_user toneBlue
class node_text,node_wordlist,node_indexfile,node_bookindexes,node_combined,node_pdf,node_conversion toneIndigo
class node_indexer,node_combiner toneTeal
```

## Components

### Other components

- **Course user**
- **Course text**
- [SANS indexer](https://github.com/ge0rg3/sans-index-creator/blob/master/sans_indexer.py): `sans_indexer.py`
- **English wordlist**
- **Course index**
- [Index combiner](https://github.com/ge0rg3/sans-index-creator/blob/master/index_combiner.py): `index_combiner.py`
- **Book indexes**
- **Combined index**
- **Course PDF**
- **PDF conversion tools**

## Connections

- Course user → Course PDF: downloads (evidence: `README.md`)
- Course PDF → PDF conversion tools: decrypts and converts (evidence: `README.md`)
- PDF conversion tools → Course text: produces text (evidence: `README.md`)
- Course user → SANS indexer: runs (evidence: `README.md`)
- Course text → SANS indexer: provides input (evidence: `sans_indexer.py`)
- SANS indexer → English wordlist: fetches words (evidence: `sans_indexer.py`)
- SANS indexer → Course index: writes index (evidence: `sans_indexer.py`)
- Course user → Index combiner: runs (evidence: `README.md`)
- Book indexes → Index combiner: provides files (evidence: `index_combiner.py`)
- Course index → Book indexes: can supply (evidence: `README.md`)
- Index combiner → Combined index: prints combined index (evidence: `index_combiner.py`)
