Skip to content

notsag/yaml-resume

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

yaml-resume

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

Purpose

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

Getting Started

Install

Package is available on Pypi :

pip install yaml-resume

Usage

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>]

Contributions

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

TL;DR

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

Credits

This project was inspired by : JSON Resume.

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