A set of helpers to implement a text user interface (TUI) in a terminal.
Project description
pyTerminalUI
A set of helpers to implement a text user interface (TUI) in a terminal.
Features
- Colored command line outputs based on colorama
- Message classification in fatal, error, warning, normal, quiet, ...
- Get information like terminal dimensions from underlying terminal window
Simple Terminal Application
This is a minimal terminal application example which inherits from LineTerminal
.
from pyTooling.TerminalUI import LineTerminal
class Application(LineTerminal):
def __init__(self):
super().__init__(verbose=True, debug=True, quiet=False)
def run(self):
self.WriteNormal("This is a simple application.")
self.WriteWarning("This is a warning message.")
self.WriteError("This is an error message.")
# entry point
if __name__ == "__main__":
Application.versionCheck((3, 6, 0))
app = Application()
app.run()
app.exit()
Complex Terminal Application
This example hands over the terminal instance to a submodule, which implements
ILineTerminal
, so the submodule can also use the terminal's writing methods.
from pathlib import Path
from pyTooling.TerminalUI import LineTerminal, ILineTerminal
class SubModule(ILineTerminal):
def __init__(self, configFile, terminal):
super().__init__(terminal)
if not configFile.exists():
self.WriteError("Config file '{0!s}' not found.".format(configFile))
class Application(LineTerminal):
def __init__(self):
super().__init__(verbose=True, debug=True, quiet=False)
mod = SubModule(Path("config.yml"), self)
def run(self):
pass
# entry point
if __name__ == "__main__":
app = Application()
app.run()
Contributors
- Patrick Lehmann (Maintainer)
- and more...
License
This Python package (source code) licensed under Apache License 2.0.
The accompanying documentation is licensed under Creative Commons - Attribution 4.0 (CC-BY 4.0).
SPDX-License-Identifier: Apache-2.0
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
pyTooling.TerminalUI-1.5.1.tar.gz
(14.3 kB
view hashes)
Built Distribution
Close
Hashes for pyTooling.TerminalUI-1.5.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90a15aa8c06898e0716a18323461cfe910c8aa5b0b3a7efbcf6d027e5eb4c0e9 |
|
MD5 | 293ccdd29bf91060938c8519a203139f |
|
BLAKE2b-256 | 344f3be251d6ba4c4d47ee8a2465ce42eaf3ba8cfcac821739b73cbc7632dfa0 |
Close
Hashes for pyTooling.TerminalUI-1.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aca4a025b8420e43ed314b89b6e912905f3fe72fd9e94b2ef22207c166c1cd1b |
|
MD5 | bcfecd7f302873914a94736401d2f10c |
|
BLAKE2b-256 | aa1581b03ee9a474c92aa2526c940915e76eb88f600feb16b5005d2bb2515d95 |