Skip to main content

Build CV and job application materials from yaml files

Project description

github PyPI version license Build Status

ycv

Build CV and job application materials using yaml files

Example PDFs

Here you can find the pdfs built using yaml and bib files in the example directory.

Installation

pip install ycv

Requirements

Usage

After installing ycv one can start building application materials using the command ycv from the terminal.

ycv -j job_name -y doc_type:yaml_file

Note: The command should be executed inside a directory that contains a authinfo.yaml and style.yaml file. If these are not present, these will be created on the fly using prompts. See here for more about these files.

  • ycv is designed to be used for multiple job applications and therefore requires a job_name to create a directory where all materials related to that job will be stored.
  • ycv can create multiple application materials for a given job at once. To create different materials one needs to provide the yaml files for these materials in the format doc_type:yaml_file with a space between different materials. For example, to create a cv and research statement, provide the yaml files as
ycv -j job_name -y cv:/path/to/cv.yaml research_plan:/path/to/research_statement.yaml

Note: The keys to yaml files should be one of the recognized ones

  • cv
  • research_plan
  • publications

more would be added to this list.

authinfo and style files

ycv requires a authinfo.yaml and style.yaml file.

  • authinfo.yaml contains information about the author which is used to a common header for all documents, for example. An example yaml file can be found here.
  • style.yaml file is used to apply customized style to different elements in the TeX documents. This gives the user freedom to apply a style of their preference. An example file can be found here.

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

ycv-0.0.dev2.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

ycv-0.0.dev2-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file ycv-0.0.dev2.tar.gz.

File metadata

  • Download URL: ycv-0.0.dev2.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for ycv-0.0.dev2.tar.gz
Algorithm Hash digest
SHA256 e2a3526d63a4b30d964a2fe8b2c73db38008fcc9bde2c8b1b2968726519241e1
MD5 bc221db4389a83f1c2c4b4b851287524
BLAKE2b-256 d30d935c3aed003a5a557884d57ed5cef8286eca7ae2804d78ac89dd59425235

See more details on using hashes here.

File details

Details for the file ycv-0.0.dev2-py3-none-any.whl.

File metadata

  • Download URL: ycv-0.0.dev2-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.8

File hashes

Hashes for ycv-0.0.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 41b9f8fbde17b1d19fa1488f71ea7adebba8eb6cfa6a9895684c80175698b6c1
MD5 c6bf22ab95533f893389759ff06bc02b
BLAKE2b-256 933a71edaf8773b2710fa0623ff84c8c97eade017387e9a8c7b99b7fa63bb7af

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