Skip to main content

Urwid

current version on PyPi Documentation Status Gitter CI status pre-commit test coverage

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, 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.9+ 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 ZeroMQ event loop and LCD display:

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

Supported Python versions

  • 3.9

  • 3.10

  • 3.11

  • 3.12

  • 3.13

  • 3.14

  • pypy3

Authors

Creator

wardi

Maintainers

and3rson, tonycpsu, ulidtko, penguinolog

Contributors

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-4.1.5.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

urwid-4.1.5-py3-none-any.whl (355.0 kB view details)

Uploaded Python 3

File details

Details for the file urwid-4.1.5.tar.gz.

File metadata

  • Download URL: urwid-4.1.5.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for urwid-4.1.5.tar.gz
Algorithm Hash digest
SHA256 cfae4dace2565dd3725c0047150d68dcb662cf350eb4f0cefef64b8cd88a2251
MD5 b083179975ac03e7319194eb48b1c264
BLAKE2b-256 52f7111e5df1310a1287fd57ed3c09fb3a0b2b857bd192a02dd14fa92c89a9d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for urwid-4.1.5.tar.gz:

Publisher: pythonpackage.yml on urwid/urwid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file urwid-4.1.5-py3-none-any.whl.

File metadata

  • Download URL: urwid-4.1.5-py3-none-any.whl
  • Upload date:
  • Size: 355.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for urwid-4.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b25b8dd0515cd46535dd86fdf678704e9522db6b94ad2e05b164a716e0856119
MD5 2593172f740a374701f6279414074fdb
BLAKE2b-256 b95a17c16a7dbf86d501bfed0076c9879b14e7a27981a74fd3a0edfd2550617f

See more details on using hashes here.

Provenance

The following attestation bundles were made for urwid-4.1.5-py3-none-any.whl:

Publisher: pythonpackage.yml on urwid/urwid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.1.5 This release

2 files

4.1.4

2 files

4.1.3

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.13

2 files

4.0.12

2 files

4.0.11

2 files

4.0.10

2 files

4.0.9

2 files

4.0.8

2 files

4.0.7

2 files

4.0.6

2 files

4.0.5

2 files

4.0.4

2 files

4.0.3

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.0.5

2 files

3.0.4

2 files

3.0.3

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.6.16

2 files

2.6.15

2 files

2.6.14

2 files

2.6.13

2 files

2.6.12

2 files

2.6.11

2 files

2.6.10

2 files

2.6.9

2 files

2.6.8

2 files

2.6.7

2 files

2.6.6

2 files

2.6.5

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0.post0

2 files

2.6.0

1 file

2.5.3

47 files

2.5.2

47 files

2.5.1

47 files

2.5.0

47 files

2.4.6

47 files

2.4.5

47 files

2.4.4

47 files

2.4.3

47 files

2.4.2

47 files

2.4.1

47 files

2.4.0

47 files

2.3.4

35 files

2.2.3

35 files

2.2.2

35 files

2.2.1

35 files

2.2.0

35 files

2.1.2

1 file

2.1.1

1 file

2.1.0

1 file

2.0.1

1 file

2.0.0

1 file

1.3.1

1 file

1.3.0

1 file

1.2.2

1 file

1.2.1

1 file

1.2.0

1 file

1.1.2

1 file

1.1.1

1 file

1.1.0

1 file

1.0.2

1 file

1.0.1

1.0.0

0.9.9.2

0.9.9.1

0.9.9

0.9.8.4

0.9.8.3

0.9.8.2

0.9.8

0.9.7.2

0.9.7

0.9.6

0.9.5

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.9.0-pre3

0.9.0-pre2

0.8.10

0.8.9

0.8.8

0.8.7

0.8.6

0.8.5

0.8.4

0.8.3

0.8.2

0.8.1

0.8.0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page