Skip to content

render_command

file_path_placeholders_description = 'The following placeholders can be used:\n\n- MONTH_NAME: Full name of the month (e.g., January)\n- MONTH_ABBREVIATION: Abbreviation of the month (e.g., Jan)\n- MONTH: Month as a number (e.g., 1)\n- MONTH_IN_TWO_DIGITS: Month as a number in two digits (e.g., 01)\n- YEAR: Year as a number (e.g., 2024)\n- YEAR_IN_TWO_DIGITS: Year as a number in two digits (e.g., 24)\n- NAME: The name of the CV owner (e.g., John Doe)\n- NAME_IN_SNAKE_CASE: The name of the CV owner in snake case (e.g., John_Doe)\n- NAME_IN_LOWER_SNAKE_CASE: The name of the CV owner in lower snake case (e.g., john_doe)\n- NAME_IN_UPPER_SNAKE_CASE: The name of the CV owner in upper snake case (e.g., JOHN_DOE)\n- NAME_IN_KEBAB_CASE: The name of the CV owner in kebab case (e.g., John-Doe)\n- NAME_IN_LOWER_KEBAB_CASE: The name of the CV owner in lower kebab case (e.g., john-doe)\n- NAME_IN_UPPER_KEBAB_CASE: The name of the CV owner in upper kebab case (e.g., JOHN-DOE)\n' module-attribute

RenderCommand

Bases: BaseModelWithoutExtraKeys

design = pydantic.Field(default=None, description='Path to a YAML file containing the `design` field.') class-attribute instance-attribute

dont_generate_html = pydantic.Field(default=False, title="Don't Generate HTML", description='Skip HTML generation. The default value is `false`.') class-attribute instance-attribute

dont_generate_markdown = pydantic.Field(default=False, title="Don't Generate Markdown", description='Skip Markdown generation. This also disables HTML generation. The default value is `false`.') class-attribute instance-attribute

dont_generate_pdf = pydantic.Field(default=False, title="Don't Generate PDF", description='Skip PDF generation. The default value is `false`.') class-attribute instance-attribute

dont_generate_png = pydantic.Field(default=False, title="Don't Generate PNG", description='Skip PNG generation. The default value is `false`.') class-attribute instance-attribute

dont_generate_typst = pydantic.Field(default=False, title="Don't Generate Typst", description='Skip Typst generation. This also disables PDF and PNG generation. The default value is `false`.') class-attribute instance-attribute

html_path = pydantic.Field(default=(pathlib.Path('rendercv_output/NAME_IN_SNAKE_CASE_CV.html')), description=f'Output path for the HTML file, relative to the input YAML file. The default value is `rendercv_output/NAME_IN_SNAKE_CASE_CV.html`.{file_path_placeholders_description}') class-attribute instance-attribute

locale = pydantic.Field(default=None, description='Path to a YAML file containing the `locale` field.') class-attribute instance-attribute

markdown_path = pydantic.Field(default=(pathlib.Path('rendercv_output/NAME_IN_SNAKE_CASE_CV.md')), title='Markdown Path', description=f'Output path for the Markdown file, relative to the input YAML file. The default value is `rendercv_output/NAME_IN_SNAKE_CASE_CV.md`.{file_path_placeholders_description}') class-attribute instance-attribute

model_config = pydantic.ConfigDict(extra='forbid', validate_default=True) class-attribute instance-attribute

pdf_path = pydantic.Field(default=(pathlib.Path('rendercv_output/NAME_IN_SNAKE_CASE_CV.pdf')), description=f'Output path for the PDF file, relative to the input YAML file. The default value is `rendercv_output/NAME_IN_SNAKE_CASE_CV.pdf`.{file_path_placeholders_description}') class-attribute instance-attribute

png_path = pydantic.Field(default=(pathlib.Path('rendercv_output/NAME_IN_SNAKE_CASE_CV.png')), description=f'Output path for PNG files, relative to the input YAML file. The default value is `rendercv_output/NAME_IN_SNAKE_CASE_CV.png`.{file_path_placeholders_description}') class-attribute instance-attribute

typst_path = pydantic.Field(default=(pathlib.Path('rendercv_output/NAME_IN_SNAKE_CASE_CV.typ')), description=f'Output path for the Typst file, relative to the input YAML file. The default value is `rendercv_output/NAME_IN_SNAKE_CASE_CV.typ`.{file_path_placeholders_description}') class-attribute instance-attribute