cliriculum.deserializers¶
- class cliriculum.deserializers.Dates(dict=None, /, **kwargs)¶
Deserializer of date metadata
Example
>>> d = load_json("dates.json") >>> dates = Dates(d)
- class cliriculum.deserializers.Period(id: str, start: date, end: date | None = None, logo: str | None = None, width: str | None = None, height: str | None = None, classes: str | None = None)¶
- start¶
- Type:
str
- end¶
- Type:
Union[str, None]
- idx¶
- Type:
str
- logo¶
- Type:
Union[str, None]
- width¶
- Type:
Union[str, None]
- height¶
- Type:
Union[str, None]
- classes¶
classes has priority over logo in
cliriculum.renderers
- Type:
Union[str, None]
- Parameters:
id (str)
start (str) – The start of the period
end (Optional[str]) – The end of the period
logo (Optional[str]) – A path towards a logo
width (Optional[str]) – Width of logo
height (Optional[str]) – Height of logo
classes (Optional[str]) – css classnames classes=”class1 class2”
- class cliriculum.deserializers.URL(url: str | None, logo: str | None = None, classes: str | None = None, text: str | None = None, width: str | None = None, height: str | None = None)¶
- logo¶
- Type:
str
- url¶
- Type:
Union[str, None]
- text¶
- Type:
str
- class cliriculum.deserializers.Website(url: str | None, logo: str | None = None, classes: str | None = None, text: str | None = None, width: str | None = None, height: str | None = None)¶
- class cliriculum.deserializers.Social(url: str | None, logo: str | None = None, classes: str | None = None, text: str | None = None, width: str | None = None, height: str | None = None)¶
- class cliriculum.deserializers.Number(url: str | None, logo: str | None = None, classes: str | None = None, text: str | None = None, width: str | None = None, height: str | None = None)¶
- class cliriculum.deserializers.Email(url: str | None, logo: str | None = None, classes: str | None = None, text: str | None = None, width: str | None = None, height: str | None = None)¶
- class cliriculum.deserializers.Socials(socials_list: List[Dict])¶
-
- Parameters:
socials_dict (List[Dict]) – A list of dictionaries Passed to
Social
as named arguments
- class cliriculum.deserializers.Profile(picture: str | None, width: str | None = '200px', height: str | None = '200px')¶
Profile fields.
- ...
- Type:
Attributes from:
URL
- Parameters:
picture (Optional[str]) – Picture path, by default None passed as super(URL).__init__(logo=picture)
width (Optional[str]) – Width height, by default “200px”
height (Optional[str]) – Picture height, by default “200px”
- class cliriculum.deserializers.Contact(name: str, profession: str | None = None, email: str | None = None, website: str | None = None, socials: str | None = None, number: str | None = None, profile: str | None = None)¶
Contact deserializer.
- name¶
- Type:
str
- profession¶
- Type:
str
- Parameters:
name (str) – Required Single string (first name last name)
profession (Optional[str]) – Defaults to None.
email (Optional[str]) – Defaults to None.
website (Optional[str]) – Defaults to None.
socials (Optional[str]) – Defaults to None.
number (Optional[str]) – Defaults to None
Example
>>> from cliriculum.parsers import load_json >>> c = load_json("contact.json") >>> Contact(**c)
- class cliriculum.deserializers.Location(id: str, location: str, classes: str | None = None)¶
- Parameters:
id (str) – An id to match with content
location (str)
classes (Optional[str])
- class cliriculum.deserializers.Locations(dict=None, /, **kwargs)¶
Example
>>> from cliriculum.parsers import load_json >>> from cliriculum.deserializers import Locations >>> l = load_json("location.json") >>> Locations(l)