CVgenAI 💻✨📄

A tool for generating professional resumes and cover letters in PDF and HTML formats. When an OPENAI_API_KEY 🔑 environment variable is present the resume content can be automatically tailored to a specific job description via OpenAI's API. Without the key the tool simply renders the provided content.

Features ✨

• Generate professional resumes with a consistent, two-page layout
• Generate matching cover letters
• Produce both PDF and HTML output formats
• Customize content via TOML resume document
• Support for multiple profiles/people
• Optional AI-powered customization of resume content based on a job description when OPENAI_API_KEY is set
• Job-specific output filenames keep your applications tidy

Installation ⚙️

Prerequisites 📋

• Python 3.8+
• Pipenv for dependency management

Setup 🛠️

1. Clone this repository

2. Install dependencies with pipenv:

   pipenv install --dev

3. Create your personal resume content document:

   cp resume-sample.toml resume.toml

4. Edit the resume.toml file with your personal information, work experience, and other resume details.

When running scripts or commands, ensure that the PYTHONPATH is set to include the src directory. This ensures that the cvgenai module can be correctly located and imported.

Usage 🚀

Basic Usage ⌨️

Generate both resume and cover letter (PDF only):

./run.sh

Set the OPENAI_API_KEY environment variable to enable AI customization 🤖. If the variable is unset the generator runs in pass-through mode and simply renders the provided content.

Running Tests 🧪

Run all tests (this will install the package first):

./test.sh

Skip the package installation and only run tests:

./test.sh -t

Command Line Options 💻

Option	Description
--resume	Generate only the resume
--cover-letter	Generate only the cover letter
--html	Generate HTML versions in addition to PDFs
--job PATH	Job description used for AI customization
--content PATH	Specify an alternative resume content file (default: resume.toml)

Examples 📝

Generate only the resume:

run.sh --resume

Generate both resume and cover letter with HTML versions:

run.sh --resume --cover-letter --html

Customize the resume for a specific role:

run.sh --job example_job.txt

Generated files will use the job file name so you can keep results organized 📚.

Use an alternate content file:

run.sh --content my-other-resume.toml

Project Structure 🗂️

Download achitecture PDF

• resume.toml: Your personal resume and cover letter information
• src/cvgenai/: Main package
  • cli.py: Command-line interface
  • controller.py: Coordinates the generation workflow
  • career.py: Loads and stores resume data
  • factory.py: Creates services and generators based on app_config.toml
  • generate.py: Document generator implementations
  • document.py: Abstractions for resume and cover letter documents
  • config.py: TOML configuration loader
  • services/: File, HTML, PDF and customization services
  • templating/: Jinja template rendering helper
• templates/: Contains HTML templates and CSS styles
  • cover_letter_template.html: Template for cover letters
  • resume_page1_template.html: Template for resume page 1
  • resume_page2_template.html: Template for resume page 2
  • style.css: Styling for all documents
• output/: Where generated files are saved
  • [name]_[job]_resume.pdf: Complete resume (both pages combined)
  • [name]_[job]_cover_letter.pdf: Cover letter
  • When --html is used:
    • [name]_[job]_resume_page1.html: HTML for first page of the resume
    • [name]_[job]_resume_page2.html: HTML for second page of the resume
    • [name]_[job]_cover_letter.html: HTML version of the cover letter
    • style.css: Copy of the CSS file used
• diagrams/: UML diagrams describing the architecture
• tests/: Pytest suite

Customization 🎨

Templates 📝

You can modify the templates in the templates/ directory to customize the appearance of your resume and cover letter. The templates use Jinja2 syntax.

Styles 🖌️

Edit the templates/style.css file to customize the styling of your documents.

Content 📄

The resume.toml file contains all the content for your resume and cover letter. You can create multiple content files for different job applications, different roles, or different people.

Extending the Project 🛠️

Thanks to the SOLID architecture, you can easily extend the project:

1. Add new document types: Create a new class that extends the Document base class
2. Add new output formats: Create a new service class and implement the appropriate interface
3. Change the templating engine: Create a new class that implements the ITemplateRenderer interface

Tips 💡

• Keep each bullet point in your experience and education sections concise for better formatting
• Use the --html option during development to quickly preview changes in a web browser
• Create multiple content files for different job applications (e.g., resume-dev.toml, resume-manager.toml)
• For multiple people, use separate content files and specify with --content

License 📜

Apache License, Version 2.0