Skip to main content

Command line interface to build/validate YAML resumes

Project description

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 :

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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: yaml-resume-0.7.10.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for yaml-resume-0.7.10.tar.gz
Algorithm Hash digest
SHA256 6e68e8f7d83fd504fdb032d95376d0b6a3432dc3b3ad4edee2e906e225785e07
MD5 ad3d0e0359e8b3c0628500cda61be6c0
BLAKE2b-256 e72b81197bbf80cb9d1de8ad8076d7cd299b6e639800d62852fd27c81fa063f6

See more details on using hashes here.

File details

Details for the file yaml_resume-0.7.10-py3-none-any.whl.

File metadata

  • Download URL: yaml_resume-0.7.10-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for yaml_resume-0.7.10-py3-none-any.whl
Algorithm Hash digest
SHA256 684cded36bd29c06451e9b5b435ded7276d6624c24bff75bf9afabd9e17ad212
MD5 d6d1c81bd577b3ac0bf9b190cd29f86c
BLAKE2b-256 03f49c643fdeca0a2066e1d520fccfefaefab1f2f94a0d290d17f7ec63c4fe87

See more details on using hashes here.

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