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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AndrewDunai from gravatar.com AndrewDunai Avatar for iward from gravatar.com iward Avatar for penguinolog from gravatar.com penguinolog Avatar for tonycpsu from gravatar.com tonycpsu Avatar for ulidtko from gravatar.com ulidtko

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Library or Lesser General Public License (LGPL) (LGPL-2.1-only)
  • Author: Ian Ward
  • Tags curses, ui, widget, scroll, listbox, user interface, text layout, console, ncurses
  • Requires: Python >3.7
Classifiers

Project description

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.7+ 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

  • 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.7

  • 3.8

  • 3.9

  • 3.10

  • 3.11

  • 3.12

  • 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

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for AndrewDunai from gravatar.com AndrewDunai Avatar for iward from gravatar.com iward Avatar for penguinolog from gravatar.com penguinolog Avatar for tonycpsu from gravatar.com tonycpsu Avatar for ulidtko from gravatar.com ulidtko

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Library or Lesser General Public License (LGPL) (LGPL-2.1-only)
  • Author: Ian Ward
  • Tags curses, ui, widget, scroll, listbox, user interface, text layout, console, ncurses
  • Requires: Python >3.7
Classifiers

Release history Release notifications | RSS feed

2.6.16

2.6.15

2.6.14

This version

2.6.13

2.6.12

2.6.11

2.6.10

2.6.9

2.6.8

2.6.7

2.6.6

2.6.5

2.6.4

2.6.3

2.6.2

2.6.1

2.6.0.post0

2.6.0

2.5.3

2.5.2

2.5.1

2.5.0

2.4.6

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0 yanked

Reason this release was yanked:

imported deprecated modules, fixed in 2.4.1

2.3.4

2.2.3

2.2.2

2.2.1

2.2.0

2.1.2

2.1.1

2.1.0

2.0.1

2.0.0

1.3.1

1.3.0

1.2.2

1.2.1

1.2.0

1.1.2

1.1.1

1.1.0

1.0.2

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 pre-release

0.9.0-pre2 pre-release

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

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.6.13.tar.gz (847.6 kB view details)

Uploaded Source

Built Distribution

urwid-2.6.13-py3-none-any.whl (297.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: urwid-2.6.13.tar.gz
  • Upload date:
  • Size: 847.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for urwid-2.6.13.tar.gz
Algorithm Hash digest
SHA256 675116f417d80c931bcb880b77015a3d46fed0a6cf703223da73cf586adfea49
MD5 fd9045c355929e3aaaec3796382d01b6
BLAKE2b-256 81b5b777c994bd082ed836c5559add7bda96bae1c71bdd69c65c6c323311f4af

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: urwid-2.6.13-py3-none-any.whl
  • Upload date:
  • Size: 297.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for urwid-2.6.13-py3-none-any.whl
Algorithm Hash digest
SHA256 6024f8c502e38447ad5151bcbb33243a9408c0066df177b0dddf8e7b2b0ae595
MD5 b3d33a550d48c0df59a20e99a4b3fda6
BLAKE2b-256 ead9e35d525fbf77efdfe7eff8a070001a60434a36500a07b2030b3a2efc024c

See more details on using hashes here.

Provenance

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