Skip to main content

title

Python TUI framework with mouse support, modular widget system, customizable and rapid terminal markup language and more!

pip3 install pytermgui

PyPi project


Archival notice

PyTermGUI is no longer in development. The latest release will remain available, alongside its documentation. The MIT license allows for free modification of the library, as long as you include credit to its original author. Thank you for everything.


Why?

Mostly because terminals are cool, but creating terminal apps has historically been difficult. PyTermGUI aims to provide a simple, readable and modular way to make the app of your dreams!

Terminal apps are (often):

  • Easier to install
  • Faster & more resource efficient
  • Less prone to differences between environments (no IE7 here!)

...than their web or native counterparts.

How?

We provide a couple of things to make your life easier:

  • Sensible abstractions over most terminal standards
  • A fully fledged, desktop-inspired window manager system with modals and completely customizable windows
  • Mouse support out of the box with 0 configuration
  • YAML (or Python) based styling engines
  • TIM, our markup language for creating styled terminal text with expressive text, including systems for aliases & macros
  • A bunch of things I can't think of right now :slightly_smiling_face:

Additionally, there are a couple of neat tools to make your general Python development easier:

  • An inspection utility
  • A pretty printer for both the REPL and IPython
  • A way to create SVG and HTML screenshots of your terminal

Terminal compatibility

PyTermGUI relies on ANSI virtual-terminal sequences for rendering, cursor reports, keyboard input, and mouse input. On Windows, support depends on the terminal emulator's ANSI compatibility. Windows Terminal supports the expected cursor and mouse protocols, while the legacy Windows Console Host (conhost.exe) may provide reduced functionality. This does not depend on whether PowerShell or Command Prompt is running inside the emulator. Mouse support also depends on the emulator forwarding the requested events.

Latest release

7.8.0 - 2026-08-10

Additions

  • Add grapheme-aware wrapping with correct widths for CJK and emoji sequences
  • Preserve ANSI styles and hyperlinks when wrapping text
  • Document terminal compatibility and the project's archived status

Bugfixes

  • Fix terminal clearing, synchronized frame recording, and resize handling
  • Fix multiline input cursor placement and nested container scrolling
  • Fix uneven splitter columns and automatically sized scrollable windows
  • Fix ANSI bright magenta, cyan, and white color mappings
  • Fix cursor-home and erase sequences in ANSI exports
  • Avoid busy-waiting for input on Windows

Maintenance

  • Modernize linting and packaging configuration
  • Remove obsolete project assets and tooling

Read the full changelog here.

Metadata

Release files for PyTermGUI 7.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for PyTermGUI 7.8.0
File Size Uploaded
pytermgui-7.8.0.tar.gz 133.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for PyTermGUI 7.8.0
File Interpreter ABI Platform
pytermgui-7.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 293.1 kB

Release files / pytermgui-7.8.0.tar.gz

Download URL pytermgui-7.8.0.tar.gz
Size 133.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c4cea2e9a0e7b7900f47989278e9f3b88eddd6e6319df198d91484b6311d2368
BLAKE2b-256 checksum
How to use checksums
7fb7e15440a6dc7d727954c28ef821f2e082a3b2a3a5d189a5816a8cf42e6f8a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Release files / pytermgui-7.8.0-py3-none-any.whl

Download URL pytermgui-7.8.0-py3-none-any.whl
Size 160.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27ec242f0863083f76cad25ffcccd5a0efc96de1ad408d7216c4f76751d4fa41
BLAKE2b-256 checksum
How to use checksums
ca3cc3d9cdb8aad736f96bc48cbc214d1059f89d6524f47e71c2a916e99a1820
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Release history Release notifications | RSS feed

7.8.1

2 release files

This release

7.8.0 This release

2 release files

7.7.4

2 release files

7.7.3

2 release files

7.7.2

2 release files

7.7.1

2 release files

7.7.0

2 release files

7.6.0

2 release files

7.5.0

2 release files

7.4.0

2 release files

7.3.0

2 release files

7.2.0

2 release files

7.1.0

1 release file

7.0.0

1 release file

6.4.0

1 release file

6.3.0

1 release file

6.2.2

1 release file

6.2.1

1 release file

6.2.0

1 release file

6.1.0

1 release file

6.0.0

1 release file

5.0.0

1 release file

4.3.2

1 release file

4.3.1

1 release file

4.3.0

1 release file

4.2.1

1 release file

4.2.0

1 release file

4.1.0

1 release file

4.0.1

1 release file

4.0.0

1 release file

3.2.1

1 release file

3.2.0

1 release file

3.1.0

1 release file

3.0.0

1 release file

2.2.0

1 release file

2.1.1

1 release file

2.1.0

1 release file

2.0.0

1 release file

1.1.0

1 release file

1.0.1

1 release file

1.0.0

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.0

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

0.1.0

1 release file

0.0.9

1 release file

0.0.8

1 release file

0.0.7

1 release file

0.0.6

1 release file

0.0.5

1 release file

0.0.4

1 release file

0.0.3

1 release file

0.0.2

1 release file

0.0.1

1 release file

0.0.0

1 release file

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