Skip to content

Repository files navigation

RenderCV

The engine of the RenderCV App

testcoveragedocspypi-versionpypi-downloads

RenderCV engine is a Typst-based Python package with a command-line interface (CLI) that allows you to version-control your CV/resume as source code. It reads a CV written in a YAML file with Markdown syntax, converts it into a Typst code, and generates a PDF.

RenderCV engine's focus is to provide these three features:

  • Content-first approach: Users should be able to focus on the content instead of worrying about the formatting.
  • A mechanism to version-control a CV's content and design separately: The content and design of a CV are separate issues and they should be treated separately.
  • Robustness: A PDF should be delivered if there aren't any errors. If errors exist, they should be clearly explained along with solutions.

It takes a YAML file that looks like this:

cv:
name: John Doelocation: Locationemail: john.doe@example.comphone: tel:+1-609-999-9995social_networks:
- network: LinkedInusername: john.doe
- network: GitHubusername: john.doesections:
welcome_to_RenderCV!:
- '[RenderCV](https://rendercv.com) is a Typst-based CV framework designed for academics and engineers, with Markdown syntax support.'
- Each section title is arbitrary. Each section containsa list of entries, and there are 7 different entry typesto choose from.education:
- institution: Stanford Universityarea: Computer Sciencedegree: PhDlocation: Stanford, CA, USAstart_date: 2023-09end_date: presenthighlights:
- Working on the optimization of autonomous vehiclesin urban environments...

Then, it produces one of these PDFs with its corresponding Typst file, Markdown file, HTML file, and images as PNGs. Click on the images below to preview PDF files.

Classic Theme Example of RenderCVSb2nov Theme Example of RenderCV
Moderncv Theme Example of RenderCVEngineeringresumes Theme Example of RenderCV
Engineeringclassic Theme Example of RenderCVCustom themes can be added.

RenderCV comes with a JSON Schema so that the YAML input file can be filled out interactively.

JSON Schema of RenderCV

Getting Started

RenderCV engine is very easy to install (pip install "rendercv[full]") and easy to use (rendercv new "John Doe"). Follow the user guide to get started.

Motivation

We are developing a purpose-built app for writing CVs and resumes that will be available on mobile and web. This Python project is the foundation of that app. Check out our blog post to learn more about why one would use such an app.

Contributing

All contributions to RenderCV are welcome! To get started, please read the developer guide.

About

Version-control CVs/resumes as source code

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages