rendercv.renderer

The rendercv.renderer package contains the necessary classes and functions for generating Typst, PDF, Markdown, HTML, and PNG files from the RenderCVDataModel object.

The Typst and Markdown files are generated with Jinja2 templates. Then, the Typst file is rendered into a PDF and PNGs with typst package. The Markdown file is rendered into an HTML file with markdown package.

create_a_markdown_file(rendercv_data_model, output_directory)

Render the Markdown file with the given data model and write it to the output directory.

Parameters:

• rendercv_data_model (RenderCVDataModel) –

  The data model.

• output_directory (Path) –

  Path to the output directory.

Returns:

• Path –

  The path to the rendered Markdown file.

Source code in rendercv/renderer/renderer.py

def create_a_markdown_file(
    rendercv_data_model: data.RenderCVDataModel, output_directory: pathlib.Path
) -> pathlib.Path:
    """Render the Markdown file with the given data model and write it to the output
    directory.

    Args:
        rendercv_data_model: The data model.
        output_directory: Path to the output directory.

    Returns:
        The path to the rendered Markdown file.
    """
    # create output directory if it doesn't exist:
    if not output_directory.is_dir():
        output_directory.mkdir(parents=True)

    jinja2_environment = templater.Jinja2Environment().environment
    markdown_file_object = templater.MarkdownFile(
        rendercv_data_model,
        jinja2_environment,
    )

    markdown_file_name = f"{str(rendercv_data_model.cv.name).replace(' ', '_')}_CV.md"
    markdown_file_path = output_directory / markdown_file_name
    markdown_file_object.create_file(markdown_file_path)

    return markdown_file_path

create_a_typst_file(rendercv_data_model, output_directory)

Create a Typst file (depending on the theme) with the given data model and write it to the output directory.

Parameters:

• rendercv_data_model (RenderCVDataModel) –

  The data model.

• output_directory (Path) –

  Path to the output directory. If not given, the Typst file will be returned as a string.

Returns:

• Path –

  The path to the generated Typst file.

Source code in rendercv/renderer/renderer.py

def create_a_typst_file(
    rendercv_data_model: data.RenderCVDataModel,
    output_directory: pathlib.Path,
) -> pathlib.Path:
    """Create a Typst file (depending on the theme) with the given data model and write
    it to the output directory.

    Args:
        rendercv_data_model: The data model.
        output_directory: Path to the output directory. If not given, the Typst file
            will be returned as a string.

    Returns:
        The path to the generated Typst file.
    """

    typst_contents = create_contents_of_a_typst_file(rendercv_data_model)

    # Create output directory if it doesn't exist:
    if not output_directory.is_dir():
        output_directory.mkdir(parents=True)

    file_name = f"{str(rendercv_data_model.cv.name).replace(' ', '_')}_CV.typ"
    file_path = output_directory / file_name
    file_path.write_text(typst_contents, encoding="utf-8")

    return file_path

create_a_typst_file_and_copy_theme_files(rendercv_data_model, output_directory)

Render the Typst file with the given data model in the output directory and copy the auxiliary theme files to the output directory.

Parameters:

• rendercv_data_model (RenderCVDataModel) –

  The data model.

• output_directory (Path) –

  Path to the output directory.

Returns:

• Path –

  The path to the rendered Typst file.

Source code in rendercv/renderer/renderer.py

def create_a_typst_file_and_copy_theme_files(
    rendercv_data_model: data.RenderCVDataModel, output_directory: pathlib.Path
) -> pathlib.Path:
    """Render the Typst file with the given data model in the output directory and
    copy the auxiliary theme files to the output directory.

    Args:
        rendercv_data_model: The data model.
        output_directory: Path to the output directory.

    Returns:
        The path to the rendered Typst file.
    """
    file_path = create_a_typst_file(rendercv_data_model, output_directory)
    copy_theme_files_to_output_directory(
        rendercv_data_model.design.theme, output_directory
    )

    # Copy the profile picture to the output directory, if it exists:
    if rendercv_data_model.cv.photo:
        shutil.copyfile(
            rendercv_data_model.cv.photo,
            output_directory / rendercv_data_model.cv.photo.name,
        )

    return file_path

create_contents_of_a_typst_file(rendercv_data_model)

Create a Typst file with the given data model and return it as a string.

