dbrownell-resumetools 0.10.0

Project:

Package:

Development:

Contents

• Overview
• Installation
• Development
• Additional Information
• License

Overview

dbrownell_ResumeTools separates a resume's content from its presentation.

Content is written once as JSON Resume data (json or yaml). Presentation is a css or less stylesheet applied to the html generated from that content. Updating a resume is then a matter of editing data rather than editing a document, and restyling one is a matter of changing a stylesheet rather than reformatting every entry by hand.

Text values within the content may be written as markdown, so emphasis, links, and lists live alongside the data that they decorate.

The generated html names what each value is rather than how it is displayed, and references no stylesheet other than the one provided. Layout, icons, fonts, and the resources that provide them are all decided by that stylesheet, so the same content can be presented in completely different ways without the generator being involved.

How to use dbrownell_ResumeTools

Generate html from resume content and a stylesheet:

uv run dbrownell_ResumeTools <content_filename> <style_filename> [<output_directory>]

Sample content and themes are included with the package; this command generates and displays the sample resume when it is run from the directory that contains them:

uv run dbrownell_ResumeTools resume.json standard.less --serve --browser

--serve serves the generated content over http and --browser displays it in a browser, which is served until that browser is closed. Run uv run dbrownell_ResumeTools --help for all available options.

A stylesheet may also be referenced by url, which applies a stylesheet that is not installed locally; the content that is downloaded is written to the output directory alongside the html that references it:

uv run dbrownell_ResumeTools resume.json https://raw.githubusercontent.com/davidbrownell/dbrownell_ResumeTools/main/src/dbrownell_ResumeTools/themes/standard.less --serve --browser

Creating a pdf

Print the displayed content to a pdf from the browser itself (Ctrl+P / Cmd+P, then "Save as PDF"). The bundled stylesheets define @media print rules that compact the content for a printed page, so no separate command is involved. The pdf produced by each bundled stylesheet is linked in the table below.

Writing a stylesheet

The generated html assigns a class to every value that names what the value is: the section that contains it (work, education, skills, ...), its role within that section (section-header, entry, entry-body, detail, ...), and the schema field that produced it (position, startDate, gpa, keyword, ...). Icons are empty icon elements that a stylesheet fills in through ::before. That contract is documented in full at the top of standard.less, and a stylesheet is free to lay those classes out however it likes.

Four stylesheets are bundled to demonstrate the range. All of them are applied to the same resume.json and to the same generated html:

standard.less	sidebar.less
timeline.less	minimal.less

Installation

Verifying Signed Artifacts

Artifacts are signed and verified using py-minisign and the public key in the file ./minisign_key.pub.

To verify that an artifact is valid, visit the latest release and download the .minisign signature file that corresponds to the artifact, then run the following command, replacing <filename> with the name of the artifact to be verified:

uv run --with py-minisign python -c "import minisign; minisign.PublicKey.from_file('minisign_key.pub').verify_file('<filename>'); print('The file has been verified.')"

Development

Please visit Contributing and Development for information on contributing to this project.

Additional Information

Additional information can be found at these locations.

License

dbrownell_ResumeTools is licensed under the MIT license.