Data modules¶
Description
Modules that work with the data section
data_reader¶
Read data from files
-
modules.data.data_reader.get_abs_path(*root_file_path: str) → str¶ Get the abs path from the root directory of the project to the requested path
- Parameters
root_file_path (*str) – path from the root project directory
- Returns
corrisponding abs path
- Return type
str
-
modules.data.data_reader.read_file(*root_file_path: str) → str¶ Read the contens of the file
- Parameters
root_file_path (*str) – path of the file to read from the root project directory
- Returns
contents of the file
- Return type
str
-
modules.data.data_reader.read_md(file_name: str) → str¶ Read the contens of a markdown file. The path is data/markdown
- Parameters
file_name (str) – name of the file
- Returns
contents of the file
- Return type
str
-
modules.data.data_reader.update_settings_file()¶ Updates the config/settings.yaml file with the config_map values