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

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.

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

rendercv-2.2.tar.gz (8.3 MB view details)

Uploaded Source

Built Distribution

rendercv-2.2-py3-none-any.whl (122.5 kB view details)

Uploaded Python 3

File details

Details for the file rendercv-2.2.tar.gz.

File metadata

  • Download URL: rendercv-2.2.tar.gz
  • Upload date:
  • Size: 8.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for rendercv-2.2.tar.gz
Algorithm Hash digest
SHA256 f03cbfb9d643ae71a966f230bf2f0d9c191a54b9be5beb96509ae2c39d069976
MD5 19c72719e133489bfc9c8837837beea1
BLAKE2b-256 ed99727bdec8e5c471fdbb2fc4bc607772ca33b0dba566f2902f938b555eb40a

See more details on using hashes here.

Provenance

The following attestation bundles were made for rendercv-2.2.tar.gz:

Publisher: publish-a-release.yaml on rendercv/rendercv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rendercv-2.2-py3-none-any.whl.

File metadata

  • Download URL: rendercv-2.2-py3-none-any.whl
  • Upload date:
  • Size: 122.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for rendercv-2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 30d3882987abab3f7f9cda60da146b472f036bc38f6225be3d7d2e3f22fab772
MD5 4db58179b92ea1cfccff7f28d442d93f
BLAKE2b-256 46aa8240f7eaca11d27e0d0651df09fbf0c787b7c87e883240fc1dace9963d78

See more details on using hashes here.

Provenance

The following attestation bundles were made for rendercv-2.2-py3-none-any.whl:

Publisher: publish-a-release.yaml on rendercv/rendercv

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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