Parameters:

• rendercv_data_model (RenderCVDataModel) –

  The data model.

Returns:

• str –

  The path to the generated Typst file.

Source code in rendercv/renderer/renderer.py

def create_contents_of_a_typst_file(
    rendercv_data_model: data.RenderCVDataModel,
) -> str:
    """Create a Typst file with the given data model and return it as a string.

    Args:
        rendercv_data_model: The data model.

    Returns:
        The path to the generated Typst file.
    """
    jinja2_environment = templater.Jinja2Environment().environment

    file_object = templater.TypstFile(
        rendercv_data_model,
        jinja2_environment,
    )

    return file_object.get_full_code()

render_a_pdf_from_typst(file_path)

Run TinyTeX with the given Typst file to render the PDF.

Parameters:

• file_path (Path) –

  The path to the Typst file.

Returns:

• Path –

  The path to the rendered PDF file.

Source code in rendercv/renderer/renderer.py

def render_a_pdf_from_typst(file_path: pathlib.Path) -> pathlib.Path:
    """Run TinyTeX with the given Typst file to render the PDF.

    Args:
        file_path: The path to the Typst file.

    Returns:
        The path to the rendered PDF file.
    """
    typst_compiler = TypstCompiler(file_path)

    pdf_output_path = file_path.with_suffix(".pdf")
    typst_compiler.run(output=pdf_output_path, format="pdf")

    return pdf_output_path

render_an_html_from_markdown(markdown_file_path)

Render an HTML file from a Markdown file with the same name and in the same directory. It uses rendercv/themes/main.j2.html as the Jinja2 template.

Parameters:

• markdown_file_path (Path) –

  The path to the Markdown file.

Returns:

• Path –

  The path to the rendered HTML file.

Source code in rendercv/renderer/renderer.py

def render_an_html_from_markdown(markdown_file_path: pathlib.Path) -> pathlib.Path:
    """Render an HTML file from a Markdown file with the same name and in the same
    directory. It uses `rendercv/themes/main.j2.html` as the Jinja2 template.

    Args:
        markdown_file_path: The path to the Markdown file.

    Returns:
        The path to the rendered HTML file.
    """
    try:
        import markdown
    except Exception as e:
        from .. import _parial_install_error_message

        raise ImportError(_parial_install_error_message) from e

    # check if the file exists:
    if not markdown_file_path.is_file():
        message = f"The file {markdown_file_path} doesn't exist!"
        raise FileNotFoundError(message)

    # Convert the markdown file to HTML:
    markdown_text = markdown_file_path.read_text(encoding="utf-8")
    html_body = markdown.markdown(markdown_text)

    # Get the title of the markdown content:
    title = re.search(r"# (.*)\n", markdown_text)
    title = title.group(1) if title else None

    jinja2_environment = templater.Jinja2Environment().environment
    html_template = jinja2_environment.get_template("main.j2.html")
    html = html_template.render(html_body=html_body, title=title)

    # Write html into a file:
    html_file_path = markdown_file_path.parent / f"{markdown_file_path.stem}.html"
    html_file_path.write_text(html, encoding="utf-8")

    return html_file_path

render_pngs_from_typst(file_path, ppi=150)

Run Typst with the given Typst file to render the PNG files.

Parameters:

• file_path (Path) –

  The path to the Typst file.

• ppi (float, default: 150 ) –

  Pixels per inch for PNG output, defaults to 150.

Returns:

• list[Path] –

  Paths to the rendered PNG files.

Source code in rendercv/renderer/renderer.py

def render_pngs_from_typst(
    file_path: pathlib.Path, ppi: float = 150
) -> list[pathlib.Path]:
    """Run Typst with the given Typst file to render the PNG files.

    Args:
        file_path: The path to the Typst file.
        ppi: Pixels per inch for PNG output, defaults to 150.

    Returns:
        Paths to the rendered PNG files.
    """
    typst_compiler = TypstCompiler(file_path)
    output_path = file_path.parent / (file_path.stem + "_{p}.png")
    output = typst_compiler.run(format="png", ppi=ppi, output=output_path)

    if isinstance(output, list):
        return [
            output_path.parent / output_path.name.format(p=i)
            for i in range(len(output))
        ]

    return [output_path.parent / output_path.name.format(p=1)]