Metadata-Version: 2.4
Name: runtui
Version: 0.1.2
Summary: Modern pure-Python cross-platform TUI framework with RAD designer, themes, mouse support, embedded terminals, and rich widgets
Project-URL: Homepage, https://github.com/erickrus/runtui
Project-URL: Repository, https://github.com/erickrus/runtui
Project-URL: Bug Tracker, https://github.com/erickrus/runtui/issues
Project-URL: Documentation, https://github.com/erickrus/runtui#readme
Author-email: Erickrus <hyinghao@gmail.com>
License: MIT
Keywords: curses-alternative,mouse,rad,terminal-ui,tui,widgets
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.8
Requires-Dist: pillow
Requires-Dist: pyte
Requires-Dist: pywinpty; platform_system == 'Windows'
Requires-Dist: send2trash
Description-Content-Type: text/markdown

# RunTUI — Modern Terminal UI Framework for Python

*Build beautiful, interactive, mouse-aware terminal applications in pure Python — no curses, no ncurses, no external dependencies.*

<p align="center">
  <img src="https://github.com/Erickrus/runtui/blob/main/images/demo.gif?raw=true" alt="runtui in action — animated demo">
</p>

`runtui` is a full-featured, cross-platform **TUI (Text User Interface)** library written in **100% pure Python**.  
It brings modern desktop-like experience into your terminal: windows, dialogs, forms, image rendering, embedded terminals, mouse support, theming, layout managers and even a **visual RAD (Rapid Application Development) designer**.

Works seamlessly on **Linux**, **macOS**, and **Windows**

## ✨ Highlights

- Pure Python — zero compiled dependencies
- Cross-platform (Linux, macOS, Windows)
- Rich set of **widgets** — Button, Input, Password, TextArea, Dropdown, ListBox, CheckBox, Radio, Calendar, ColorPicker, ProgressBar, Image, **real Terminal**, etc.
- Multiple **layout** engines: Absolute, Box, Dock, Grid
- Theme engine with built-in themes: Dark, Light, Nord, Solarized, Turbo Vision / Borland style
- Mouse support (click, drag, scroll, hover)
- Window manager with floating & tiled windows + taskbar
- Dialogs: MessageBox, File Open/Save, Custom Forms
- **Visual RAD designer** (`rad_designer.py`) — drag & drop UI building + code generation
- Embedded **terminal** widget with PTY support (run vim, htop, bash, python REPL, … inside your app!)
- Clean event loop, timers, key bindings, context menus

## Installation

```bash
pip install runtui
```

## Run
```bash
python -m runtui.tui_os
```

```bash
python -m runtui.rad_designer
```

More examples in the [`examples/`](examples/) folder:

- `cal.py`               — Calendar
- `calc.py`              — Calculator
- `chatbox.py`           — LLM Chat App
- `clock.py`             — A basic clock program
- `demo_app.py`          — widget showcase
- `mine.py`              - window's mine game
- `notes.py`             — mac os like personal notes
- `rad_designer.py`      — visual designer (very cool!)
- `puzzle.py`            — mac os like puzzle game
- `tui_os.py`            — tui desktop / OS-like interface

It is highly recommended to run everything inside `tui_os.py` by browse these python files in Finder.


## Why choose runtui over other TUI libraries?

| Feature                     | runtui      | Textual     | urwid      | py_cui     | rich + textual |
|-----------------------------|-------------|-------------|------------|------------|----------------|
| Pure Python                 | ✓           | ✓           | ✓          | ✓          | ✓              |
| Cross-platform (good)       | ✓           | ✓           | △          | ✓          | ✓              |
| Mouse support               | ✓           | ✓           | ✗          | ✓          | ✓              |
| Built-in themes             | ✓ (many)    | ✓ (CSS)     | ✗          | ✗          | ✓              |
| Embedded terminal widget    | ✓ (PTY)     | ✗           | ✗          | ✗          | ✗              |
| Visual RAD designer         | ✓           | ✗           | ✗          | ✗          | ✗              |
| Image rendering             | ✓           | ✓           | ✗          | ✗          | ✓              |
| Floating windows + taskbar  | ✓           | △           | ✗          | ✗          | ✗              |
| LLM Chat App                | ✓           | ✗           | ✗          | ✗          | ✗              |


## License

MIT

---

Made with ❤️ in the terminal  
Start building your next TUI masterpiece today!
