Metadata-Version: 2.4
Name: Ara_imgui
Version: 1.3.0
Summary: A simplified wrapper for Dear ImGui and GLFW
Author-email: HanamileH <hanamileh@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/hanamileh-DEV/Ara_imgui
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: glfw>=2.8.0
Requires-Dist: imgui==2.0.0
Requires-Dist: pyopengl>=3.1.9

# Ara_imgui

**Ara_imgui** is a lightweight and easy-to-use wrapper around [Dear ImGui](https://github.com/ocornut/imgui) using Python and GLFW. It simplifies GUI application development with ImGui by providing a convenient interface for managing windows, fonts, and application lifecycle.

## Features

- Simple ImGui app launch with a single `run` function
- Support for multiple ImGui windows via the `Window` class
- Built-in dark and light themes
- System or custom font loading, including Cyrillic support
- Ready-to-run examples included in the `examples` folder

## Installation

```bash
pip install ara_imgui
````

Or install dependencies manually:

```bash
pip install glfw PyOpenGL imgui
```

> ⚠️ Make sure you have Python 3.7+ and OpenGL support (e.g., via GPU drivers on Windows).

## Usage

### Basic example

```python
from ara_imgui import run, imgui

def gui():
    imgui.text("Hello, world!")
    if imgui.button("Click me"):
        print("Clicked!")

run(gui)
```

### Multiple windows

```python
from ara_imgui import App, Window, imgui

app = App("Multi-window App")

def win_ui():
    imgui.text("This is another window")

win = Window("Extra Window", frame_ui=win_ui)

def main_ui():
    imgui.text("Main Window")  
    if imgui.button("Open Extra Window"):
        app.add_window(win)

app.run(main_ui)
```

### Custom fonts and themes

```python
from ara_imgui import App, imgui

app = App("Font Example")
app.apply_theme("light")
app.load_font(font_size=18)

def gui():
    imgui.text("Sample text with custom font")

app.run(gui)
```

## API

### `run(frame_ui, **kwargs)`

Minimal interface to launch the application.

Parameters:

* `frame_ui`: Function to render the main UI.
* `callback`: Function called after `frame_ui` (optional).
* `title`: Window title.
* `width`, `height`: Window size.
* `theme`: `"dark"` or `"light"`.
* `custom_font`: `False`, `True`, or path to a `.ttf` file.
* `font_size`: Font size.
* `cyrillic_ranges`: Include Cyrillic character ranges (`True` by default).

### Classes

* `App` — The main application class.
* `Window` — Represents a separate ImGui window with its own logic.

## Examples

See the [`examples/`](./examples) folder:

* `hello_world.py` — Basic "Hello, world!" with a button.
* `basic_window.py` — Simple window with input field.
* `custom_font.py` — Font and multilingual text rendering.
* `multiple_window.py` — GUI with multiple ImGui windows.

## Dependencies

* `imgui`
* `glfw`
* `PyOpenGL`

## License

MIT License. Free to use and modify.
