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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ycv-0.0.dev5.tar.gz
  • Upload date:
  • Size: 11.1 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.dev5.tar.gz
Algorithm Hash digest
SHA256 8815e7e1eba420873039cb470674bc8c1366ddc5983ad274134797d540672ae9
MD5 263f427e0312d8edb3330ab84f519837
BLAKE2b-256 cbc354a2dcc5ff1fd08ed8038f4febaf3769a2f7887f091fc9d77f31929412d2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ycv-0.0.dev5-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.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 c076d746059cee7fec5a450295b7a5acb47e85c28bd3a8a4fc162c02712195c4
MD5 9468d07f62a09ab32214e2a6e9407d3a
BLAKE2b-256 3b3837ce1b60586e846b3e6a6bffe82fe07043328a9f0def838d4d3f1ecba8f3

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