Skip to main content

A full-featured console (xterm et al.) user interface library

Project description


current version on PyPi Documentation Status CI status test coverage


Urwid is a console user interface library for Python on Linux, OSX, Cygwin or other unix-like OS. 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, 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 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.7+ and PyPy

Home Page:


To install using pip

pip install urwid

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

pip install urwid[serial,zmq]

Alternatively if you are on Debian or Ubuntu

apt-get install python3-urwid


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 py39             # Test Python 3.9 only
tox -e py39,py10,pypy3  # Test Python 3.9, Python 3.10 & pypy3

Supported Python versions

  • 3.7

  • 3.8

  • 3.9

  • 3.10

  • 3.11

  • 3.12

  • pypy3





and3rson, tonycpsu, ulidtko, penguinolog


1in7billion, abadger, agrenott, akorb, alethiophile, aleufroy, alobbs, amjltc295, and-semakin, andrewshadura, andy-z, anttin2020, Apteryks, Arfrever, AutoAwesome, belak, berney, bk2204, BkPHcgQL3V, bwesterb, carlos-jenkins, Certseeds, Chipsterjulien, chrisspen, cltrudeau, Codeberg-AsGithubAlternative-buhtz, cortesi, d0c-s4vage, derdon, dholth, dimays, dlo, dnaeon, doddo, douglas-larocca, drestebon, dsotr, dwf, EdwardBetts, elenril, EnricoBilla, extempore, fabiand, floppym, flowblok, fmoreau, goncalopp, Gordin, GregIngelmo, grzaks, gurupras, HarveyHunt, Hoolean, hukka, hydratim, ids1024, imrek, isovector, itaisod, ixxra, jeblair, johndeaton, jonblack, jspricke, kedder, Kelketek, KennethNielsen, kesipyc, kkrolczyk, Kwpolska, Lahorde, laike9m, larsks, lfam, lgbaldoni, lighth7015, livibetter, Lothiraldan, Mad-ness, madebr, magniff, marlox-ouda, mattymo, mdtrooper, mgk, mimi1vx, mobyte0, MonAaraj, MonthlyPython, mountainstorm, mselee, mwhudson, naquad, nchavez324, neumond, nolash, ntamas, nyov, ocarneiro, okayzed, pquentin, rbanffy, ReddyKilowatt, regebro, renegarcia, rianhunter, roburban, RRMoelker, rwarren, scopatz, seanhussey, seonon, shadedKE, sithglan, Sjc1000, sporkexec, squrky, ssbr, techdragon, thehunmonkgroup, thisch, thornycrackers, TomasTomecek, tompickering, tony, ttanner, tu500, uSpike, vega0, vit1251, waveform80, Wesmania, xandfury, xndcn, zhongshangwu, zrax

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

urwid-2.2.3.tar.gz (677.7 kB view hashes)

Uploaded source

Built Distributions

urwid-2.2.3-cp312-cp312-macosx_11_0_arm64.whl (260.6 kB view hashes)

Uploaded cp312

urwid-2.2.3-cp312-cp312-macosx_10_9_x86_64.whl (260.0 kB view hashes)

Uploaded cp312

urwid-2.2.3-cp311-cp311-macosx_11_0_arm64.whl (260.6 kB view hashes)

Uploaded cp311

urwid-2.2.3-cp311-cp311-macosx_10_9_x86_64.whl (260.0 kB view hashes)

Uploaded cp311

urwid-2.2.3-cp310-cp310-macosx_11_0_arm64.whl (260.6 kB view hashes)

Uploaded cp310

urwid-2.2.3-cp310-cp310-macosx_10_9_x86_64.whl (260.0 kB view hashes)

Uploaded cp310

urwid-2.2.3-cp39-cp39-macosx_11_0_arm64.whl (260.6 kB view hashes)

Uploaded cp39

urwid-2.2.3-cp39-cp39-macosx_10_9_x86_64.whl (260.0 kB view hashes)

Uploaded cp39

urwid-2.2.3-cp38-cp38-macosx_11_0_arm64.whl (260.6 kB view hashes)

Uploaded cp38

urwid-2.2.3-cp38-cp38-macosx_10_9_x86_64.whl (260.0 kB view hashes)

Uploaded cp38

urwid-2.2.3-cp37-cp37m-macosx_10_9_x86_64.whl (259.9 kB view hashes)

Uploaded cp37

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page