# iandalton/betterresume architecture

> Architecture diagram of the GitHub repository iandalton/betterresume, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/iandalton/betterresume
- Repository: https://github.com/iandalton/betterresume

## Overview

##### Project Type and Purpose
- BetterResume is an open-source, command-line resume generation tool.
- It ingests structured personal and job data (jobs.csv), uses Retrieval-Augmented Generation (RAG) with an LLM (OpenAI via LangChain + ChromaDB), and outputs polished resumes in Word, LaTeX, and PDF formats.
- Primary use case: tailor resumes to specific job descriptions for optimal ATS/AI scoring.

##### File Structure
- Top-level scripts:
- bot.py           — orchestrates the pipeline
- resume.py        — high-level resume generation interface
- config.py        — loads API keys, settings
- jobs.csv         — structured user data source
- Directories:
- llm/             — LLM integration and tool-node abstractions
- prompts/         — prompt templates for generation and translation
- resume/          — writer classes for each output format
- utils/           — helper functions (file I/O, Word → PDF conversion)
- Config/build/deployment files:
- requirements.txt — Python dependencies
- sample_use.ipynb — usage example in notebook form

##### README for Additional Insights
- Describes RAG approach: vector-store lookup (Chroma) + OpenAI tool nodes.
- Explains writer extensibility: each format is a subclass of BaseWriter.
- Lists external dependencies: OpenAI API, ChromaDB, python-docx, pdflatex or Word COM.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Orchestrator
    subgraph "CLI Orchestrator"
        direction TB
        Bot["bot.py"]:::orchestrator
        ResumeCLI["resume.py"]:::orchestrator
    end

    %% Configuration
    Config["config.py"]:::config

    %% Input Data
    DataCSV["jobs.csv"]:::data

    %% Parser
    Parser["Parser Module\nresume/parser.py"]:::module

    %% Tool-Node Abstraction
    BasicTool["BasicToolNode\nllm/basic_tool_node.py"]:::module

    %% Vector Store
    ChromaDB(["ChromaDB\n(cylinder)"]):::db
    ChromaTool["ChromaDB Tool\nllm/chroma_db_tool.py"]:::module

    %% LLM Service
    OpenAIService(["OpenAI API\n(rounded)"]):::external
    OpenAITool["OpenAI Tool\nllm/openai_tool.py"]:::module

    %% Prompts
    subgraph "Prompt Templates"
        direction TB
        JobPrompt["job_prompt.txt"]:::file
        TransPrompt["translation_prompt.txt"]:::file
    end

    %% Writers
    subgraph "Resume Writers"
        direction TB
        BaseWriter["BaseWriter\nresume/base_writer.py"]:::module
        WordWriter["WordWriter\nresume/word_writer.py"]:::module
        LatexWriter["LaTeXWriter\nresume/latex_writer.py"]:::module
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        FileIO["File I/O Helpers\nutils/file_io.py"]:::module
        WordUtils["Word→PDF\nutils/word_utils.py"]:::module
    end

    %% Outputs
    OutputDocx[/"Resume.docx"/]:::output
    OutputTex[/"Resume.tex"/]:::output
    OutputPDF[/"Resume.pdf"/]:::output

    %% Flow
    Bot --> ResumeCLI
    ResumeCLI --> Config
    ResumeCLI --> DataCSV
    ResumeCLI --> Parser
    Parser --> ChromaTool
    ChromaTool --> ChromaDB
    Parser --> BasicTool
    BasicTool --> OpenAITool
    OpenAITool --> OpenAIService
    OpenAITool --> JobPrompt
    OpenAITool --> TransPrompt
    OpenAITool --> BaseWriter
    BaseWriter --> WordWriter
    BaseWriter --> LatexWriter
    WordWriter --> OutputDocx
    LatexWriter --> OutputTex
    OutputDocx --> WordUtils
    WordUtils --> OutputPDF

    %% Click events
    click Bot "https://github.com/iandalton/betterresume/blob/main/bot.py"
    click ResumeCLI "https://github.com/iandalton/betterresume/blob/main/resume.py"
    click Config "https://github.com/iandalton/betterresume/blob/main/config.py"
    click DataCSV "https://github.com/iandalton/betterresume/blob/main/jobs.csv"
    click Parser "https://github.com/iandalton/betterresume/blob/main/resume/parser.py"
    click BasicTool "https://github.com/iandalton/betterresume/blob/main/llm/basic_tool_node.py"
    click ChromaTool "https://github.com/iandalton/betterresume/blob/main/llm/chroma_db_tool.py"
    click OpenAITool "https://github.com/iandalton/betterresume/blob/main/llm/openai_tool.py"
    click JobPrompt "https://github.com/iandalton/betterresume/blob/main/prompts/job_prompt.txt"
    click TransPrompt "https://github.com/iandalton/betterresume/blob/main/prompts/translation_prompt.txt"
    click BaseWriter "https://github.com/iandalton/betterresume/blob/main/resume/base_writer.py"
    click WordWriter "https://github.com/iandalton/betterresume/blob/main/resume/word_writer.py"
    click LatexWriter "https://github.com/iandalton/betterresume/blob/main/resume/latex_writer.py"
    click FileIO "https://github.com/iandalton/betterresume/blob/main/utils/file_io.py"
    click WordUtils "https://github.com/iandalton/betterresume/blob/main/utils/word_utils.py"

    %% Styles
    classDef orchestrator fill:#f9f,stroke:#333,stroke-width:1px;
    classDef config fill:#ff9,stroke:#333,stroke-width:1px;
    classDef data fill:#9ff,stroke:#333,stroke-width:1px;
    classDef module fill:#ccf,stroke:#333,stroke-width:1px;
    classDef external fill:#cfc,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5;
    classDef db fill:#fc9,stroke:#333,stroke-width:1px,shape:cylinder;
    classDef file fill:#eee,stroke:#333,stroke-width:1px,font-style:italic;
    classDef output fill:#fdd,stroke:#333,stroke-width:1px,shape:diamond;
```
