Skip to main content

Command line interface to build/validate YAML resumes

Project description


PyPI version tests Quality Gate Status License: GPL v3 Python 3.6+ Code style: black


This is an open source initiative to create a YAML-based resume.

Getting Started


Package is available on Pypi :

pip install yaml-resume


Init a new resume through an interactive cli:

yaml-resume init FILENAME

Validate your yaml resume:

yaml-resume validate FILENAME

Export you resume in html or pdf:

yaml-resume export FILENAME [-t <theme>] [-e <html|pdf>] [-i <picture>] [-o <output-file>]


Please have a look at the contributing guide and the code of conduct.


You can ask for features/report bugs using Github issues. You can submit work using Github Pull Requests.

To test development version without installing :

# To install dependencies
python3 -m pip install -r requirements.txt
python3 -m pip install pytest pytest-cov black pre-commit

# To run the cli
python3 -m yaml_resume

# To run the test suite
python3 -m pytest --cov=yaml_resume tests/

# To install pre-commit hook
pre-commit install


This project was inspired by : JSON Resume.

Special thanks to all contributors of the following projects used by yaml-resume :

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yaml-resume-0.7.10.tar.gz (26.4 kB view hashes)

Uploaded Source

Built Distribution

yaml_resume-0.7.10-py3-none-any.whl (31.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page