Skip to main content

Typst-based CV/resume generator

Project description

RenderCV

The engine of the RenderCV App

test coverage docs pypi-version pypi-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 Doe
  location: Location
  email: john.doe@example.com
  phone: tel:+1-609-999-9995
  social_networks:
    - network: LinkedIn
      username: john.doe
    - network: GitHub
      username: john.doe
  sections:
    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 contains
        a list of entries, and there are 7 different entry types
        to choose from.
    education:
      - institution: Stanford University
        area: Computer Science
        degree: PhD
        location: Stanford, CA, USA
        start_date: 2023-09
        end_date: present
        highlights:
          - Working on the optimization of autonomous vehicles
            in 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 RenderCV Sb2nov Theme Example of RenderCV
Moderncv Theme Example of RenderCV Engineeringresumes Theme Example of RenderCV
Engineeringclassic Theme Example of RenderCV Custom 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

uptal-rendercv is very easy to install (pip install "uptal-rendercv[full]") and easy to use (uptal-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.

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

uptal_rendercv-2.4.2.tar.gz (29.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uptal_rendercv-2.4.2-py3-none-any.whl (124.2 kB view details)

Uploaded Python 3

File details

Details for the file uptal_rendercv-2.4.2.tar.gz.

File metadata

  • Download URL: uptal_rendercv-2.4.2.tar.gz
  • Upload date:
  • Size: 29.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for uptal_rendercv-2.4.2.tar.gz
Algorithm Hash digest
SHA256 8d8e39c620d4e819aff7a3d0d660a3318894028959071b066683d4ca1f6a9f8e
MD5 1f8e88609e2cb466729180ab3356e50c
BLAKE2b-256 bd9dfbaa82e9e3b0fdf2573c1ad14346c6f77e99ccfe94d5e3899031c8244e12

See more details on using hashes here.

File details

Details for the file uptal_rendercv-2.4.2-py3-none-any.whl.

File metadata

  • Download URL: uptal_rendercv-2.4.2-py3-none-any.whl
  • Upload date:
  • Size: 124.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.9

File hashes

Hashes for uptal_rendercv-2.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dacc247d20f0955da70e2c7fc55cc7737758efc9f83826bf66ed0b8fbf1f8698
MD5 807eee8735c751bda67a65a87999cd1d
BLAKE2b-256 9ae36f0731c8de78351073cbc822a9bff41c018766583047cd38c97bcab237b3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page