LaTeX CV generator from a YAML/JSON file
Project description
RenderCV
RenderCV is a Python application that creates a $\LaTeX$ CV as a PDF from a JSON/YAML input file. Currently, it only supports one theme (classic). An example PDF can be seen here. More themes are planned to be supported in the future.
What does it do?
- It parses a YAML (or JSON) file that looks like this:
cv:
name: John Doe
label: Mechanical Engineer
location: Geneva, Switzerland
email: johndoe@example.com
phone: "+33749882538"
website: https://example.com
social_networks:
- network: GitHub
username: johndoe
- network: LinkedIn
username: johndoe
education:
- institution: My University
url: https://example.com
area: Mechanical Engineering
study_type: BS
location: Geneva, Switzerland
start_date: "2017-09-01"
end_date: "2023-01-01"
transcript_url: https://example.com
gpa: 3.10/4.00
highlights:
- "Class rank: 10 of 62"
- institution: The University of Texas at Austin
url: https://utexas.edu
area: Mechanical Engineering, Student Exchange Program
location: Austin, TX, USA
start_date: "2021-08-01"
end_date: "2022-01-15"
work_experience:
- company: AmIACompany
position: Summer Intern
location: Istanbul, Turkey
url: https://example.com
start_date: "2022-06-15"
end_date: "2022-08-01"
highlights:
- AmIACompany is a **technology** (markdown is
supported) company that provides web-based
engineering applications that enable the
simulation and optimization of products and
manufacturing tools.
- Modeled and simulated a metal-forming process deep
drawing using finite element analysis with
open-source software called CalculiX.
- Then, it validates the input, such as checking if the dates are consistent, checking if the URLs are correct, etc.
- Then, it creates a $\LaTeX$ file.
- Finally, it renders the $\LaTeX$ file to generate the PDF, and you don't need $\LaTeX$ installed on your PC because RenderCV comes with TinyTeX.
Quick Start Guide
- Install Python (3.10 or newer).
- Run the command below to install RenderCV.
pip install rendercv
- Run the command below to generate a sample input file (
Full_Name_CV.yaml
). The file will be generated in the current working directory.rendercv new "Full Name"
- Edit the contents of the
Full_Name_CV.yaml
file. - Run the command below to generate your $\LaTeX$ CV.
rendercv render Full_Name_CV.yaml
Detailed User Guide and Documentation
A more detailed user guide can be found here.
I documented the whole code with docstrings and used comments throughout the code. The code documentation can be found here.
Contributing
All contributions to RenderCV are welcome, especially adding new $\LaTeX$ themes.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file rendercv-0.8.tar.gz
.
File metadata
- Download URL: rendercv-0.8.tar.gz
- Upload date:
- Size: 106.8 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 38bdda9fb36331edc955b7c32eb08695b223dd1fd51f5724e62f7d09f44fae5c |
|
MD5 | 131fe151bd053ae5fd5726e778b04334 |
|
BLAKE2b-256 | 42323c6ae755471deff3c79b2fb376488c22200655243aecac1fee4f1823ca68 |
File details
Details for the file rendercv-0.8-py3-none-any.whl
.
File metadata
- Download URL: rendercv-0.8-py3-none-any.whl
- Upload date:
- Size: 107.7 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 405ef7c7c72049bdd69bf62168863098922348ac3b31af2e2c666a28e6ad4976 |
|
MD5 | 40618cf6c5c223ff75e7ba994c15507e |
|
BLAKE2b-256 | 9d611a05ff27d23949a753e83cbdf1db3e8abe5e798a453443c41b6b00eab639 |