raesl.excel.sheets

Excel sheet generation.

Module Contents

Functions

add_components_sheet(...)	Add a components overview sheet to an Excel workbook.
add_goals_sheet(...)	Add a goal requirements sheet to an Excel workbook.
add_transformations_sheet(...)	Add a transformation requirements sheet to an Excel workbook.
add_designs_sheet(...)	Add a design requirements sheet to an Excel workbook.
add_behaviors_sheet(...)	Add a behavior requirements sheet to an Excel workbook.
add_needs_sheet(...)	Add a needs sheet to an Excel workbook.
add_variable_sheet(...)	Add a variable sheet to an Excel workbook.
add_overview_sheet(...)	Add an overview sheet to an Excel workbook.
add_component_active_goals_sheet(wb, graph, component)
add_component_passive_goals_sheet(wb, graph, component)

raesl.excel.sheets.add_components_sheet(wb: openpyxl.workbook.Workbook, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a components overview sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the components sheet to.

• components – List of component nodes.

Returns:

Components worksheet instance.

raesl.excel.sheets.add_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a goal requirements sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the goals sheet to.

• graph – Graph to fetch goals from.

• components – Component nodes to fetch goals for.

Returns:

Goal requirements worksheet instance.

raesl.excel.sheets.add_transformations_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a transformation requirements sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the transformations sheet to.

• graph – Graph to fetch transformation nodes from.

• components – Component nodes to fetch transformations for.

Returns:

Transformation requirements worksheet instance.

raesl.excel.sheets.add_designs_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a design requirements sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the design requirements sheet to.

• graph – Graph to fetch designrule nodes from.

• components – Component nodes to fetch design requirements for.

Returns:

Design requirements worksheet instance.

raesl.excel.sheets.add_behaviors_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a behavior requirements sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the behavior requirements sheet to.

• graph – Graph to fetch behavior nodes from.

• components – Component nodes to fetch behavior requirements for.

Returns:

Behavior requirements worksheet instance.

raesl.excel.sheets.add_needs_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a needs sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the needs sheet to.

• graph – Graph to fetch need nodes from.

• components – Component nodes to fetch needs for.

Returns:

Needs worksheet instance.

raesl.excel.sheets.add_variable_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node]) → Tuple[openpyxl.worksheet.worksheet.Worksheet, List[ragraph.node.Node]]

Add a variable sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the needs sheet to.

• graph – Graph to fetch need nodes from.

• components – Component nodes to fetch needs for.

Returns:

Needs worksheet instance.

raesl.excel.sheets.add_overview_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, components: List[ragraph.node.Node], goals: List[ragraph.node.Node], transformations: List[ragraph.node.Node], designs: List[ragraph.node.Node], behaviors: List[ragraph.node.Node], needs: List[ragraph.node.Node]) → openpyxl.worksheet.worksheet.Worksheet

Add an overview sheet to an Excel workbook.

Parameters:

• wb – Excel workbook to add the needs sheet to.

• components – Component nodes.

• goals – Goal requirement nodes.

• transformations – Transformation requirement nodes.

• designs – Design requirement nodes.

• behaviors – Behavior requirement nodes.

• needs – Need nodes.

Returns:

Overview worksheet instance.

raesl.excel.sheets.add_component_active_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, component: ragraph.node.Node, flow_labels: List[str] | None = None)

raesl.excel.sheets.add_component_passive_goals_sheet(wb: openpyxl.workbook.Workbook, graph: ragraph.graph.Graph, component: ragraph.node.Node, flow_labels: List[str] | None = None)