You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Eugenio Parodi 77f657e136 Updated README.md 5 years ago
TermTk Improved the documentation, initial packaging 5 years ago
demo Improved the documentation, initial packaging 5 years ago
docs update TODO.md 5 years ago
tests Improved the documentation, initial packaging 5 years ago
tutorial Add layout tutorial 5 years ago
.gitignore Improved the documentation, initial packaging 5 years ago
LICENSE Formalizing the structure 5 years ago
Makefile Add Tutorial: HelloWorld 5 years ago
README.md Updated README.md 5 years ago
setup.py Tuning Makefile 5 years ago

README.md

pyTermTk

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

Features

  • 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
  • UTF-8 and true color support

Limitations

  • Only the key combinations forwarded by the terminal emulator used are detected (ALT,CTRL may not be handled)

Tutorial

Be inspired by the tutorial examples

Api Definitions

Don't get bored by the Api Definitions

Install/Upgrade

pyTermTk is available on PyPI

pip3 install --upgrade pyTermTk

Quick Test/Try - no install required

Clone

clone git@github.com:ceccopierangiolieugenio/pyTermTk.git
cd pyTermTk

Run Basic input test

python3 tests/test.input.py

Run Terminal resize test

# Press CTRL-C to exit
# the logs are written to "session.log"
make runDemo
# or
python3 demo/demo.py -f

# Try gittk
make runGittk

Profiling

cProfile, cProfilev
python3 -m cProfile -o profiler.txt tests/test.ui.004.py

# install cprofilev:
#     pip3 install cprofilev
cprofilev -f profiler.txt
# open http://127.0.0.1:4000
pyroscope

pyroscope can be used as well for profiling