mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-07-24 18:04:32 +02:00
parent
04107d3fea
commit
0aefbb634d
4 changed files with 1 additions and 37 deletions
BIN
docs/_static/img/tui.png
vendored
BIN
docs/_static/img/tui.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 233 KiB |
28
docs/cli.rst
28
docs/cli.rst
|
|
@ -2781,30 +2781,4 @@ 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:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
sqlite-utils install trogon
|
||||
|
||||
Once installed, running the ``sqlite-utils tui`` command will launch the TUI interface:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
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.
|
||||
Use ``-y`` to skip the request for confirmation.
|
||||
1
setup.py
1
setup.py
|
|
@ -50,7 +50,6 @@ setup(
|
|||
"data-science-types",
|
||||
],
|
||||
"flake8": ["flake8"],
|
||||
"tui": ["trogon"],
|
||||
},
|
||||
entry_points="""
|
||||
[console_scripts]
|
||||
|
|
|
|||
|
|
@ -35,11 +35,6 @@ from .utils import (
|
|||
TypeTracker,
|
||||
)
|
||||
|
||||
try:
|
||||
import trogon # type: ignore
|
||||
except ImportError:
|
||||
trogon = None
|
||||
|
||||
|
||||
CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
|
||||
|
||||
|
|
@ -127,10 +122,6 @@ def cli():
|
|||
pass
|
||||
|
||||
|
||||
if trogon is not None:
|
||||
cli = trogon.tui()(cli)
|
||||
|
||||
|
||||
@cli.command()
|
||||
@click.argument(
|
||||
"path",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue