quick-menu's Introduction

quick-menu

This is a simple package to create text menus for use in console applications.

Usage

A menu can be created quickly that can call a function with or without a value. An exit item is automatically added to the menu.

Create a Quick Menu

from quick_menu.menu import Menu, MenuItem

def func(val=1):
    print("func1: val =", val)
    input("Press [Enter] to continue")

menu = Menu(
    "Simple Menu",
    menu_items=[
        MenuItem("1", "Func default", action=func),
        MenuItem("2", "Func with val=4", action=func, action_args={"val": 4}),
    ]
)

menu.run()

Output

============== Simple Menu =============
1: Func default
2: Func with val=4
X: Exit
========================================
>> 1
func1: val = 1
Press [Enter] to continue

============== Simple Menu =============
1: Func default
2: Func with val=4
X: Exit
========================================
>> 2
func1: val = 4
Press [Enter] to continue

Documentation

The documentation is made with Material for MkDocs and is hosted by GitHub Pages.

Installation

pip install quick-menu

License

quick-menu is distributed under the terms of the MIT license.

quick-menu's People

Contributors

Watchers

quick-menu's Issues

Add tests for full coverage

Test trying to update a menu item from a choice that doesn't exist.
The test for an exit key in add is no longer valid since the code always ensures there is an exit key available at the end of an add.

Add a menu update option

Add an update function to modify existing menu items.

Make sorting of the menu items an option of the menu

The menu items are currently sorted by the choice. There are times that a specific order is desired for the menu items. This should be an option of the menu with the current, sorted, being the default.

Add an exit menu item if none is present

This should handle two issue.

If no exit exists for a menu then add a default one. add(MenuItem("X", "Exit", is_exit=True))
There can be only one. Each exit menu item added should replace an existing one.

Recommend Projects