simple-console-menu 1.0.4

A simple console menu

Simple Consol Menu

this module allows you to create simple console menu.

links

Source
Documentation
Bug Report
PyPi

Installation

pip install simple-console-menu

Usage

from simple_console_menu import Menu

Example

SimpleConsoleMenu

---

The first menu is the SimpleConsoleMenu.
You can use it by first importing the right file:

from simple_console_menu import Menu

And if you want to use it you can do this:

menu = Menu.simple_console_menu(menu_name: str, menu_items: list[str], input_question: str, menu_size: int = 76, auto_add_quit: bool = False, only_return_number: bool = True, allowed_characters: list[str] | str | None = None, accepted_quit_characters: str = '', return_menu_item: bool = False)

With these parameters:
menu_name - Required : name of the menu (Str)
menu_items - Required : menu items ["item 1","item 2"] (List)
input_question - Optional : Question input (Str)
menu_size - Optional : Size of the menu (Int)
auto_add_quit - Optional : automatically add a quit option (Bool)
only_return_number - Optional : only numbers are allowed to return (Bool)
allowed_characters - Optional : specifier which character(s) are allowed if only_return_number is False, separated with ';' (str)
accepted_quit_characters - Optional : specifier which character is allowed if only_return_number is False for quit (str)
return_menu_item - Optional : return the menu item instead of the number (Bool)

full example:

from simple_console_menu import Menu

menuNumber = Menu.SimpleConsoleMenu('menu', ["item1","item2","item3","item4","item5"], "Number:", 76, True)

if menuNumber == 1:
    print('item1')
elif menuNumber == 2:
    print('item2')
elif menuNumber == 3:
    print('item3')
elif menuNumber == 4:
    print('item4')
elif menuNumber == 5:
    print('item5')

And this wil display

----------------------------------- menu -----------------------------------
1. item1
2. item2
3. item3
4. item4
5. item5
6. Quit
----------------------------------------------------------------------------
Number:1
item1

There is also SimpleConsoleMenuBlock which works the same as SimpleConsoleMenu but looks like this:

╭────────────────────────────────── menu ──────────────────────────────────╮
│1. item1                                                            │
│2. item2                                                            │
│3. item3                                                            │
│4. item4                                                            │
│5. item5                                                            │
│6. Quit                                                             │
╰──────────────────────────────────────────────────────────────────────────╯
Number:

You can also use the menu class like this:

from simple_console_menu import Menu

user_input = Menu.menu("Menu", ["item 1", "item 2", "item 3"]).display().get_user_input()
print(user_input)