Skip to main content

Command line interface to build/validate YAML resumes

Project description

yaml-resume

PyPI version Build Status codecov License: GPL v3 Pypy-3.6 Python 3.5+ 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 flake8 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 :

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.6.tar.gz (12.8 kB view details)

Uploaded Source

File details

Details for the file yaml-resume-0.7.6.tar.gz.

File metadata

  • Download URL: yaml-resume-0.7.6.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.7.4

File hashes

Hashes for yaml-resume-0.7.6.tar.gz
Algorithm Hash digest
SHA256 d2f294380b6d3b585199293f31a506ca6e126bab7ad21724faea7abcec1c947b
MD5 86ea6194393191a036a1cd30ef2b9ce1
BLAKE2b-256 ad6d6fbf7352bed3c3b2e9d8cd2963537eea2542d1fff346b10f148ac7452813

See more details on using hashes here.

Supported by

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