Module: Exporter

Exporter

Create Exporter module

Examples:

>>> from promg.modules.exporter import Exporter
>>> exporter = Exporter()

get_event_log(entity_type, additional_event_attributes=None, additional_entity_attributes=None)

Get an event log extracted from the EKG for a specific entity and return it

Parameters:

Name	Type	Description	Default
entity_type		The type of the entity --> contract states that it exists	required
additional_event_attributes	Optional[List[str]]	list of different attributes of event that should also be stored in the	None
additional_entity_attributes	Optional[List[str]]	list of different attributes of entity that should also be stored in the	None

Returns:

Type	Description
List[Dict[str, Any]]	A list of events with its attributes in the form of a dictionary

Raises:

Type	Description
ValueError	when the entity has not been defined

save_event_log(entity_type, additional_event_attributes=None, additional_entity_attributes=None)

Create an event log extracted from the EKG from a specific entity and store it as a csv file

Parameters:

Name	Type	Description	Default
entity_type	str	The type of the entity	required
additional_event_attributes	Optional[List[str]]	list of different attributes of event that should also be stored in the event log	None
additional_entity_attributes	Optional[List[str]]	list of different attributes of entity that should also be stored in the	None