run_rendercv

run_rendercv(main_input_file_path_or_contents, progress, **kwargs)

Execute complete CV generation pipeline with progress tracking and error handling.

Why

Orchestrates the full flow: YAML → Pydantic validation → Typst generation → PDF/PNG/HTML/Markdown outputs. Catches all error types and displays them through progress panel for clean CLI experience.

Example

with ProgressPanel() as progress:
    run_rendercv(
        Path("cv.yaml"), progress, pdf_path="output.pdf", dont_generate_png=True
    )
# Generates PDF, skips PNG, shows progress for each step

Parameters:

• main_input_file_path_or_contents (Path | str) –

  YAML file path or raw content string.

• progress (ProgressPanel) –

  Progress panel for output display.

• kwargs (Unpack[BuildRendercvModelArguments], default: {} ) –

  Optional overrides for design/locale files, output paths, and generation flags.

Source code in src/rendercv/cli/render_command/run_rendercv.py

def run_rendercv(
    main_input_file_path_or_contents: pathlib.Path | str,
    progress: ProgressPanel,
    **kwargs: Unpack[BuildRendercvModelArguments],
):
    """Execute complete CV generation pipeline with progress tracking and error handling.

    Why:
        Orchestrates the full flow: YAML → Pydantic validation → Typst generation →
        PDF/PNG/HTML/Markdown outputs. Catches all error types and displays them
        through progress panel for clean CLI experience.

    Example:
        ```py
        with ProgressPanel() as progress:
            run_rendercv(
                Path("cv.yaml"), progress, pdf_path="output.pdf", dont_generate_png=True
            )
        # Generates PDF, skips PNG, shows progress for each step
        ```

    Args:
        main_input_file_path_or_contents: YAML file path or raw content string.
        progress: Progress panel for output display.
        kwargs: Optional overrides for design/locale files, output paths, and generation flags.
    """
    try:
        _, rendercv_model = timed_step(
            "Validated the input file",
            progress,
            build_rendercv_dictionary_and_model,
            main_input_file_path_or_contents,
            **kwargs,
        )
        typst_path = timed_step(
            "Generated Typst",
            progress,
            generate_typst,
            rendercv_model,
        )
        timed_step(
            "Generated PDF",
            progress,
            generate_pdf,
            rendercv_model,
            typst_path,
        )
        timed_step(
            "Generated PNG",
            progress,
            generate_png,
            rendercv_model,
            typst_path,
        )
        md_path = timed_step(
            "Generated Markdown",
            progress,
            generate_markdown,
            rendercv_model,
        )
        timed_step(
            "Generated HTML",
            progress,
            generate_html,
            rendercv_model,
            md_path,
        )
        progress.finish_progress()
    except RenderCVUserError as e:
        progress.print_user_error(e)
    except ruamel.yaml.YAMLError as e:
        progress.print_user_error(
            RenderCVUserError(message=f"This is not a valid YAML file!\n\n{e}")
        )
    except jinja2.exceptions.TemplateSyntaxError as e:
        progress.print_user_error(
            RenderCVUserError(
                message=(
                    f"There is a problem with the template ({e.filename}) at line"
                    f" {e.lineno}!\n\n{e}"
                )
            )
        )
    except OSError as e:
        progress.print_user_error(RenderCVUserError(message=f"OS Error: {e}"))
    except RenderCVUserValidationError as e:
        progress.print_validation_errors(e.validation_errors)

timed_step(message, progress_panel, func, *args, **kwargs)

Execute function, measure timing, and update progress panel with result.

Why

Each generation step (Typst, PDF, PNG) returns file paths. This wrapper times execution and automatically displays results in progress panel.

Example

pdf_path = timed_step(
    "Generated PDF", progress, generate_pdf, rendercv_model, typst_path
)
# Progress shows: ✓ 150 ms  Generated PDF: ./cv.pdf

Parameters:

• message (str) –

  Step description for progress display.

• progress_panel (ProgressPanel) –

  Progress panel to update.

• func (Callable[P, T]) –

  Function to execute and time.

• args (P.args, default: () ) –

  Positional arguments for func.

• kwargs (P.kwargs, default: {} ) –

  Keyword arguments for func.

Returns:

• T –

  Function result.

Source code in src/rendercv/cli/render_command/run_rendercv.py

def timed_step[T, **P](
    message: str,
    progress_panel: ProgressPanel,
    func: Callable[P, T],
    *args: P.args,
    **kwargs: P.kwargs,
) -> T:
    """Execute function, measure timing, and update progress panel with result.

    Why:
        Each generation step (Typst, PDF, PNG) returns file paths. This wrapper
        times execution and automatically displays results in progress panel.

    Example:
        ```py
        pdf_path = timed_step(
            "Generated PDF", progress, generate_pdf, rendercv_model, typst_path
        )
        # Progress shows: ✓ 150 ms  Generated PDF: ./cv.pdf
        ```

    Args:
        message: Step description for progress display.
        progress_panel: Progress panel to update.
        func: Function to execute and time.
        args: Positional arguments for func.
        kwargs: Keyword arguments for func.

    Returns:
        Function result.
    """
    start = time.perf_counter()
    result = func(*args, **kwargs)
    end = time.perf_counter()
    timing_ms = f"{(end - start) * 1000:.0f}"

    paths: list[pathlib.Path] = []
    if isinstance(result, pathlib.Path):
        paths = [result]
    elif isinstance(result, list) and result:
        if len(result) > 1:
            message = f"{message}s"
        paths = result

    if paths:
        progress_panel.update_progress(
            time_took=timing_ms, message=message, paths=paths
        )

    return result