Metadata-Version: 2.1
Name: termmenu
Version: 1.5
Summary: A tool for making terminal menus.
Home-page: https://github.com/dnorhoj/termmenu
Author: dnorhoj
Author-email: daniel.norhoj@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown

# TermMenu

This is a little Python project that I wanted to do for some time.

The idea is that you should be able to make a terminal menu (below) easily and compactly.

```text
Choose one:
0. Start game
1. Settings
2. And more
> {User input here}
```

## Documentation

Read the documentation on [ReadTheDocs](https://pytermmenu.readthedocs.io/en/latest/index.html).

## Usage

To start off you need to import the library, and create a new menu.

```py
import termmenu

testmenu = termmenu.Menu(title="What's up") # title is optional
```

### Adding entries

To add entries, we use `Menu.add_entry`, usage:

```py
Menu.add_entry(text, run=None, entry=None)
```

