Metadata-Version: 2.4
Name: hatui-kit
Version: 0.1.0
Summary: A configurable hacker-style terminal UI toolkit driven by YAML screens, widgets, and providers.
Project-URL: Homepage, https://github.com/almajd3713/hacker_tui_sim
Project-URL: Repository, https://github.com/almajd3713/hacker_tui_sim
Project-URL: Issues, https://github.com/almajd3713/hacker_tui_sim/issues
Author: almajd3713
License: MIT License
        
        Copyright (c) 2026 Hatui contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: cli,dashboard,terminal,tui,yaml
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: User Interfaces
Classifier: Topic :: Terminals
Requires-Python: >=3.10
Requires-Dist: pyyaml>=6.0
Description-Content-Type: text/markdown

# Hatui

Hatui is a configurable hacker-style terminal UI toolkit for Python. It lets you compose full-screen TUIs from YAML screens, reusable widgets, themes, routing, and data providers.

## Install

Recommended for end users:

```bash
pipx install hatui-kit
```

Python package install:

```bash
pip install hatui-kit
```

Installed CLI command:

```bash
hatui
```

Windows convenience build:

- Download `hatui-windows-amd64.zip` from GitHub Releases
- Unzip it
- Run `hatui.exe`

## Quick start

Run the bundled demo:

```bash
hatui
```

Validate the bundled demo spec:

```bash
hatui validate
```

Render a non-interactive preview:

```bash
hatui preview --width 100 --height 28 --frames 1
```

Run a custom spec:

```bash
hatui run path/to/screen.yaml
```

## What Hatui provides

- declarative YAML screen loading with includes
- widget and provider registries
- routing, modals, focus traversal, and debug overlays
- theme slots, color tokens, and font tokens
- reusable hacker-style widgets for dashboards and console simulations

## Example custom spec

```yaml
theme:
  preset: clean_ops

providers:
  - type: constant
    name: hello_text
    target: ui.hello
    value: Hello from Hatui

screen:
  type: box
  name: root_box
  title: demo
  padding: 1
  child:
    type: text
    name: hello_text
    text_key: ui.hello
```

Run it with:

```bash
hatui run ./demo.yaml
```

## Development

Editable install:

```bash
python -m pip install -e .
```

Smoke checks:

```bash
python -m compileall src
PYTHONPATH=src python -m hatui validate
PYTHONPATH=src python -m hatui preview --width 100 --height 28 --frames 1
```
