journal_manager.core.model module

Data model for journal-manager api.

class journal_manager.core.model.BuildInstructions(build_location: str | NoneType = None, build_index: bool = True, build_inactive: bool = False, with_http_server: bool = False, journals_names_to_build: List[str] | NoneType = None, journals_locations_to_build: List[str] | NoneType = None, include_all_folder: str | NoneType = None)

Bases: TomlDataClassIO

Parameters:

• build_location (str | None) –

• build_index (bool) –

• build_inactive (bool) –

• with_http_server (bool) –

• journals_names_to_build (List[str] | None) –

• journals_locations_to_build (List[str] | None) –

• include_all_folder (str | None) –

build_inactive: bool = False

build_index: bool = True

build_location: str | None = None

include_all_folder: str | None = None

journals_locations_to_build: List[str] | None = None

journals_names_to_build: List[str] | None = None

with_http_server: bool = False

class journal_manager.core.model.ConfigurationFile(default_journal_folder: str, default_template_folder: str, journal_data_filepath: str, template_data_filepath: str, parameters: journal_manager.core.model.Parameters)

Bases: TomlDataClassIO

Parameters:

• default_journal_folder (str) –

• default_template_folder (str) –

• journal_data_filepath (str) –

• template_data_filepath (str) –

• parameters (Parameters) –

T = ~T

as_dict() → Dict[str, Any]

Return type:

Dict[str, Any]

default_journal_folder: str

default_template_folder: str

classmethod from_dict(d: Dict[str, Any]) → T

Parameters:

d (Dict[str, Any]) –

Return type:

T

journal_data_filepath: str

parameters: Parameters

template_data_filepath: str

class journal_manager.core.model.JournalData(name: str, location_folder: str, active: bool, title: str, last_edit_date: str)

Bases: TomlDataClassIO

Parameters:

• name (str) –

• location_folder (str) –

• active (bool) –

• title (str) –

• last_edit_date (str) –

active: bool

last_edit_date: str

location_folder: str

name: str

title: str

class journal_manager.core.model.JournalDataList(list_of_journal_data: List[journal_manager.core.model.JournalData])

Bases: TomlTableDataClassIO

Parameters:

list_of_journal_data (List[JournalData]) –

list_of_journal_data: List[JournalData]

class journal_manager.core.model.JournalTemplate(name: str, filepath: str)

Bases: TomlDataClassIO

Parameters:

• name (str) –

• filepath (str) –

filepath: str

name: str

class journal_manager.core.model.JournalTemplateList(list_of_template_data: List[journal_manager.core.model.JournalTemplate])

Bases: TomlTableDataClassIO

Parameters:

list_of_template_data (List[JournalTemplate]) –

list_of_template_data: List[JournalTemplate]

class journal_manager.core.model.LogicOperator(value)

Bases: Enum

An enumeration.

AND = 1

OR = 0

class journal_manager.core.model.Parameters(default_text_editor_path: str | NoneType = None)

Bases: TomlDataClassIO

Parameters:

default_text_editor_path (str | None) –

default_text_editor_path: str | None = None