Menu

rumydata.menu.menu(layout: Layout) → dict

Layout menu

This method takes a Layout class object as an argument and presents the user with a suite of options in a command line interface (CLI). The options include the generation technical documentation for the layout, or validation of a csv file, with output of the results.

Outputs can be printed, saved, or opened (in a web-browser) in either markdown or html format, depending upon the user input.

Parameters:

layout – a Layout object which will be used for the selected options.

Returns:

a dictionary which describes the results of the interface selection choices. Not useful in the wild, but necessary for testing since the output is not as easy to verify.