cliriculum.resume¶

class cliriculum.resume.SideBarHTML(path, contact, rsrc_dst: str | None = None)¶

Parameters:

path (Path to sidebar markdown file.)
contact (Path to the contact json file)
rsrc_dst (Optional[str]) – If not None resources mentionned in JSON files are copied to destination directory rsrc_dst. By default, None.

class cliriculum.resume.MainHTML(path, dates: str | None = None, location: str | None = None)¶

class cliriculum.resume.ResumeHTML(sidebar: SideBarHTML, main: MainHTML, stylesheet: str | None, rsrc_dst=typing.Optional[str])¶

Render Resume

main¶

Type:: MainHTML

sidebar¶

Type:: SideBarHTML

Parameters:

sidebar (SideBarHTML)
main (MainHTML)
stylesheet (Path to stylesheet.)
rsrc_dst (See SideBarHTML)

class cliriculum.resume.Resume(rsrc_dst: str | None = None, stylesheet: str | None = None)¶

stylesheet¶

Type:: str

rsrc_dst¶

Type:: str

resume¶

Is set on __call__ (to ResumeHTML instance)

Type:: Union[ResumeHTML, None]

Example

>>> from cliriculum.resume import Resume
>>> resume = Resume()  # a callable
>>> resume(
        sidebar_md="sidebar.md",
        main_md="main.md",
        contact="contact.json",
        dates="dates.json"
    )

cliriculum.resume.resume(sidebar_md: str, main_md: str, dates: str, contact: str, rsrc_dst: str | None = None, stylesheet: str | None = None, location: str | None = None) → str¶

Parameters:

sidebar_md (str) – Path to sidebar markdown
main_md (str) – Path to main markdown
dates (str) – path to dates JSON
contact (str) – Path to contact JSON
rsrc_dst (Optional[str]) – Argument passed to SideBarHTML and ResumeHTML
stylesheet – Argument passed to ResumeHTML
location (Optional[str]) – Path to JSON file containing location metadata

Returns:

HTML representation of the resume

Return type:

str

Example

>>> from cliriculum import resume
>>> html = resume(sidebar_md="sidebar.md", main_md="main.md", contact="contact.json", dates="dates.json")