Skip to main content

Python Terminal Toolkit

Project description

Linux Usage Python pyTermTk_version Test Status pypi_version pypi_version


python Terminal Toolkit

Text-based user interface library (TUI) Evolved from the discontinued project pyCuT and inspired by a mix of Qt5,GTK, and tkinter api definition with a touch of personal interpretation



  • Basic widgets for TUI development (Button, Label, checkbox, ...)
  • Specialized widgets to improve the usability (Windows, Frames, Tables, ...)
  • QT Like Layout system to help arrange the widgets in the terminal
  • True color support
  • [TBD] Fullsize/Halfsize UTF-8 characters


  • The native Windows porting is not ready yet but it works with Cygwin or WSL.
  • Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled)




Be inspired by the tutorial examples

Api Definitions

Don't get bored by the Api Definitions


pyTermTk is available on PyPI

pip3 install --upgrade pyTermTk

Quick Test/Try - no install required


cd pyTermTk

Run Basic (non ui) input test

python3 tests/


# Press CTRL-C to exit
# the logs are written to "session.log"
# add "-f" option to run it in "fullscreen" :-D

# Showcase Demo
python3 demo/ -f

# Paint demo
python3 demo/

# VSCode like d'n d layout demo
python3 demo/

# early gittk demo
python3 demo/

# Text edit with "Pygments" highlight integrated
# it require pygments
#   pip install pygments
python3 tests/


cProfile, cProfilev
python3 -m cProfile -o profiler.bin tests/

# install cprofilev:
#     pip3 install cprofilev
cprofilev -f profiler.bin
# open

pyroscope can be used as well for profiling

Projects using pyTermTk

  • tlogg - A fast, advanced log explorer.
  • pytest-fold - A Pytest plugin to make console output more manageable when there are multiple failed tests
  • pytest-tui - A Text User Interface (TUI) for Pytest, automatically launched after your test run is finished

Related Projects

  • Honourable mention

    • bpytop - Linux/OSX/FreeBSD resource monitor
      This was the base inspiration for my core library
  • Python

    • urwid - Console user interface library for Python
    • pyTermGUI - A simple yet powerful TUI framework for your Python (3.7+) applications
    • Textual - TUI (Text User Interface) framework for Python inspired by modern web development
    • Rich - Python library for rich text and beautiful formatting in the terminal
    • PyCuT - terminal graphic library loosely based on QT api (my previous failed attempt)
    • pyTooling.TerminalUI - A set of helpers to implement a text user interface (TUI) in a terminal.
  • Non Python

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyTermTk-0.10.8a0.tar.gz (123.9 kB view hashes)

Uploaded source

Built Distribution

pyTermTk-0.10.8a0-py3-none-any.whl (209.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page