Simple Resume — Effortlessly generate resumes from YAML…

Pitch

Description

Comments

About this project

Simple-Resume is a command-line tool that enables users to create PDF, HTML, and LaTeX resumes from a single YAML source file. By using version control for resume content, it allows flexibility in applying various templates and color schemes, making resume management straightforward and efficient.

Simple-Resume is a versatile command-line interface (CLI) tool designed to efficiently generate PDF, HTML, and LaTeX resumes from a single YAML source file. This utility facilitates version control for resume content, allowing for easy customization of templates and color schemes. The flexibility of being used both as a command-line tool and as a Python library ensures that users can generate professional resumes with minimal effort.

Key Features

Multiple Formats: Create resumes in PDF, HTML, or LaTeX formats to suit different needs and preferences.
Version Control: Leverage the power of a single YAML file to keep resume content organized and easily modifiable.
Custom Styling: Apply different templates and color palettes to personalize the look of the resume according to individual branding.

Quick Start

Create Your Resume: Begin by crafting a YAML file that encapsulates all necessary resume information. An example structure is provided below:

template: resume_base
full_name: Jane Doe
job_title: Software Engineer
address:
  - 123 Tech Street
  - San Francisco, CA
phone: "(555) 123-4567"
email: jane.doe@example.com
web: https://jandoe.dev
linkedin: in/janedoe
github: janedoe

description: |
  Software engineer with 5+ years of experience building scalable
  web applications and leading cross-functional teams.

body:
  experience:
    - title: Senior Software Engineer
      company: TechCorp
      start: 2022
      end: Present
      description: |
        * Led development of microservices architecture serving 1M+ users
        * Mentored junior developers and conducted code reviews
        * Improved system performance by 40% through optimization

  skills:
    - Python
    - JavaScript
    - React
    - Node.js
    - PostgreSQL
    - Docker
    - AWS

Generate the Resume: Simply use the following commands to produce the desired format:

# Create a PDF
uv run simple-resume generate --format pdf

# Create an HTML file
uv run simple-resume generate --format html

# Generate a PDF and open it
uv run simple-resume generate --format pdf --open

Utilize the Python API: For those who prefer programmatic access, the tool can also be utilized as a library. Here’s a simple example for generating a resume:
```
from simple_resume import Resume

resume = Resume.read_yaml("resume_private/input/my_resume.yaml")
result = resume.to_pdf(open_after=True)
```
Custom Styling Options: Users can apply specific color palettes or custom palette files to enhance the visual appeal of their resumes:
```
uv run simple-resume generate --palette "Professional Blue"
```
LaTeX Support: For users needing advanced typesetting capabilities, LaTeX output can be generated, allowing detailed formatting and control over document styling.
```
config:
  output_mode: latex
```

Documentation and Community

Comprehensive documentation is available for getting started, usage, and development, including guides for API specifics and color schemes. For support, issues can be raised on GitHub, or discussions can be initiated within the community.

Explore sample/ for additional example resume files and templates to streamline the resume creation process.