Metadata-Version: 2.4
Name: functui
Version: 0.0.6
Summary: Immediate mode TUI library.
Author: Viacheslav Andrushenko
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: wcwidth
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-codspeed; extra == 'dev'
Requires-Dist: snakeviz; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Provides-Extra: doc
Requires-Dist: furo; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-autobuild; extra == 'doc'
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/functui.svg)](https://badge.fury.io/py/functui)
[![Supported Python Versions](https://img.shields.io/pypi/pyversions/functui)](https://pypi.org/project/functui)
[![Read the Docs](https://img.shields.io/readthedocs/functui)](https://functui.readthedocs.io/en/latest/index.html)

> [!WARNING]
> This library is in early development and the API **will** change.

Functui is a python library for creating immediate mode text user interfaces.

Documentation can be found at [readthedocs](https://functui.readthedocs.io/en/latest/index.html).

## Installation
Install with pip or your preferred python package manager.
```bash
pip install functui
```

## Run Demo
Test how your terminal displays colors and styles.
(It is normal that not all style attributes get rendered properly since not all terminals support all of them)
``` bash
python3 -m functui
```

## Running Examples
Clone the repo to get access to /example folder.
``` bash
git clone git@github.com:Slsv1/functui.git
```
Run the examples. (assuming you have functui already installed)
```
cd functui/examples
python3 EXAMPLE_NAME.py
```
