upload an example

John_Doe_CV.yaml

@@ -0,0 +1,205 @@
+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
+  summary: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque porta
+          vitae dolor vel placerat. Class aptent taciti sociosqu ad litora torquent per conubia
+          nostra, per inceptos himenaeos. Phasellus ullamcorper, neque id varius dignissim,
+          tellus sem maximus risus, at lobortis nisl sem id ligula.
+  section_order:
+    - Education
+    - Work Experience
+    - Academic Projects
+    - Certificates
+    - Personal Projects
+    - Skills
+    - Test Scores
+    - Extracurricular Activities
+    - Publications
+    - My Custom Section
+    - My Other Custom Section
+    - My Third Custom Section
+    - My Final Custom Section
+  education:
+    - institution: Boğaziçi University
+      url: https://boun.edu.tr
+      area: Mechanical Engineering
+      study_type: BS
+      location: Istanbul, Turkey
+      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"
+      transcript_url: https://example.com
+      gpa: 4.00/4.00
+      highlights: []
+  work_experience:
+    - company: CERN
+      position: Mechanical Engineer
+      location: Geneva, Switzerland
+      url: https://home.cern
+      start_date: "2023-02-01"
+      end_date: present
+      highlights:
+        - CERN is a research organization that operates the world's largest and most powerful particle accelerator.
+        - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+          incididunt ut labore et dolore magna aliqua.
+        - Id leo in vitae turpis massa sed, posuere aliquam ultrices sagittis orci a scelerisque,
+          lorem ipsum dolor sit amet.
+    - 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 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.
+  academic_projects:
+    - name: Design and Construction of a Dynamometer
+      location: Istanbul, Turkey
+      date: Fall 2022
+      highlights:
+        - Designed and constructed a controllable dynamometer that measures an electric
+          motor's torque and power output at different speeds for my senior design project.
+      url: https://example.com
+    - name: Design and Construction of an Automatic Guitar Tuner
+      location: Istanbul, Turkey
+      date: Fall 2020
+      highlights:
+        - Designed, built, and programmed a microcontroller-based device that tunes a
+          guitar with DC motors as part of a mechatronics course term project.
+      url: https://example.com
+  publications:
+    - title: Phononic band gaps induced by inertial amplification in periodic media
+      authors:
+        - Author 1
+        - John Doe
+        - Author 3
+      journal: Physical Review B
+      doi: 10.1103/PhysRevB.76.054309
+      date: "2007-08-01"
+      cited_by: 243
+  certificates:
+    - name: Machine Learning by Stanford University
+      date: "2022-09-01"
+      url: https://example.com
+  skills:
+    - name: Programming
+      details: C++, C, Python, JavaScript, MATLAB, Lua, LaTeX
+    - name: OS
+      details: Windows, Ubuntu
+    - name: Other tools
+      details: Git, Premake, HTML, CSS, React
+    - name: Languages
+      details: English (Advanced), French (Lower Intermediate), Turkish (Native)
+  test_scores:
+    - name: TOEFL
+      date: "2022-10-01"
+      details:
+        "113/120 — Reading: 29/30, Listening: 30/30, Speaking: 27/30, Writing:
+        27/30"
+      url: https://example.com
+    - name: GRE
+      details: "Verbal Reasoning: 160/170, Quantitative Reasoning: 170/170, Analytical Writing: 5.5/6"
+      url: https://example.com
+  personal_projects:
+    - name: Ray Tracing in C++
+      date: Spring 2021
+      highlights:
+        - Coded a ray tracer in C++ that can render scenes with multiple light sources,
+          spheres, and planes with reflection and refraction properties.
+      url: https://example.com
+  extracurricular_activities:
+    - company: Dumanlikiz Skiing Club
+      position: Co-founder / Skiing Instructor
+      location: Chamonix, France
+      date: Summer 2017 and 2018
+      highlights:
+        - Taught skiing during winters as a certified
+          skiing instructor.
+  custom_sections:
+    - title: My Custom Section
+      entry_type: OneLineEntry
+      entries:
+        - name: Testing custom sections
+          details: Wohooo!
+        - name: This is a
+          details: OneLineEntry!
+    - title: My Other Custom Section
+      entry_type: EducationEntry
+      entries:
+        - institution: Hop!
+          area: Hop!
+          study_type: HA
+          highlights:
+            - "There are only five types of entries: EducationEntry, ExperienceEntry,
+              NormalEntry, OneLineEntry, and PublicationEntry."
+            - This is an EducationEntry!
+          start_date: "2022-06-15"
+          end_date: "2022-08-01"
+    - title: My Third Custom Section
+      entry_type: ExperienceEntry
+      entries:
+        - company: Hop!
+          position: Hop!
+          date: My Date
+          location: My Location
+          highlights:
+            - I think this is really working. This is an ExperienceEntry!
+
+    - title: My Final Custom Section
+      entry_type: NormalEntry
+      entries:
+        - name: This is a normal entry!
+          highlights: 
+            - I don't have to specify a *date* or **location** every time.
+            - I can use *Markdown* in the **highlights** section!
+
+
+design:
+  theme: classic
+  font: SourceSans3
+  font_size: 10pt
+  page_size: a4paper
+  options:
+    primary_color: rgb(0,79,144)
+    date_and_location_width: 3.6 cm
+    show_timespan_in:
+      - Work Experience
+      - My Other Custom Section
+    show_last_updated_date: True
+
+    margins:
+      page:
+        top: 1.35 cm
+        bottom: 1.35 cm
+        left: 1.35 cm
+        right: 1.35 cm
+      section_title:
+        top: 0.13 cm
+        bottom: 0.13 cm
+      entry_area:
+        left: 0.2 cm
+        right: 0.2 cm
+        vertical_between: 0.12 cm
+      highlights_area:
+        top: 0.12 cm
+        left: 0.6 cm
+        vertical_between_bullet_points: 0.07 cm

rendercv/data_model.py

@@ -98,6 +98,9 @@ def check_spelling(sentence: str) -> str:
 
     if len(misspelled) > 0:
         for word in misspelled:
+            if len(word) == 1:
+                continue
+
             # for each misspelled word, check if it is in the dictionary and otherwise
             # give a warning
             if word in dictionary:
@@ -796,7 +799,7 @@ class OneLineEntry(Event):
         title="Name",
         description="The name of the entry. It will be shown as bold text.",
     )
-    details: str = Field(
+    details: SpellCheckedString = Field(
         title="Details",
         description="The details of the entry. It will be shown as normal text.",
     )
@@ -1014,7 +1017,7 @@ class Section(BaseModel):
         examples=["view on GitHub", "view on LinkedIn"],
     )
     entries: list[
-        NormalEntry | OneLineEntry | ExperienceEntry | EducationEntry | PublicationEntry
+        OneLineEntry | NormalEntry | ExperienceEntry | EducationEntry | PublicationEntry
     ] = Field(
         title="Entries",
         description="The entries of the section. The format depends on the entry type.",

run_rendercv.py

@@ -2,7 +2,7 @@ import os
 from rendercv.__main__ import main as rendercv_main
 from rendercv.data_model import generate_json_schema
 
-input_file_path = "personal.yaml"
+input_file_path = "John_Doe_CV.yaml"
 rendercv_main(input_file_path)
 
 # This script is equivalent to running the following command in the terminal: