Skip to main content

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.

Release files for ycv 0.0.26

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ycv 0.0.26
File Size Uploaded
ycv-0.0.26.tar.gz 11.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for ycv 0.0.26
File Interpreter ABI Platform
ycv-0.0.26-py3-none-any.whl Python 3 none any Details

Total release size: 23.4 kB

Release files / ycv-0.0.26.tar.gz

Download URL ycv-0.0.26.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
634693e6f72793681637b8169820285bd6f45fb9b87c16e1954f0743a3ad1dea
BLAKE2b-256 checksum
How to use checksums
54f882b79b37bc7eb1a68e8301246f6bf68feb568d96c0362a63a14341d4b4ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.3

Release files / ycv-0.0.26-py3-none-any.whl

Download URL ycv-0.0.26-py3-none-any.whl
Size 11.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
060403caf70d152f8e8e5b32b229777792cbcca4646e6c2cfbebea5f4027b32a
BLAKE2b-256 checksum
How to use checksums
a2a778d4754421588b3397804e056cd9ebd9c7efc99ff81263db2a2fa9337006
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.3
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page