Ara-imgui 1.0.0__tar.gz

ara_imgui-1.0.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: Ara_imgui
+Version: 1.0.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.

ara_imgui-1.0.0/README.md

@@ -0,0 +1,116 @@
+# 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.

ara_imgui-1.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "Ara_imgui"
+version = "1.0.0"
+description = "A simplified wrapper for Dear ImGui and GLFW"
+readme = "README.md"
+authors = [{ name = "HanamileH", email = "hanamileh@gmail.com" }]
+license = "MIT"
+
+dependencies = [
+   "glfw>=2.8.0",
+   "imgui==2.0.0",
+   "pyopengl>=3.1.9"
+]
+requires-python = ">=3.7"
+
+[project.urls]
+Homepage = "https://github.com/hanamileh-DEV/Ara_imgui"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"

ara_imgui-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ara_imgui-1.0.0/src/Ara_imgui.egg-info/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: Ara_imgui
+Version: 1.0.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.

ara_imgui-1.0.0/src/Ara_imgui.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+src/Ara_imgui.egg-info/PKG-INFO
+src/Ara_imgui.egg-info/SOURCES.txt
+src/Ara_imgui.egg-info/dependency_links.txt
+src/Ara_imgui.egg-info/requires.txt
+src/Ara_imgui.egg-info/top_level.txt
+src/ara_imgui/__init__.py
+src/ara_imgui/app.py
+src/ara_imgui/window.py
+tests/test_basic.py

ara_imgui-1.0.0/src/Ara_imgui.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ara_imgui-1.0.0/src/Ara_imgui.egg-info/requires.txt

@@ -0,0 +1,3 @@
+glfw>=2.8.0
+imgui==2.0.0
+pyopengl>=3.1.9

ara_imgui-1.0.0/src/Ara_imgui.egg-info/top_level.txt

@@ -0,0 +1 @@
+ara_imgui

ara_imgui-1.0.0/src/ara_imgui/__init__.py

@@ -0,0 +1,5 @@
+import imgui
+from .app import App, run
+from .window import Window
+
+__all__ = ['App', 'run', 'Window', 'imgui']

ara_imgui-1.0.0/src/ara_imgui/app.py

