Urwid

About

Urwid is a console user interface library for Python on Linux, OSX, Cygwin or other unix-like OS and partially supports Windows OS (see below).

It includes many features useful for text console application developers including:

• Applications resize quickly and smoothly

• Automatic, programmable text alignment and wrapping

• Simple markup for setting text attributes within blocks of text

• Powerful list box with programmable content for scrolling all widget types

• Your choice of event loops: Twisted, Glib (deprecated), Tornado, asyncio, trio, ZeroMQ or select-based loop

• Pre-built widgets include edit boxes, buttons, check boxes and radio buttons

• Display modules include raw, curses, and experimental LCD (deprecated) and web displays

• Support for UTF-8, simple 8-bit and CJK encodings

• 24-bit (true color), 256 color, and 88 color mode support

• Compatible with Python 3.11+ and PyPy

Home Page:

http://urwid.org/

Installation

To install using pip

pip install urwid

For advanced functionality extra requirements need to be installed. Example for the ZeroMQ event loop:

pip install urwid[zmq]

Alternatively if you are on Debian or Ubuntu

apt-get install python3-urwid

Windows support notes

Windows support is limited to the Windows 10+ due to ANSI support requirement.

• Not supported:

1. Terminal widget and all related render API (TermCanvas, TermCharset, TermModes, TermScroller)

2. Any file descriptors except sockets (Windows OS limitation)

3. ZMQEventLoop.

• Special requirements:

1. Extra libraries required for curses display support:

pip install urwid[curses]

• CursesDisplay incorrectly handles mouse input in case of fast actions.

• Only UTF-8 mode is supported.

Testing

To run tests locally, install & run tox. You must have appropriate Python versions installed to run tox for each of them.

To test code in all Python versions:

tox                           # Test all versions specified in tox.ini
tox -e py311                  # Test Python 3.11 only
tox -e py313t                 # Test Python 3.13 with free-threading
tox -e pypy311                # Test PyPy 3.11
tox -e py311,py312,pypy311    # Test specific versions

tox -e py313

tox -e py313t        # Python 3.13 free-threaded (PEP 703)
tox -e py314t        # Python 3.14 free-threaded
tox -e py315t        # Python 3.15 free-threaded

tox -e pypy311       # PyPy 3.11
tox -e pypy312       # PyPy 3.12

Supported Python versions

Urwid supports:

• CPython 3.11, 3.12, 3.13, 3.14, 3.15

• CPython 3.13+ with free-threading (PEP 703 --disable-gil)

• PyPy 3.11

Python implementation notes

CPython (standard Python)

Full support for all optional features. All extras (curses, glib, serial, tornado, trio, twisted, zmq) can be installed. On Windows, the curses extra cannot be installed on Python 3.15 yet: windows-curses publishes no 3.15 wheel.

CPython with Free-Threading (3.13, 3.14, 3.15+)

Urwid core and pure-Python event loops are fully supported. Some extras require C extensions that may not have free-threading wheels available:

• ✅ Supported: core, tornado, trio, twisted, serial, lcd

• ❌ Unsupported: glib, zmq (require C extensions with free-threading wheel support)

For free-threading Python, install with compatible extras:

python3.13 -m pip install 'urwid[tornado,trio,serial]'

PyPy

Urwid core is fully supported. Some extras may have compatibility issues:

• ✅ Supported: core, tornado, trio, serial, lcd

• ⚠️ Limited: twisted (may have issues, test before using)

• ❌ Unsupported: glib, zmq (C extensions with limited PyPy support)

• ❌ Unsupported: curses on Windows (PyPy for Windows ships no _curses module and windows-curses publishes no PyPy wheels)

Authors