frontend.utils

This module contains utility modules for the app.

frontend.utils.ui

  • This module defines the User Interface of the app.

  • In this project, we use Streamlit.

  • But if you want to use any other framework, you need to implement the functions defined here.

frontend.utils.ui.click(field: str) → bool[source]

Defines a button for the given field and returns if the button was clicked or not.

frontend.utils.ui.display_text(text: str)[source]
frontend.utils.ui.error(msg: str) → None[source]
frontend.utils.ui.get_text_input(field: str) → str[source]

Takes in information, as required by field, from the user as text input, and returns it.

frontend.utils.ui.select_menu_option(menu: str, menu_options: list) → str[source]

Returns the selected option in the menu.

frontend.utils.ui.select_option(field: str, list_of_options: list) → str[source]

From the list_of_options provided under field, the function returns the selected option.

frontend.utils.ui.set_title(title: str)[source]
frontend.utils.ui.success(msg: str) → None[source]