@@ -0,0 +1,231 @@
+import os
+import sys
+from pathlib import Path
+import inspect
+import glfw
+import imgui
+from imgui.integrations.glfw import GlfwRenderer  # GLFW integration for ImGui
+from .window import Window
+
+class App:
+    """
+    A class representing an ImGui application.
+
+    Attributes:
+        title (str): The title of the application window.
+        width (int): The width of the application window.
+        height (int): The height of the application window.
+        window (GLFWwindow): The GLFW window object.
+        renderer (GlfwRenderer): The ImGui GLFW renderer.
+        windows (set): A set of Window instances.
+    """
+    def __init__(self, title="New app", width=800, height=600):
+        """
+        Initializes the App instance.
+
+        Args:
+            title (str, optional): The title of the application window. Defaults to "New app".
+            width (int, optional): The width of the application window. Defaults to 800.
+            height (int, optional): The height of the application window. Defaults to 600.
+        """
+        # Initialize GLFW
+        if not glfw.init():
+            raise Exception("Failed to initialize GLFW")
+        
+        # Set window properties
+        self.title = title
+        self.width = width
+        self.height = height
+        
+        # Create GLFW window
+        self.window = glfw.create_window(width, height, title, None, None)
+
+        if not self.window:
+            glfw.terminate()
+            raise Exception("Failed to create GLFW window")
+        
+        # Set up OpenGL context and vsync
+        glfw.make_context_current(self.window)
+        glfw.swap_interval(1)  # Enable vsync
+        
+        # Initialize ImGui context and GLFW renderer
+        imgui.create_context()
+        self.renderer = GlfwRenderer(self.window)
+        
+        # ImGui windows
+        self.windows = set()
+
+    
+    def load_font(self, font_path=None, font_size=14, cyrillic_ranges=True):
+        """
+        Loads a font for the application.
+
+        Args:
+            font_path (str, optional): The path to the font file. Defaults to None, which loads the default font.
+            font_size (int, optional): The size of the font. Defaults to 14.
+            cyrillic_ranges (bool, optional): Whether to include Cyrillic character ranges. Defaults to True.
+        """
+        # Loading default font
+        if font_path is None:
+            if sys.platform == "win32":
+                font_path = Path("C:/Windows/Fonts/segoeui.ttf")
+            elif sys.platform == "darwin":
+                font_path = Path("/System/Library/Fonts/SFNSDisplay.ttf")
+            elif sys.platform == "linux":
+                font_path = Path("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf")
+            else:
+                raise Exception(f"Unsupported platform {sys.platform}")
+
+        # Check if font file exists
+        if not os.path.exists(font_path):
+            raise Exception(f"Font file {font_path} does not exist")
+
+        # Loading font
+        io = imgui.get_io()
+
+        glyph_ranges = io.fonts.get_glyph_ranges_default()
+
+        if cyrillic_ranges:
+            glyph_ranges = io.fonts.get_glyph_ranges_cyrillic()
+
+        io.fonts.clear()
+        io.fonts.add_font_from_file_ttf(str(font_path), font_size, None, glyph_ranges)
+        self.renderer.refresh_font_texture()
+
+
+    def apply_theme(self, name: str):
+        """
+        Applies a theme to the application.
+
+        Args:
+            name (str): The name of the theme ("dark" or "light").
+        """
+        if name == "dark":
+            imgui.style_colors_dark()
+        elif name == "light":
+            imgui.style_colors_light()
+        else:
+            raise ValueError(f"Unknown theme name: {name}. Available themes: 'dark', 'light'")
+
+
+    def add_window(self, window: Window):
+        """
+        Adds a window to the application.
+
+        Args:
+            window (Window): The Window instance to add.
+
+        Returns:
+            bool: True if the window was added, False if it was already present.
+        """
+        window.should_close = False
+        if window not in self.windows:
+            self.windows.add(window)
+            return True
+        else:
+            return False
+
+
+    def run(self, frame_ui = None, callback = None):
+        """
+        Executes the main application loop.
+
+        Args:
+            frame_ui (function, optional): The function to draw the main UI. Defaults to None.
+            callback (function, optional): The function to call after drawing the UI. Defaults to None.
+        """
+
+        while not glfw.window_should_close(self.window):
+            # Process events and inputs
+            glfw.poll_events()
+            self.renderer.process_inputs()
+            
+            # Start new ImGui frame
+            imgui.new_frame()
+
+            # Get current window size
+            self.width, self.height = glfw.get_framebuffer_size(self.window)
+
+            # Set up fullscreen window for ImGui main window
+            imgui.set_next_window_position(0, 0)
+            imgui.set_next_window_size(self.width, self.height)
+            imgui.begin(
+                f"##{self.title}", 
+                flags=imgui.WINDOW_NO_DECORATION | 
+                      imgui.WINDOW_NO_MOVE | 
+                      imgui.WINDOW_NO_BRING_TO_FRONT_ON_FOCUS
+            )
+            
+            # Call UI rendering callback if set
+            if frame_ui:
+                sig = inspect.signature(frame_ui)
+                if len(sig.parameters) == 0:
+                    frame_ui()
+                elif len(sig.parameters) == 1:
+                    frame_ui(self)
+                else:
+                    raise TypeError(f"frame_ui function must take 0 or 1 arguments, but {len(sig.parameters)} were given")
+            
+            imgui.end()
+
+            # Drawing ImGui windows
+            self.windows = set([window for window in self.windows if not window.should_close])
+
+            for window in self.windows:
+                window.draw()
+
+            # Call frame update callback if set
+            if callback:
+                sig = inspect.signature(callback)
+                if len(sig.parameters) == 0:
+                    callback()
+                elif len(sig.parameters) == 1:
+                    callback(self)
+                else:
+                    raise TypeError(f"callback function must take 0 or 1 arguments, but {len(sig.parameters)} were given")
+
+            # Render ImGui and swap buffers
+            imgui.render()
+            self.renderer.render(imgui.get_draw_data())
+            glfw.swap_buffers(self.window)
+
+        # Cleanup on exit
+        self.renderer.shutdown()
+        glfw.terminate()
+
+    
+def run(
+        frame_ui,
+        callback=None,
+        title="New app",
+        width=800,
+        height=600,
+        theme="dark",
+        custom_font=False,
+        font_size=14,
+        cyrillic_ranges=True
+    ):
+    """
+    A minimalistic, easy-to-use function for creating and running an app.
+
+    Args:
+        frame_ui (function): The function to draw the main UI.
+        callback (function, optional): The function to call after drawing the UI. Defaults to None.
+        title (str, optional): The title of the application window. Defaults to "New app".
+        width (int, optional): The width of the application window. Defaults to 800.
+        height (int, optional): The height of the application window. Defaults to 600.
+        theme (str, optional): The name of the theme ("dark" or "light"). Defaults to "dark".
+        custom_font (bool or str, optional): The path to a custom font or True to use the default font or False to use build-in ImGui font. Defaults to False.
+        font_size (int, optional): The size of the font. Defaults to 14.
+        cyrillic_ranges (bool, optional): Whether to include Cyrillic character ranges. Defaults to True.
+    """
+
+    app = App(title, width, height)
+
+    if custom_font == True:
+        app.load_font(font_size=font_size, cyrillic_ranges=cyrillic_ranges)
+    elif type(custom_font) == str:
+        app.load_font(font_path=custom_font, font_size=font_size, cyrillic_ranges=cyrillic_ranges)
+
+    app.apply_theme(theme)
+    app.run(frame_ui, callback)

