yaml-resume-builder 1.0.0

A package to generate PDF resumes from YAML files using LaTeX templates

YAML Resume Builder

A Python package to generate PDF resumes from YAML files using LaTeX templates.

Prerequisites

• Python 3.8 or higher
• LaTeX installation with latexmk command available in your PATH:

LaTeX Installation

Linux (Debian/Ubuntu)

sudo apt update && sudo apt install texlive-full latexmk

macOS

Install MacTeX (includes latexmk):

brew install --cask mactex

Windows

Install MiKTeX (includes latexmk):

1. Download the MiKTeX Net Installer from https://miktex.org/download
2. Choose "Complete" installation to ensure all required packages are installed
3. MiKTeX will add pdflatex and latexmk to your PATH automatically

Installation

From PyPI or GitHub

# Install from PyPI
pip install yaml-resume-builder

# Or install directly from GitHub
pip install git+https://github.com/husayni/resume_builder.git

For Development

# Clone the repository
git clone https://github.com/husayni/resume_builder.git
cd resume_builder

# Create and activate a virtual environment
python -m venv .venv
source .venv/bin/activate

# Install the package in development mode with dev dependencies
pip install -e ".[dev]"

Usage

Command Line Interface

# Create a sample YAML resume file
yaml-resume-builder init --output my_resume.yml

# Build a resume from a YAML file
yaml-resume-builder build --input my_resume.yml --output resume.pdf

Python API

from yaml_resume_builder import build_resume

# Build a resume from a YAML file
build_resume(
    input_path="my_resume.yml",
    output_path="resume.pdf"
)

YAML Format

The YAML file should have the following structure:

name: Your Name
title: Your Title
contact:
  email: [e-mail]
  phone: "[phone]"
  github: yourusername
  linkedin: yourusername
education:
  - school: University Name
    degree: Degree Name
    dates: "2020 - 2024"
    location: City, Country
experience:
  - company: Company Name
    role: Your Role
    dates: "Jan 2023 - Present"
    location: City, Country
    bullets:
      - Accomplishment 1
      - Accomplishment 2
projects:
  - name: Project Name
    link: https://github.com/yourusername/project
    bullets:
      - Description 1
      - Description 2
skills:
  - category: Languages
    list: [Python, JavaScript, Java]
  - category: Frameworks
    list: [Django, React, Spring]

Development

Running Tests

# Run all tests
pytest

# Run tests with coverage
pytest --cov=yaml_resume_builder

# Run linting checks
ruff check .
isort --check --diff .

Pre-commit Hooks

This project uses pre-commit hooks to ensure code quality. To set up pre-commit hooks:

# Install pre-commit
pip install pre-commit

# Install the git hooks
pre-commit install

# Run pre-commit on all files
pre-commit run --all-files

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• This project uses the LaTeX resume template created by Jake Gutierrez, which is also licensed under the MIT License.