Package index • autocv

The essentials

Helpers for an efficient, end-to-end command line workflow.

build_app_directory(): Create the file tree and data files for the present application.

build_base_directory(): Create the file tree and necessary data files to begin building a resume.

get_app_info() get_status_report() get_app_path_to(): Access application metadata.

open_app() edit_app() edit_base() delete_app(): Open, edit, and remove application documents.

render_app() render_base() render_cv() render_linkedin(): Run each resume or CV rendering step in sequence.

render_cover() render_cover_plain(): Construct a cover letter based on spreadsheet data.

render_cv_as_html() render_cv_as_pdf(): Construct a curriculum vitae based on spreadsheet data.

render_resume() render_resume_plain(): Construct a resume based on spreadsheet data.

update_app_info() update_datestamp() apply_to(): Update application metadata.

For fine-grained control

Finer control over data preparation, rendering, and keyword checks.

Prepare

Fine-grained control over spreadsheet data preparation.

prepare_bio(): Prepare bio.

prepare_description_bullets(): Prepare entry descriptions.

prepare_links() render_links(): Prepare formatted links with custom text.

prepare_timeline(): Prepare dates.

preprocess_contacts(): Prepare contact info card.

preprocess_entries(): Run each resume data pre-processing step in sequence.

preprocess_text(): Prepare text blocks.

Build

Construct and print resume sections to the output file.

build_skill_bars(): Construct a bar chart of skills.

build_skill_list(): Build skill list.

build_skill_table(): Build a two-column table of skills.

print_achievements(): Print the achievements listed in a text dataframe as bullet points.

print_contact_info(): Print contact info.

print_cover_body(): Print a cover letter from a text dataframe in a plain text or LaTeX style.

print_cover_plain(): Prepare and print each section of a plain text cover letter.

print_latex_section(): Print a section from a position dataframe to LaTeX.

print_resume_plain(): Prepare and print each section of a plain text resume.

print_section(): Print a section from a position dataframe to markdown.

print_txt_header(): Print a formatted plain text resume header.

print_txt_section(): Print sections of a plain text resume.

Check

Cross-check resume keywords with those in a term bank or job posting.

count_terms(): Count keyword occurrences in a file based on a supplied list.

report_skill_metrics() sort_skill_report(): Display skill report info for at-a-glance viewing.

run_skill_count() check_skills() count_terms_base(): Obtain keyword counts for a given doc/term list and generate reports.

run_skill_report(): Generate a skill report for a given job application.

Data handling

Helpers for finding and loading built-in datasets and templates.

autocv_resources(): Find the location of template data files on your system.

load_application_data(): Load application data.

load_job_info(): Read user-defined metadata for the present job.

load_log(): Load the log for a given application period.

For developers

Additional development tools and convenience functions.

Prepare

append_skills_to_bullets(): Append skills to a description field with matching index.

make_markdown_contacts() make_latex_contacts() make_txt_contacts(): Prepare individual entry in contact info card.

omit_hidden_fields(): Omit (nullify) spreadsheet cells beginning with a given prefix.

sort_skills(): Sort and filter skills.

Build

as_filename(): Construct a file name given a folder path, base name, id, and extension.

construct_app_metadata(): Create the metadata for a new application.

copy_files() create_folders(): Copy files and create folders from lists of source and target paths.

create_rprofile(): Write a default .Rprofile to a new project directory.

create_rproject(): Write a default .Rproject file to a new project directory and open.

get_latest_entry(): Obtain the latest entry in an application log.

get_valid_opts(): Obtain a set of valid options for indexing a job log by a given argument.

in_tmp_env(): Establish a temporary working tree for testing app-building functionality.

open_doc_and_wait(): Open an application document and pause execution until a key is entered.

open_with_application(): Open the document at a path with a given application.

set_project_paths(): Establish the root directory when building a new project.

str_to_filename(): Convert a string to a valid file name.

truncate_string(): Shorten long strings in a data frame for neater printing.

validate_id(): Verify that matching job identifiers belong to the same job.

validate_status(): Verify that the supplied status is valid.

write_app_metadata() write_log_entry(): Store metadata for a new application.

Check

download_webpage_txt() download_webpage_pdf(): Save the text from a webpage url.

find_matches_and_positions(): Find the number and position of terms matching a given term in a given text.

prep_term_list(): Prepare raw strings and entries in a keyword list for analysis.

I/O

get_path_to(): Construct an absolute path to a project directory for saving and loading.

CLI

alert_file_created() alert_folder_created(): Issue an alert that a file or folder has been created at the provided path.

alert_opening(): Issue an alert that a file or folder is opening from the provided path.

alert_writing_to() alert_reading_from(): Notify the user of the directory being read from or written to.

backup_file(): Transfer existing files to a backup directory Before overwriting.

format_action(): Format any 'action' text provided to a cli alert before printing.

warn_file_exists() warn_folder_exists(): Issue a warning that a file or folder already exists at the provided path.

warn_file_missing() warn_folder_missing(): Issue a warning that a file or folder does not exist at the provided path.

CLI handlers

cli_apply(): CLI handler for 'update'.

cli_build(): CLI handler for 'build'.

cli_check(): CLI handler for 'check'.

cli_edit(): CLI handler for 'edit'.

cli_open(): CLI handler for 'open'.

cli_render(): CLI handler for 'render'.

cli_review(): CLI handler for 'review'.