ara_imgui-1.0.0/src/ara_imgui/window.py

@@ -0,0 +1,95 @@
+import inspect
+import imgui
+
+class Window:
+    """
+    A class representing an ImGui window.
+
+    Attributes:
+        name (str): The title of the window.
+        flags (int): The flags for the window.
+        frame_ui (function): The function to draw the window's content.
+        should_close (bool): A flag indicating if the window should be closed.
+        _internal_id (int): The unique ID for the window.
+        next_size (tuple, None): The next size of the window.
+        next_pos (tuple, None): The next position of the window.
+    """
+    def __init__(self, title, flags=0, frame_ui=None):
+        """
+        Initializes the Window instance.
+
+        Args:
+            title (str): The title of the window.
+            flags (int, optional): The ImGui flags for the window. Defaults to 0.
+            frame_ui (function, optional): The function to draw the window's content. Defaults to None.
+        """
+        self.name = title
+        self.flags = flags
+        self.frame_ui = frame_ui
+        self.should_close = False
+        self._internal_id = id(self)
+        self.next_size = None
+        self.next_pos = None
+
+    
+    def set_frame_ui(self, frame_ui):
+        """
+        Sets the frame UI function for the window.
+
+        Args:
+            frame_ui (function): The function to draw the window's content.
+        """
+        self.frame_ui = frame_ui
+    
+
+    def set_size(self, width: int, height: int):
+        """
+        Sets the size of the window.
+
+        Args:
+            width (int): The width of the window.
+            height (int): The height of the window.
+        """
+        self.next_size = (width, height)
+
+
+    def set_pos(self, x, y):
+        """
+        Sets the position of the window.
+
+        Args:
+            x (int): The x-coordinate of the window.
+            y (int): The y-coordinate of the window.
+        """
+        self.next_pos = (x, y)
+
+
+    def draw(self):
+        """
+        Draws the window and its content.
+
+        This method sets the size and position of the window if they have been changed,
+        begins the ImGui window, and calls the frame UI function if it exists.
+        """
+        if self.next_size:
+            imgui.set_next_window_size(self.next_size[0], self.next_size[1])
+            self.next_size = None
+
+        if self.next_pos:
+            imgui.set_next_window_position(self.next_pos[0], self.next_pos[1])
+            self.next_pos = None
+
+        _, is_opened = imgui.begin(f"{self.name}##{self._internal_id}", True, flags = self.flags)
+
+        self.should_close = not is_opened
+
+        if self.frame_ui is not None:
+            sig = inspect.signature(self.frame_ui)
+            if len(sig.parameters) == 0:
+                self.frame_ui()
+            elif len(sig.parameters) == 1:
+                self.frame_ui(self)
+            else:
+                raise TypeError(f"frame_ui function must take 0 or 1 arguments, but {len(sig.parameters)} were given")
+
+        imgui.end()

ara_imgui-1.0.0/tests/test_basic.py

@@ -0,0 +1,8 @@
+# Test if the module can be imported
+def test_import():
+   import ara_imgui
+
+# Test if the module can be run
+def test_run_callable():
+   from ara_imgui import run
+   assert callable(run)