Skip to main content

A tool to help make command line drawing easier.

Project description



pip install clitui

module v 0.1.0

keyboard support only on: Mac Linux

TUI is a module for making custom CLI/Console App's with python

Terminal suport

  • Mac
  • Linux
  • Windows CMD

Hope to add more cool things to package like window manager but I'm not sure what I'll need yet do to this projects is only made to help another project I am working on.

here is a example on how to use clitui code found in projects examples folder.


#  First off we import all the things needed for this
#  example
from clitui import Menu, getchar, fg_by, bg_by, safe_run, is_pressed

#  There many ways of setting colors in clitui but here is one where
#  We made a global variable to use throughout code
FG_CYAN = fg_by(0, 160, 160)

# We first create instances of any kind of menu or submenui
# with Menu class.  Menu takes a x and y and an option argument
# if no x, y is given submenu's default to parant menu's x, y.
main_menu = Menu("Main Menu", x=10, y=10)
options_menu = Menu("Options Menu")
key_controls = Menu("Key Controler")

# to set color for any menu or submenu just call background_color method.
# it takes a wide array of valid options.
# string of "black" or "cycan"
# a tuple (0, 160, 160) or just put bg_by function directly in there
main_menu.background_color((50, 0, 0))

# here we add items to are menu
# you can stack method calls on here as well
# you need a Name and a id for all menu items.
main_menu.add("New Game", 0).font_color_for(0, (0, 255, 0))
main_menu.add("Load", 1).font_color_for(1, FG_CYAN)
main_menu.add("Save", 2).font_color_for(2, "Cyan")

# if the menu item has a submenu then give it a Menu instances
# in submenu method
main_menu.add("Options", 3).submenu(3, options_menu)
main_menu.add("Exit", 4).add_action(4, exit)

# here we are adding submenu items
options_menu.add("Sound", 0)
options_menu.add("Controls", 1).submenu(1, key_controls)

key_controls.add("Key0", 0)
key_controls.add("Key1", 1)
key_controls.add("Key2", 2)
key_controls.add("Key3", 3)

# finally we call the create method to genorate all the need
# items for drawing.

def main():
    while True:
        # to get key presses call getchar
        key = getchar()

        # finally to get the fun part and draw the menu just call the draw
        # method

        # to get the curser to move pass in key to method
        # move_curser and use up and down

        if is_pressed("ESC", key):

#  if you want to hide the curser you can call them directly from the curser_controller
#  module in clitui but it is advised to use the safe_run function so you dont get
#  your terminal out of sync

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

clitui-0.2.2.tar.gz (9.9 kB view hashes)

Uploaded Source

Supported by

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