Skip to main content

A Python Terminal User Interface based on urwid with asynchronous input/output that can be easily expanded to your application.

Project description

TerminalUI

A Python Package that allows for the easily development of Terminal User Interfaces that require asynchronous read/write. Features include:

  • TerminalUI class which handles user keypresses, simply pass it your command entered function
  • Asynchronous read/write capabilities
  • Configurable options panel for configuring your application at runtime
  • Options can either be a list of selectable values or an editable value
  • Several other features

The package is built upon urwid. This means, unfortunately, based on how the TerminalUI class is currently implemented it will not work with on Windows. It will however, work with the Windows Linux Subsystem (WSL). Here is a guide on how to enable WSL on Windows 10.

TerminalUI Image

Installation

To install via pip

pip3 install terminalui

To install from source (with symlink so updates to source are immediately reflected in packages that utilise TerminalUI)

git clone https://github.com/jmount1992/TerminalUI.git
python3 -m pip install --user --upgrade setuptools wheel
python3 setup.py sdist bdist_wheel 
pip3 install -e . 

Documentation

Additional documentation will be coming in the future. For now check out the examples and the docstrings in the TerminalUI class.

Project details


Download files

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

Files for terminalui, version 0.1.3
Filename, size File type Python version Upload date Hashes
Filename, size terminalui-0.1.3.tar.gz (11.8 kB) File type Source Python version None Upload date Hashes View
Filename, size terminalui-0.1.3-py3-none-any.whl (12.5 kB) File type Wheel Python version py3 Upload date Hashes View

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