3.9 KiB

Raw Blame History

Developer Guide

All contributions to RenderCV are welcome!

The source code is thoroughly documented and well-commented, making it an enjoyable read and easy to understand. Also, a flowchart is provided below to help you understand how RenderCV works.

Getting Started

Ensure that you have Python version 3.10 or higher.
Install Hatch, as it is the project manager for RenderCV. The installation guide for Hatch can be found here.
Clone the repository recursively (because TinyTeX is being used as a submodule) with the following command.
```
git clone --recursive https://github.com/sinaatalay/rendercv.git
```
Go to the rendercv directory.
```
cd rendercv
```
RenderCV uses three virtual environments:
- default: For the development. It contains packages like Ruff, Black, etc.
- docs: For building the documentation.
- test: For testing RenderCV.
Create the virtual environments with the following commands.
```
hatch env create default
hatch env create docs
hatch env create test
```
To use the virtual environments, either
- Activate one of the virtual environments with the following command.
```
hatch shell default
```
- Select one of the virtual environments in your Integrated Development Environment (IDE).
  
  === "Visual Studio Code"
```
  - Press `Ctrl+Shift+P`.
  - Type `Python: Select Interpreter`.
  - Select one of the virtual environments created by Hatch.
```
  === "Other"
```
  To be added.
```

How RenderCV works?

The flowchart below illustrates the general operations of RenderCV. A detailed documentation of the source code is available in the reference.

flowchart TD
    A[YAML Input File] --parsing with ruamel.yaml package--> B(Python Dictionary)
    B --validation with pydantic package--> C((Pydantic Object))
    C --> D[LaTeX File]
    C --> E[Markdown File]
    E --markdown package--> K[HTML FIle]
    D --TinyTeX--> L[PDF File]
    L --PyMuPDF package--> Z[PNG Files]
    AA[(Jinja2 Templates)] --> D
    AA[(Jinja2 Templates)] --> E

Available Commands

These commands are defined in the pyproject.toml file.

Format the code with Black:
```
hatch run default:format
```
Lint the code with Ruff:
```
hatch run default:lint
```
Run the tests:
```
hatch run test:run
```
Run the tests and generate a coverage report:
```
hatch run test:run-and-report
```
Start the development server for the documentation:
```
hatch run docs:serve
```
Build the documentation:
```
hatch run docs:build
```
Deploy the documentation to GitHub Pages:
```
hatch run docs:deploy
```
Update schema.json:
```
hatch run docs:update-schema
```
Update examples folder:
```
hatch run docs:update-examples
```
Update figures of the entry types in the "Structure of the YAML Input File":
```
hatch run docs:update-entry-figures
```

About `pyproject.toml`

pyproject.toml contains all the metadata, dependencies, and tools required for the project. Please read through the file to understand the project's technical details.

3.9 KiB Raw Blame History