Strumenti Package - Application Program Interface¶
coordinate¶
notify¶
Notify Module
Functions for notifying the user are contained in this module.
-
astrix_line(qty: int=80) → str[source]¶ Return break line of astrix characters.
Parameters: qty (int) – number of * characters to be returned Returns: - characters and a line break
Return type: str
-
center(statement: str, fill: str='=', width: int=60) → str[source]¶ Return statement centered by spaces and fill characters.
Parameters: - statement (str) – statement to be returned
- fill (str) – fill character to be used (default: =)
- width (int) – total width of output string (default: 60)
Returns: statement centered on line surrounded by fill characters
Return type: str
-
header(statement: str) → str[source]¶ Return a line of asterisks two blank lines and the header statement.
Parameters: statement (str) – header statement Returns: formatted header statement Return type: str
Return two blank lines the footer statement then a row of asterisks.
Parameters: statement (str) – footer statement Returns: formatted footer statement Return type: str
-
section_break(qty: int=2) → str[source]¶ Return multiple line break characters.
Parameters: qty (int) – number of line break characters (default: 2) Returns: multiple new line characters Return type: str
-
status(statement: str, fill: str='-', width: int=40) → str[source]¶ Return intermediary statements.
Parameters: - statement (str) – statement to be returned
- fill (str) – fill character to be used (default: -)
- width (int) – total width of output string (default: 40)
Returns: formatted status statement
Return type: str