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

Uploaded Source

Built Distribution

ycv-0.0.dev7-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ycv-0.0.dev7.tar.gz
Algorithm Hash digest
SHA256 7f99aa4fab8e95dc1fea0f490e95ea946322f6e40c20ad6ee9296c489604d600
MD5 7431333dd24b1360f85083f8cee42c75
BLAKE2b-256 f37b0f8943ae3c3d36990a19f8315807e4fcbab6a57ebf509abc51434901141f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ycv-0.0.dev7-py3-none-any.whl
Algorithm Hash digest
SHA256 f33e8771b94e8cf0f04c3ffc93b5955d94b1360adc74cd3e8710ff9ea1f40a0b
MD5 7184bd2c386eb504d1c018f19d193378
BLAKE2b-256 4dd2704b5ae90d08bb1866a2d8488e1afa5b8a73c64f616624f3f77dc71d48a1

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