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

Uploaded Source

Built Distribution

ycv-0.0.dev6-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ycv-0.0.dev6.tar.gz
Algorithm Hash digest
SHA256 7d2fd2e58f9449cabde8ded6d7c0a60410ff255058f927ac52678f07c5910ecf
MD5 27df0b1a1af4c62abc9b03bae95871fd
BLAKE2b-256 b8f7ba1bd981c39c1be7ca09441595108ca15ed1dd7bdbb9717c6fa6f668b5ae

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ycv-0.0.dev6-py3-none-any.whl
Algorithm Hash digest
SHA256 9dd04fc3909ea333ee6b47756ed6908ef6297e5d3983b3496d6a944814b0cf97
MD5 1f6ff5f5d703e90f624a59bf8e28087d
BLAKE2b-256 13527a54b7e5c4518281e61ba41b209db5ee1e4a35a3603b4c089c6e91403d9f

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