urwid-readline

A textbox edit widget for urwid that supports readline shortcuts


License
MIT
Install
pip install urwid-readline==0.14

Documentation

urwid_readline

Text input widget for urwid that supports readline shortcuts.

Installation

pip install urwid-readline

Example how to use the program can be found in the examples directory.

Development

Please ensure pull requests pass CI, which requires your code to be formatted with black . and tests to pass via pytest.

Both tools can be installed with the dev extra install option; such an install from a local git repo reflecting the code (ie. 'editable'), ideally in a python virtual environment, can be achieved through a command like python3 -m pip install --editable .[dev].

Features

Supported operations:

Command Key Combination
Jump to the Beginning of line Ctrl + A
Jump backward one character Ctrl + B /
Jump backward one word Meta + B
Delete one character Ctrl + D
Delete one word Meta + D
Jump to the end of line Ctrl + E
Jump forward one character Ctrl + F /
Jump forward one word Meta + F
Delete previous character Ctrl + H
Transpose characters Ctrl + T
Kill (cut) forwards to the end of the line Ctrl + K
Kill (cut) backwards to the start of the line Ctrl + U
Kill (cut) forwards to the end of the current word Meta + D
Kill (cut) backwards to the start of the current word Ctrl + W
Paste last kill Ctrl + Y
Undo last action Ctrl + _
Jump to previous line Ctrl + P /
Jump to next line Ctrl + N /
Clear screen Ctrl + L
Autocomplete See examples