Skip to main content

A tool for automatic resume generation based on Jinja-Word-templates and YAML-files

Project description

Resume-as-code

TODO: update ReadMe

Description

This project is aimed at reducing the work required to create resumes.

In the business context, it is often required to have resumes in all kinds of different formats, styles, etc.

We want our team members at Dataroots to spend as little as time possible on formatting their resume(s), and have the ability to generate their resume in an efficient fashion.

For this, resume-as-code was created. This resume generator combines technologies such as Jinja, yaml and allows the decoupling of creating a resume from formatting a resume.

The idea is that it is possible to define template, such as LaTex, Word, Markdown, etc. and using the same YAML-file, all different kinds of resumes can be generated.


Installation

This is a Python-based tool.

It is developed on Python 3.9.1 and it hasn't been tested on other python versions.

For the remainder of this installation and usage guide, it is assomed that you have python version 3.9.1 installed, together with pip@21.3.1.

Set up:

  • Download the code from github
git clone git@github.com:datarootsio/resume-as-code.git
  • Install the requirements in requirements.txt
pip install -r requirements.txt
  • Generate Google Drive credentials in https://console.cloud.google.com/apis/dashboard
  • Store the credentials in a secrets folder.
  • Create an environment file in /src (execute from project root).
    • Add the path to the credentials folder
    • Add a path to the file that will be used to store the Google Drive token in.
    • Add the location of the resume_schema
    • Add the allowed image format
touch ./src/.env
cat << EOT >> ./src/.env
CREDENTIALS_FILENAME=/path/to/secrets/credentials.json
TOKEN_FILENAME=/path/to/secrets/token.json
SCHEMA_FILENAME=/path/to/resume_schema.yaml
IMAGE_FORMATS='["image/png","image/jpeg","image/jpg"]'
EOT

Usage

Currently, the tool only supports Word templates.

There is 1 non-optional argument, namely the location of the resume (yaml-file) on your disk.

Local template, local target

  • Use a local template on disk
  • Store the template locally on disk

Example usage:

python main.py /path/to/resume.yaml --template_location /path/to/template.docx --target_location /path/to/target.docx

Local template, target on drive

  • Use a local template on disk
  • Store the template on your google drive.
    • If we do no specify target_location, the generated file is sent to Google Drive

Example usage:

python main.py /path/to/resume.yaml --template_location /path/to/template.docx

Template on drive

  • Use a template from your drive
  • This is done by passing the name of the docx-template (without the extension) to the command

Example usage:

python main.py /path/to/resume.yaml --template_name name-of-template-on-drive

Verbosity

Verbosity can be enabled by passing the --verbose- or -v-flag to the tool.

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

resume-as-code-0.0.11.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resume_as_code-0.0.11-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file resume-as-code-0.0.11.tar.gz.

File metadata

  • Download URL: resume-as-code-0.0.11.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.14

File hashes

Hashes for resume-as-code-0.0.11.tar.gz
Algorithm Hash digest
SHA256 93de3e44b9ac05eac03879725e10cdcd5d4d6843e4240395d33c502e34ff2f9d
MD5 2a854797d55639230a41ac687efe5de3
BLAKE2b-256 0cb7a7bfe62cc4b7d5728f6e275b3fdc9b4d4a577725c637387548bef1fb61bc

See more details on using hashes here.

File details

Details for the file resume_as_code-0.0.11-py3-none-any.whl.

File metadata

File hashes

Hashes for resume_as_code-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 3cc125d0c466bcae8efec69ae01d395fba298450d70fa8062a8d5ae53101c719
MD5 a87a565d3f25da22f5b9dff96b75a115
BLAKE2b-256 5c0c795dc4a3e407b79889d8574811ba129cc15639782f2676bacf91c3587b0e

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