resumex-py 1.0.0

YAML -> LaTeX -> PDF resume builder with strict theme schemas.

resumex

An easy, YAML-based, theme-driven resume generator. resumex takes your structured data and produces professional LaTeX and PDF resumes with strict schema validation.

Features

• YAML-first: Store your career data in a clean, versionable format.
• Strict Validation: Powered by Pydantic to ensure your data matches your theme's requirements.
• Theme System: Fully customizable layouts using Jinja2 templates.
• Dual Usage: Use it via CLI or as a Python module in your own scripts.
• Smart Compilation: Automatically handles LaTeX runs using latexmk or falls back to direct engines like pdflatex.

Installation

Requirements

• Python: 3.12 or higher.
• LaTeX: A distribution (like TeX Live, MacTeX, or MiKTeX) providing latexmk (recommended) or pdflatex.

Using uv (Recommended)

uv tool install resumex-py

Using pip

pip install resumex-py

Quickstart

1. Create your resume: Save your data in resume.yaml (see examples/resume.yaml).
2. Generate PDF:

   resumex build resume.yaml --out build
   

3. Generate TeX only:

   resumex tex resume.yaml --out build
   

Custom Themes

resumex allows you to go beyond the bundled themes by creating your own.

Using a local theme

You can point the generator to a folder containing your theme:

resumex build resume.yaml --theme ./path/to/my-theme

Theme Structure

A theme directory must contain:

• theme.yaml: Configuration for allowed sections, templates, and models.
• templates/main.tex.j2: The main entry point for the resume layout.
• partials/: Reusable Jinja2 fragments for specific sections.

To start a new theme, copy the default theme data from the package:

cp -r src/resumex/themes_data/default ./my-theme

Module Usage

You can also integrate resumex into your Python applications:

from pathlib import Path
from resumex.engine.pipeline import build_pdf

result = build_pdf(
    yaml_path=Path("resume.yaml"),
    theme_id="default",  # or a path like "./my-theme"
    out_dir=Path("output")
)

print(f"Resume generated at: {result.pdf_path}")

Development & Testing

We use uv for development. To run tests:

uv run pytest tests/

License

MIT