Skip to main content

This project implements a keyboard-controlled text user interface (TUI) for the terminal that allows users to navigate menus and nested subsections using simple key inputs (w, s, Enter, Esc). It provides a lightweight framework for building interactive CLI applications with features like menu navigation, dynamic subsections, progress bars, and confirmation prompts.

Project description

py_menu_tui

py_menu_tui is a lightweight terminal user interface (TUI) navigation framework for Python.
It allows developers to quickly build interactive command-line menus with keyboard navigation and nested subsections.

The interface is controlled using simple keys and is designed for Windows terminals using msvcrt.


Features

  • Keyboard navigation (w / s)
  • Nested menu sections
  • Simple function binding to menu entries
  • Scrollable menus
  • Progress bar utility
  • Confirmation prompts
  • No external dependencies

Installation

Currently the package can be installed with:

pip install py_menu_tui

Controls

Key Action
w Move up
s Move down
Enter Select option
Esc Go back
Ctrl+C Exit program

Example

from py_menu_tui import UserInterface

def hello():
    print("Hello World")

ui = UserInterface(1)# The value must match the length of setup_names

ui.setup(
    ["Say Hello"],#<setup_names
    [hello]
)

ui.begin()

Creating Subsections

# Create a subsection
ui.add_sub_section(
    ["Option 1", "Option 2"],
    [func1, func2],
    section="Settings"
)

# Create a nested subsection inside "Settings"
ui.add_sub_section(
    ["Option 1", "Option 2"],
    [func1, func2],
    section="Audio",
    uppersection="Settings"
)

Utilities

#Progressbar
from py_menu_tui import progressbar
progressbar(50)

#Clear Terminal
from py_menu_tui import clear
clear()

#Confirmation Prompt
from py_menu_tui import confirm

if confirm("Continue?"):
    print("Confirmed")

Requirements

  • Python 3+
  • Windows terminal (uses msvcrt)
  • No external dependencies

License

This project is licensed under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_menu_tui-0.2.4.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_menu_tui-0.2.4-py3-none-any.whl (3.6 kB view details)

Uploaded Python 3

File details

Details for the file py_menu_tui-0.2.4.tar.gz.

File metadata

  • Download URL: py_menu_tui-0.2.4.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for py_menu_tui-0.2.4.tar.gz
Algorithm Hash digest
SHA256 705e694402b99f928215479becb902a5977718d9ea622603a2b864d751f72ac0
MD5 ccc096c96259b858a63f2404ec4127bf
BLAKE2b-256 4213b4eeb515d2bb1d3db2abd9be9990dac5457c301c86363f066d46bf9a4b3b

See more details on using hashes here.

File details

Details for the file py_menu_tui-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: py_menu_tui-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 3.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.5

File hashes

Hashes for py_menu_tui-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 284a16e240ea9d98b468512f211f3f6b64ad9466b10ca8d802195491b7105371
MD5 0a33274ebda84c3bdaf76e2aaf7f4dba
BLAKE2b-256 d4eff98a9f18c3c08db349a5e4e33d32c00a1713aacbeafa26d0e84e9fd7af55

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page