Metadata-Version: 2.1
Name: menus-py
Version: 1.2.1
Summary: Simple library for creating text-based menus
Author: Kai Fautley
License-File: LICENSE
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown

(readme adapted from in-code docs)
# menus.py - Simple menu functions
menus.py is a small module designed to help quickly make simple and effective
text-based menus of various types. It handles erroneous inputs automatically.
## Functions
### mainMenu
&nbsp;&nbsp;Makes the user select one of any number of options<br/>
`mainMenu(title,options,return_name=False,return_index=True)`

`title`<br/>
&nbsp;&nbsp;The title of the menu

`options`<br/>
&nbsp;&nbsp;The list of menu options to display and select from

`return_name`<br/>
&nbsp;&nbsp;Returns the name of the option selected

`return_index`<br/>
&nbsp;&nbsp;Returns the index of the option in the list of options


### yesNo
&nbsp;&nbsp;Asks the user for a yes/no answer to a question<br/>
`yesNo(question)`

`question`<br/>
&nbsp;&nbsp;The question to be asked