Skip to main content

A simple python package for in-terminal menu creation on Windows

Project description

menu.py

PyPI Platform Version GitHub last commit

created by: deadyeti


links



Introduction

⚠️

  • menu.py is still in the early stages of development, it is not recommended that you download this package at this time.
  • menu.py only works on Windows.

menu.py is a lightweight and easy-to-use python package used to quickly and efficiently create in-terminal menus that work in both Command Prompt and Windows PowerShell. Using menu.py, a user can either create a selection menu, where one selects an option from a pre-determined list of options, or a user-input menu, where users type their input. (not yet implemented)

Key Features

✔️ fast and efficient
✔️ supports the use of colors
✔️ variable refresh-rate
✔️ easy to use
✔️ actively supported

Installation

To install this module using pip:

py -m pip install menu.py

I always try to keep the most up-to-date version on pypi, but in case you need to install the most up-to-date version from github:

$ git clone https://github.com/readyyeti/menu.py
$ cd menu.py
$ py -m pip install -U

Quick Example

from menu import *
from time import sleep

example_menu = menu('app_or_file_name')
theme = 'blue'

def main_menu():

   # setting up the page name and menu options
   page_name = 'name_of_page'
   text = [
      'please choose from the following options:'
   ]
   options = [
      'option #1',    # CASE 1
      'option #2',    # CASE 2
      '_skip_',       # # "_skip_", " " and "" can be used to create a blank line without messing up the selections
      'exit'          # CASE 3
   ]

   # generate menu
   selection = example_menu.generate(page_name, options, text, theme)

   match selection:
      case 1:
         menuprint('you selected option 1'), sleep(2)
      case 2:
         menuprint('you selected option 2'), sleep(2)
      case 3:
         example_menu.terminate()
         return exit()
   
   return

while True:
   main_menu()

For a more in-depth example, check out the example.py file

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

menu.py-0.3.2.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

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

menu.py-0.3.2-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

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