Documentation for trogon TUI, refs #545

.github/workflows/publish.yml

@@ -26,7 +26,7 @@ jobs:
           ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
-        pip install -e '.[test]'
+        pip install -e '.[test,tui]'
     - name: Run tests
       run: |
         pytest

.github/workflows/test.yml

@@ -28,7 +28,7 @@ jobs:
           ${{ runner.os }}-pip-
     - name: Install dependencies
       run: |
-        pip install -e '.[test,mypy,flake8]'
+        pip install -e '.[test,mypy,flake8,tui]'
     - name: Optionally install numpy
       if: matrix.numpy == 1
       run: pip install numpy

docs/cli-reference.rst

@@ -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")
@@ -1022,6 +1023,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

docs/cli.rst

@@ -2159,3 +2159,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 `Trogan <https://github.com/Textualize/trogon/>`__ TUI library.
+
+To enable this feature you will need to install the ``trogan`` dependency. You can do that like so::
+
+    sqite-utils install trogan
+
+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.

setup.py

@@ -47,6 +47,7 @@ setup(
             "data-science-types",
         ],
         "flake8": ["flake8"],
+        "tui": ["trogon"],
     },
     entry_points="""
         [console_scripts]