mirror of https://github.com/eyhc1/rendercv.git
move common theme options to rendercv.themes
This commit is contained in:
Sina Atalay
parent
a6859fb06c
commit
079cb1cf5b
|
|
@ -1,6 +1,9 @@
|
||||||
from typing import Annotated
|
""" """
|
||||||
|
|
||||||
|
from typing import Literal, Annotated
|
||||||
|
|
||||||
import pydantic
|
import pydantic
|
||||||
|
import pydantic_extra_types.color as pydantic_color
|
||||||
|
|
||||||
LaTeXDimension = Annotated[
|
LaTeXDimension = Annotated[
|
||||||
str,
|
str,
|
||||||
|
|
@ -31,3 +34,186 @@ class PageMargins(pydantic.BaseModel):
|
||||||
title="Right Margin",
|
title="Right Margin",
|
||||||
description="The right margin of the page with units.",
|
description="The right margin of the page with units.",
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class SectionTitleMargins(pydantic.BaseModel):
|
||||||
|
top: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.2 cm",
|
||||||
|
title="Top Margin",
|
||||||
|
description="The top margin of section titles. The default value is 0.2 cm.",
|
||||||
|
)
|
||||||
|
bottom: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.2 cm",
|
||||||
|
title="Bottom Margin",
|
||||||
|
description="The bottom margin of section titles. The default value is 0.2 cm.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class EntryAreaMargins(pydantic.BaseModel):
|
||||||
|
left_and_right: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.2 cm",
|
||||||
|
title="Left Margin",
|
||||||
|
description="The left margin of entry areas. The default value is 0.2 cm.",
|
||||||
|
)
|
||||||
|
|
||||||
|
vertical_between: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.12 cm",
|
||||||
|
title="Vertical Margin Between Entry Areas",
|
||||||
|
description=(
|
||||||
|
"The vertical margin between entry areas. The default value is 0.12 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
date_and_location_width: LaTeXDimension = pydantic.Field(
|
||||||
|
default="4.1 cm",
|
||||||
|
title="Date and Location Column Width",
|
||||||
|
description=(
|
||||||
|
"The width of the date and location column. The default value is 4.1 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class HighlightsAreaMargins(pydantic.BaseModel):
|
||||||
|
top: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.10 cm",
|
||||||
|
title="Top Margin",
|
||||||
|
description="The top margin of highlights areas. The default value is 0.10 cm.",
|
||||||
|
)
|
||||||
|
left: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.4 cm",
|
||||||
|
title="Left Margin",
|
||||||
|
description="The left margin of highlights areas. The default value is 0.4 cm.",
|
||||||
|
)
|
||||||
|
vertical_between_bullet_points: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.10 cm",
|
||||||
|
title="Vertical Margin Between Bullet Points",
|
||||||
|
description=(
|
||||||
|
"The vertical margin between bullet points. The default value is 0.10 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class HeaderMargins(pydantic.BaseModel):
|
||||||
|
vertical_between_name_and_connections: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.2 cm",
|
||||||
|
title="Vertical Margin Between the Name and Connections",
|
||||||
|
description=(
|
||||||
|
"The vertical margin between the name of the person and the connections."
|
||||||
|
" The default value is 0.2 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
bottom: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.2 cm",
|
||||||
|
title="Bottom Margin",
|
||||||
|
description=(
|
||||||
|
"The bottom margin of the header, i.e., the vertical margin between the"
|
||||||
|
" connections and the first section title. The default value is 0.2 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
horizontal_between_connections: LaTeXDimension = pydantic.Field(
|
||||||
|
default="0.5 cm",
|
||||||
|
title="Space Between Connections",
|
||||||
|
description=(
|
||||||
|
"The space between the connections (like phone, email, and website). The"
|
||||||
|
" default value is 0.5 cm."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Margins(pydantic.BaseModel):
|
||||||
|
page: PageMargins = pydantic.Field(
|
||||||
|
default=PageMargins(),
|
||||||
|
title="Page Margins",
|
||||||
|
description="Page margins.",
|
||||||
|
)
|
||||||
|
section_title: SectionTitleMargins = pydantic.Field(
|
||||||
|
default=SectionTitleMargins(),
|
||||||
|
title="Section Title Margins",
|
||||||
|
description="Section title margins.",
|
||||||
|
)
|
||||||
|
entry_area: EntryAreaMargins = pydantic.Field(
|
||||||
|
default=EntryAreaMargins(),
|
||||||
|
title="Entry Area Margins",
|
||||||
|
description="Entry area margins.",
|
||||||
|
)
|
||||||
|
highlights_area: HighlightsAreaMargins = pydantic.Field(
|
||||||
|
default=HighlightsAreaMargins(),
|
||||||
|
title="Highlights Area Margins",
|
||||||
|
description="Highlights area margins.",
|
||||||
|
)
|
||||||
|
header: HeaderMargins = pydantic.Field(
|
||||||
|
default=HeaderMargins(),
|
||||||
|
title="Header Margins",
|
||||||
|
description="Header margins.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class ThemeOptions(pydantic.BaseModel):
|
||||||
|
""" """
|
||||||
|
|
||||||
|
model_config = pydantic.ConfigDict(extra="forbid")
|
||||||
|
|
||||||
|
font_size: Literal["10pt", "11pt", "12pt"] = pydantic.Field(
|
||||||
|
default="10pt",
|
||||||
|
title="Font Size",
|
||||||
|
description="The font size of the CV. The default value is 10pt.",
|
||||||
|
)
|
||||||
|
page_size: Literal["a4paper", "letterpaper"] = pydantic.Field(
|
||||||
|
default="letterpaper",
|
||||||
|
title="Page Size",
|
||||||
|
description=(
|
||||||
|
"The page size of the CV. It can be a4paper or letterpaper. The default"
|
||||||
|
" value is letterpaper."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
color: pydantic_color.Color = pydantic.Field(
|
||||||
|
default="rgb(0,79,144)",
|
||||||
|
validate_default=True,
|
||||||
|
title="Primary Color",
|
||||||
|
description=(
|
||||||
|
"The primary color of the theme. \nThe color can be specified either with"
|
||||||
|
" their [name](https://www.w3.org/TR/SVG11/types.html#ColorKeywords),"
|
||||||
|
" hexadecimal value, RGB value, or HSL value. The default value is"
|
||||||
|
" rgb(0,79,144)."
|
||||||
|
),
|
||||||
|
examples=["Black", "7fffd4", "rgb(0,79,144)", "hsl(270, 60%, 70%)"],
|
||||||
|
)
|
||||||
|
disable_page_numbering: bool = pydantic.Field(
|
||||||
|
default=False,
|
||||||
|
title="Disable Page Numbering",
|
||||||
|
description=(
|
||||||
|
"If this option is set to true, then the page numbering will be disabled."
|
||||||
|
" The default value is false."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
page_numbering_style: str = pydantic.Field(
|
||||||
|
default="NAME -- Page PAGE_NUMBER of TOTAL_PAGES",
|
||||||
|
title="Page Numbering Style",
|
||||||
|
description=(
|
||||||
|
"The style of the page numbering. The following placeholders can be used:"
|
||||||
|
"\n- NAME: The name of the person\n- PAGE_NUMBER: The current page number"
|
||||||
|
"\n- TOTAL_PAGES: The total number of pages\nThe default value is"
|
||||||
|
" NAME -- Page PAGE_NUMBER of TOTAL_PAGES."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
show_last_updated_date: bool = pydantic.Field(
|
||||||
|
default=True,
|
||||||
|
title="Show Last Updated Date",
|
||||||
|
description=(
|
||||||
|
"If this option is set to true, then the last updated date will be shown"
|
||||||
|
" in the header. The default value is true."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
header_font_size: LaTeXDimension = pydantic.Field(
|
||||||
|
default="30 pt",
|
||||||
|
title="Header Font Size",
|
||||||
|
description=(
|
||||||
|
"The font size of the header (the name of the person). The default value is"
|
||||||
|
" 30 pt."
|
||||||
|
),
|
||||||
|
)
|
||||||
|
margins: Margins = pydantic.Field(
|
||||||
|
default=Margins(),
|
||||||
|
title="Margins",
|
||||||
|
description="Page, section title, entry field, and highlights field margins.",
|
||||||
|
)
|
||||||
|
|
|
||||||
|
|
@ -1,179 +1,26 @@
|
||||||
from typing import Literal, Annotated
|
from typing import Literal
|
||||||
|
|
||||||
import pydantic
|
import pydantic
|
||||||
import pydantic_extra_types.color as pydantic_color
|
|
||||||
|
|
||||||
from .. import LaTeXDimension
|
from .. import ThemeOptions
|
||||||
from .. import PageMargins
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeSectionTitleMargins(pydantic.BaseModel):
|
class ClassicThemeOptions(ThemeOptions):
|
||||||
top: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.2 cm",
|
|
||||||
title="Top Margin",
|
|
||||||
description="The top margin of section titles.",
|
|
||||||
)
|
|
||||||
bottom: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.2 cm",
|
|
||||||
title="Bottom Margin",
|
|
||||||
description="The bottom margin of section titles.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeEntryAreaMargins(pydantic.BaseModel):
|
|
||||||
left_and_right: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.2 cm",
|
|
||||||
title="Left Margin",
|
|
||||||
description="The left margin of entry areas.",
|
|
||||||
)
|
|
||||||
|
|
||||||
vertical_between: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.12 cm",
|
|
||||||
title="Vertical Margin Between Entry Areas",
|
|
||||||
description="The vertical margin between entry areas.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeHighlightsAreaMargins(pydantic.BaseModel):
|
|
||||||
top: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.10 cm",
|
|
||||||
title="Top Margin",
|
|
||||||
description="The top margin of highlights areas.",
|
|
||||||
)
|
|
||||||
left: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.4 cm",
|
|
||||||
title="Left Margin",
|
|
||||||
description="The left margin of highlights areas.",
|
|
||||||
)
|
|
||||||
vertical_between_bullet_points: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.10 cm",
|
|
||||||
title="Vertical Margin Between Bullet Points",
|
|
||||||
description="The vertical margin between bullet points.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeHeaderMargins(pydantic.BaseModel):
|
|
||||||
vertical_between_name_and_connections: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.2 cm",
|
|
||||||
title="Vertical Margin Between the Name and Connections",
|
|
||||||
description=(
|
|
||||||
"The vertical margin between the name of the person and the connections."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
bottom: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.2 cm",
|
|
||||||
title="Bottom Margin",
|
|
||||||
description=(
|
|
||||||
"The bottom margin of the header, i.e., the vertical margin between the"
|
|
||||||
" connections and the first section title."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeMargins(pydantic.BaseModel):
|
|
||||||
page: PageMargins = pydantic.Field(
|
|
||||||
default=PageMargins(),
|
|
||||||
title="Page Margins",
|
|
||||||
description="Page margins for the classic theme.",
|
|
||||||
)
|
|
||||||
section_title: ClassicThemeSectionTitleMargins = pydantic.Field(
|
|
||||||
default=ClassicThemeSectionTitleMargins(),
|
|
||||||
title="Section Title Margins",
|
|
||||||
description="Section title margins for the classic theme.",
|
|
||||||
)
|
|
||||||
entry_area: ClassicThemeEntryAreaMargins = pydantic.Field(
|
|
||||||
default=ClassicThemeEntryAreaMargins(),
|
|
||||||
title="Entry Area Margins",
|
|
||||||
description="Entry area margins for the classic theme.",
|
|
||||||
)
|
|
||||||
highlights_area: ClassicThemeHighlightsAreaMargins = pydantic.Field(
|
|
||||||
default=ClassicThemeHighlightsAreaMargins(),
|
|
||||||
title="Highlights Area Margins",
|
|
||||||
description="Highlights area margins for the classic theme.",
|
|
||||||
)
|
|
||||||
header: ClassicThemeHeaderMargins = pydantic.Field(
|
|
||||||
default=ClassicThemeHeaderMargins(),
|
|
||||||
title="Header Margins",
|
|
||||||
description="Header margins for the classic theme.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class ClassicThemeOptions(pydantic.BaseModel):
|
|
||||||
""" """
|
""" """
|
||||||
|
|
||||||
model_config = pydantic.ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
theme: Literal["classic"]
|
theme: Literal["classic"]
|
||||||
|
|
||||||
font_size: Literal["10pt", "11pt", "12pt"] = pydantic.Field(
|
|
||||||
default="10pt",
|
|
||||||
title="Font Size",
|
|
||||||
description="The font size of the CV. It can be 10pt, 11pt, or 12pt.",
|
|
||||||
)
|
|
||||||
page_size: Literal["a4paper", "letterpaper"] = pydantic.Field(
|
|
||||||
default="a4paper",
|
|
||||||
title="Page Size",
|
|
||||||
description="The page size of the CV. It can be a4paper or letterpaper.",
|
|
||||||
)
|
|
||||||
color: pydantic_color.Color = pydantic.Field(
|
|
||||||
default="rgb(0,79,144)",
|
|
||||||
validate_default=True,
|
|
||||||
title="Primary Color",
|
|
||||||
description=(
|
|
||||||
"The primary color of Classic Theme. It is used for the section titles,"
|
|
||||||
" heading, and the links.\nThe color can be specified either with their"
|
|
||||||
" [name](https://www.w3.org/TR/SVG11/types.html#ColorKeywords), hexadecimal"
|
|
||||||
" value, RGB value, or HSL value."
|
|
||||||
),
|
|
||||||
examples=["Black", "7fffd4", "rgb(0,79,144)", "hsl(270, 60%, 70%)"],
|
|
||||||
)
|
|
||||||
disable_page_numbering: bool = pydantic.Field(
|
|
||||||
default=False,
|
|
||||||
title="Disable Page Numbering",
|
|
||||||
description=(
|
|
||||||
"If this option is set to true, then the page numbering will be disabled."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
date_and_location_width: LaTeXDimension = pydantic.Field(
|
|
||||||
default="4.1 cm",
|
|
||||||
title="Date and Location Column Width",
|
|
||||||
description="The width of the date and location column.",
|
|
||||||
)
|
|
||||||
space_between_connection_objects: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.5 cm",
|
|
||||||
title="Space Between Connection Objects",
|
|
||||||
description=(
|
|
||||||
"The space between the connection objects (like phone, email, and website)."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
text_alignment: Literal["left-aligned", "justified"] = pydantic.Field(
|
text_alignment: Literal["left-aligned", "justified"] = pydantic.Field(
|
||||||
default="left-aligned",
|
default="justified",
|
||||||
title="Text Alignment",
|
title="Text Alignment",
|
||||||
description="The alignment of the text.",
|
description="The alignment of the text. The default value is justified.",
|
||||||
)
|
)
|
||||||
show_timespan_in: list[str] = pydantic.Field(
|
show_timespan_in: list[str] = pydantic.Field(
|
||||||
default=[],
|
default=[],
|
||||||
title="Show Time Span in These Sections",
|
title="Show Time Span in These Sections",
|
||||||
description=(
|
description=(
|
||||||
"The time span will be shown in the date and location column in these"
|
"The time span will be shown in the date and location column in these"
|
||||||
" sections. The input should be a list of strings."
|
" sections. The input should be a list of section titles as strings"
|
||||||
|
" (case-sensitive)."
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
show_last_updated_date: bool = pydantic.Field(
|
|
||||||
default=True,
|
|
||||||
title="Show Last Updated Date",
|
|
||||||
description=(
|
|
||||||
"If this option is set to true, then the last updated date will be shown"
|
|
||||||
" in the header."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
header_font_size: LaTeXDimension = pydantic.Field(
|
|
||||||
default="30 pt",
|
|
||||||
title="Header Font Size",
|
|
||||||
description="The font size of the header (the name of the person).",
|
|
||||||
)
|
|
||||||
margins: ClassicThemeMargins = pydantic.Field(
|
|
||||||
default=ClassicThemeMargins(),
|
|
||||||
title="Margins",
|
|
||||||
description="Page, section title, entry field, and highlights field margins.",
|
|
||||||
)
|
|
||||||
|
|
|
||||||
|
|
@ -2,78 +2,20 @@ from typing import Literal
|
||||||
|
|
||||||
import pydantic
|
import pydantic
|
||||||
|
|
||||||
from .. import LaTeXDimension, PageMargins
|
from .. import ThemeOptions, LaTeXDimension
|
||||||
|
|
||||||
|
|
||||||
class Sb2novThemeOptions(pydantic.BaseModel):
|
class Sb2novThemeOptions(ThemeOptions):
|
||||||
""" """
|
""" """
|
||||||
|
|
||||||
model_config = pydantic.ConfigDict(extra="forbid")
|
|
||||||
|
|
||||||
theme: Literal["sb2nov"]
|
theme: Literal["sb2nov"]
|
||||||
|
|
||||||
font_size: Literal["10pt", "11pt", "12pt"] = pydantic.Field(
|
|
||||||
default="10pt",
|
|
||||||
title="Font Size",
|
|
||||||
description="The font size of the CV. It can be 10pt, 11pt, or 12pt.",
|
|
||||||
)
|
|
||||||
page_size: Literal["a4paper", "letterpaper"] = pydantic.Field(
|
|
||||||
default="a4paper",
|
|
||||||
title="Page Size",
|
|
||||||
description="The page size of the CV. It can be a4paper or letterpaper.",
|
|
||||||
)
|
|
||||||
|
|
||||||
link_color: (
|
|
||||||
Literal["black"]
|
|
||||||
| Literal["red"]
|
|
||||||
| Literal["green"]
|
|
||||||
| Literal["blue"]
|
|
||||||
| Literal["cyan"]
|
|
||||||
| Literal["magenta"]
|
|
||||||
| Literal["yellow"]
|
|
||||||
) = pydantic.Field(
|
|
||||||
default="cyan",
|
|
||||||
validate_default=True,
|
|
||||||
title="Link Color",
|
|
||||||
description="The color of the links in the CV.",
|
|
||||||
examples=[
|
|
||||||
"black",
|
|
||||||
"red",
|
|
||||||
"green",
|
|
||||||
"blue",
|
|
||||||
"cyan",
|
|
||||||
"magenta",
|
|
||||||
"yellow",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
date_and_location_width: LaTeXDimension = pydantic.Field(
|
|
||||||
default="4.1 cm",
|
|
||||||
title="Date and Location Column Width",
|
|
||||||
description="The width of the date and location column.",
|
|
||||||
)
|
|
||||||
space_between_connection_objects: LaTeXDimension = pydantic.Field(
|
|
||||||
default="0.5 cm",
|
|
||||||
title="Space Between Connection Objects",
|
|
||||||
description=(
|
|
||||||
"The space between the connection objects (like phone, email, and website)."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
show_last_updated_date: bool = pydantic.Field(
|
|
||||||
default=True,
|
|
||||||
title="Show Last Updated Date",
|
|
||||||
description=(
|
|
||||||
"If this option is set to true, then the last updated date will be shown"
|
|
||||||
" in the header."
|
|
||||||
),
|
|
||||||
)
|
|
||||||
header_font_size: LaTeXDimension = pydantic.Field(
|
header_font_size: LaTeXDimension = pydantic.Field(
|
||||||
default="30 pt",
|
default="24 pt",
|
||||||
title="Header Font Size",
|
title="Header Font Size",
|
||||||
description="The font size of the header (the name of the person).",
|
description=(
|
||||||
)
|
"The font size of the header (the name of the person). The default value is"
|
||||||
margins: PageMargins = pydantic.Field(
|
" 24 pt. Unfortunately, sb2nov does not support font sizes bigger than"
|
||||||
default=PageMargins(),
|
" 24 pt."
|
||||||
title="Margins",
|
),
|
||||||
description="The page margins of the CV.",
|
|
||||||
)
|
)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue