tooey 0.3.0

Automatically turn script arguments into an interactive terminal interface

Tooey

Turn any python console script into an interactive TUI application. Tooey is similar to (and inspired by) Gooey, but keeps you in the terminal.

Without Tooey 😕

With Tooey 🎉

Installation

Install Tooey from PyPi via pip:

python -m pip install tooey

Getting started

Decorate your script's argparse function with @Tooey, then run the script with or without any of its arguments. You'll be prompted interactively in the terminal to enter each argument. After this the script will continue as normal.

Example

The following python script requests and then prints three arguments. The method that handles command line arguments is decorated with @Tooey.

import argparse
from tooey import Tooey

@Tooey
def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('positional', nargs=1, help='A positional argument requiring one value')
    parser.add_argument('--named-choices', nargs=2, type=int, choices=range(1, 5), help='A named argument requiring two integers from a given list of choices')
    parser.add_argument('--store-true', action='store_true', help='A store_true argument')
    print(parser.parse_args())

main()

Tooey automatically turns this into an interactive prompt for each argument.

Configuration

Tooey will automatically inject itself into any decorated functions whenever sys.isatty() is True.

If you would like to override this behaviour and disable Tooey when running a script, add the additional parameter --ignore-tooey when running, or set an environment variable IGNORE_TOOEY. For example, Tooey will ignore any decorated methods in this script:

$ python tooey_example.py val1 --named-choices 1 3 --ignore-tooey

Conversely, if you would like to force Tooey to inject itself into decorated functions even when it does not detect a terminal-like environment, add the additional parameter --force-tooey when running, or set an environment variable FORCE_TOOEY. For example, Tooey will still run in the following script:

$ FORCE_TOOEY=1 python tooey_example.py val1 --named-choices 1 3 | sort

License

Apache 2.0