Generate solid resumes from YAML data
Project description
resemu
A simple CLI tool to generate clean resumes from YAML data.
Features • Example • Installation • Getting Started • CLI Usage
Features
- YAML-based Input: Define your resume content in a clear, structured YAML file.
- LaTeX Templates: Clean and professional resume layouts using LaTeX templates.
- Rich CLI Experience: Built with Typer and Rich for user-friendly command-line interactions.
- Validation: Data validation using Pydantic ensures your resume data is correct before rendering.
- Easy to Use: Simple commands to validate and generate your resume.
Example
The YAML file in examples/ produces the following PDF using the engineering template :
Installation
LaTeX
You firstly need a LaTeX distribution with extra fonts to use resemu. On Debian :
sudo apt install texlive texlive-fonts-extra
resemu
You need Python 3.12 or newer.
pip install resemu
Or, if you want the latest development version:
pip install git+https://github.com/matheodrd/resemu.git
Getting Started
Prepare Your Resume Data
Start by creating a YAML file describing your background, skills, and experiences. You can use the provided examples/john_doe.yml as a reference for the expected structure and fields.
Tip: resemu provides a JSON schema (resume_schema.json) to help you edit your YAML file with autocompletion and validation in your IDE.
Generate Your PDF Resume
Once your YAML is ready, generate a PDF with:
resemu generate -t engineering -o my_resume.pdf my_resume.yml
-t, --templatelets you pick the desired template (default:engineering)-o, --outputsets the output PDF filename
Validate Your YAML
Before generating, you can check your YAML file for errors or missing fields:
resemu validate my_resume.yml
The CLI will let you know about any structural issues or missing required data.
CLI Usage
resemu
$ resemu [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
generate: Generate a PDF resume from a YAML data filevalidate: Validate a YAML resume data filetemplates: List available resume templatesversion: Show version information
resemu generate
Generate a PDF resume from a YAML data file.
This command processes your YAML resume data and generates a clean PDF using the specified template.
Usage:
$ resemu generate [OPTIONS] DATA_FILE
Arguments:
DATA_FILE: YAML file containing resume data [required]
Options:
-t, --template TEXT: Resume template to use [default: engineering]-o, --output PATH: Output file path (defaults to input filename with .pdf extension)-f, --force: Overwrite existing output file without confirmation--help: Show this message and exit.
resemu validate
Validate a YAML resume data file.
Checks if your YAML file is properly formatted and contains all required fields.
Usage:
$ resemu validate [OPTIONS] DATA_FILE
Arguments:
DATA_FILE: YAML file to validate [required]
Options:
-v, --verbose: Show detailed validation information--help: Show this message and exit.
resemu templates
List available resume templates.
Shows all available templates you can use with the generate command.
Usage:
$ resemu templates [OPTIONS]
Options:
--help: Show this message and exit.
resemu version
Show version information.
Usage:
$ resemu version [OPTIONS]
Options:
--help: Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file resemu-0.2.0.tar.gz.
File metadata
- Download URL: resemu-0.2.0.tar.gz
- Upload date:
- Size: 3.5 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2325176c3d5c1a290df232a3355481c01ac86b7d2f5a424d0ec04d1a0397307e
|
|
| MD5 |
fbc6246c38fb36414e93720ff73dc6a1
|
|
| BLAKE2b-256 |
671e7ec9e7c8bf4f66d915b5c99dc76751f7ad46cf0f1aaa5eff864a02974bee
|
Provenance
The following attestation bundles were made for resemu-0.2.0.tar.gz:
Publisher:
publish.yml on matheodrd/resemu
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
resemu-0.2.0.tar.gz -
Subject digest:
2325176c3d5c1a290df232a3355481c01ac86b7d2f5a424d0ec04d1a0397307e - Sigstore transparency entry: 245425782
- Sigstore integration time:
-
Permalink:
matheodrd/resemu@9804e11332b320b55905de011ba999fce7037d62 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/matheodrd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9804e11332b320b55905de011ba999fce7037d62 -
Trigger Event:
release
-
Statement type:
File details
Details for the file resemu-0.2.0-py3-none-any.whl.
File metadata
- Download URL: resemu-0.2.0-py3-none-any.whl
- Upload date:
- Size: 11.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8bfffb4e71798ddb4d66a8e287251396a72d2fdb819151d9b2f2e40e4750d5c3
|
|
| MD5 |
8ff5119748afbcfafb5a645f3738ee48
|
|
| BLAKE2b-256 |
230e659e8a357a8868cd939ca3affe60eb7851920e59c49556a94c42e0c5d262
|
Provenance
The following attestation bundles were made for resemu-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on matheodrd/resemu
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
resemu-0.2.0-py3-none-any.whl -
Subject digest:
8bfffb4e71798ddb4d66a8e287251396a72d2fdb819151d9b2f2e40e4750d5c3 - Sigstore transparency entry: 245425787
- Sigstore integration time:
-
Permalink:
matheodrd/resemu@9804e11332b320b55905de011ba999fce7037d62 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/matheodrd
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@9804e11332b320b55905de011ba999fce7037d62 -
Trigger Event:
release
-
Statement type: