Experimental TUI powered by Trogon

* sqlite-utils tui command if Trogon is installed, closes #545
* Documentation for trogon TUI
* Screenshot of TUI
* Ignore trogon mypy error
* only run flake8 on Python 3.8 or higher, closes #550
This commit is contained in:
Simon Willison 2023-05-21 11:41:56 -07:00 committed by GitHub
commit 718b0cba9b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 55 additions and 4 deletions

BIN
docs/_static/img/tui.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 233 KiB

View file

@ -61,6 +61,7 @@ This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
"create-spatial-index": "cli_spatialite_indexes",
"install": "cli_install",
"uninstall": "cli_uninstall",
"tui": "cli_tui",
}
commands.sort(key = lambda command: go_first.index(command) if command in go_first else 999)
cog.out("\n")
@ -1025,6 +1026,23 @@ disable-fts
-h, --help Show this message and exit.
.. _cli_ref_tui:
tui
===
See :ref:`cli_tui`.
::
Usage: sqlite-utils tui [OPTIONS]
Open Textual TUI.
Options:
-h, --help Show this message and exit.
.. _cli_ref_optimize:
optimize

View file

@ -2163,3 +2163,25 @@ You can uninstall packages that were installed using ``sqlite-utils install`` wi
$ sqlite-utils uninstall beautifulsoup4
Use ``-y`` to skip the request for confirmation.
.. _cli_tui:
Experimental TUI
================
A TUI is a "text user interface" (or "terminal user interface") - a keyboard and mouse driven graphical interface running in your terminal.
``sqlite-utils`` has experimental support for a TUI for building command-line invocations, built on top of the `Trogon <https://github.com/Textualize/trogon/>`__ TUI library.
To enable this feature you will need to install the ``trogon`` dependency. You can do that like so::
sqite-utils install trogon
Once installed, running the ``sqlite-utils tui`` command will launch the TUI interface::
sqlite-utils tui
You can then construct a command by selecting options from the menus, and execute it using ``Ctrl+R``.
.. image:: _static/img/tui.png
:alt: A TUI interface for sqlite-utils - the left column shows a list of commands, while the right panel has a form for constructing arguments to the add-column command.