Skip to content

rendercv.api

The rendercv.api package contains the functions to create a clean and simple API for RenderCV.

create_contents_of_a_typst_file(input_file_as_a_dict)

Validate the input file given as a dictionary, generate a Typst file and return it as a string. If there are any validation errors, return them as a list of dictionaries.

Parameters:

  • input_file_as_a_dict (dict) –

    The input file as a dictionary.

Returns:

  • str | list[dict] –

    The Typst file as a string or a list of dictionaries that contain the error messages, locations, and the input values.

Source code in rendercv/api/functions.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
def create_contents_of_a_typst_file(
    input_file_as_a_dict: dict,
) -> str | list[dict]:
    """
    Validate the input file given as a dictionary, generate a Typst file and return it
    as a string. If there are any validation errors, return them as a list of
    dictionaries.

    Args:
        input_file_as_a_dict: The input file as a dictionary.

    Returns:
        The Typst file as a string or a list of dictionaries that contain the error
            messages, locations, and the input values.
    """

    try:
        data_model = data.validate_input_dictionary_and_return_the_data_model(
            input_file_as_a_dict,
        )
    except pydantic.ValidationError as e:
        return data.parse_validation_errors(e)

    return renderer.create_contents_of_a_typst_file(data_model)