pyicat_plus.metadata.drac_report_builder.DracReportBuilder

class pyicat_plus.metadata.drac_report_builder.DracReportBuilder(dataset_type, dataset_title='')

Bases: object

Build a json and/or html file compatible with Drac dataset reports.

Example:

report = DracReportBuilder(

dataset_type=”Characterisation”, dataset_title=”Characterisation Results”,

) report.add_info(“This is a demo info item.”) report.add_table(

title=”Sample Table”, columns=[“Name”, “Value”], data=[[“Alpha”, 1], [“Beta”, 2]],

) report.add_image(“/path/to/image.png”, image_title=”Preview”) report.render_json(“report.json”)

Parameters:

• dataset_type (str)

• dataset_title (str)

add_image(path_to_image, image_title='', path_to_thumbnail_image=None, thumbnail_height=None, thumbnail_width=None)

Parameters:

• path_to_image (str)

• image_title (str)

• path_to_thumbnail_image (Optional[str])

• thumbnail_height (Optional[int])

• thumbnail_width (Optional[int])

Return type:

None

add_info(info_text)

Parameters:

info_text (str)

Return type:

None

add_log_file(title, link_text, path_to_log_file)

Parameters:

• title (str)

• link_text (str)

• path_to_log_file (str)

Return type:

None

add_table(title, columns, data, orientation='horizontal')

Parameters:

• title (str)

• columns (List[str])

• data (List[List[Any]])

• orientation (str)

Return type:

None

add_warning(info_text)

Parameters:

info_text (str)

Return type:

None

end_image_list()

Return type:

None

escape_characters(str_value)

Parameters:

str_value (str)

Return type:

str

get_dict_report()

Return type:

Dict[str, Any]

render_html(path_to_html_dir, name_of_index_file='index.html')

Parameters:

• path_to_html_dir (str)

• name_of_index_file (str)

Return type:

str

render_json(path_to_json_dir)

Parameters:

path_to_json_dir (str)

Return type:

str

set_title(dataset_title)

Parameters:

dataset_title (str)

Return type:

None

start_image_list()

Return type:

None