How iandalton/betterresume works
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.