shalevy1 / dearpygui

DearPyGui: A GPU Accelerated Python GUI Framework

_{(This library is available under a free and permissive license)}

Dear PyGui is a simple to use (but powerful) Python GUI framework. DearPyGui provides a wrapping of DearImGui that provides a hybrid of a traditional retained mode GUI and Dear ImGui's immediate mode paradigm.

Dear PyGui is fundamentally different than other Python GUI frameworks. Under the hood, DearPyGui uses the immediate mode paradigm allowing for extremely dynamic interfaces. DearPyGui does not use native widgets, but instead draws the widgets using your computer's GPU. DearPyGui is currently supported on the following platforms:

Platform	Rendering API
Windows 10	DirectX 11
macOs	Metal
Linux	OpenGL3

In the same manner Dear ImGui provides a simple way to create tools for game developers, DearPyGui provides a simple way for python developers to create quick and powerful GUIs for scripts.

Installing - Usage - Features - Support - Building
Upcoming changes - Gallery - Credits - License

Installing

---

Ensure you have at least Python 3.7.

pip install dearpygui
or
pip3 install dearpygui

Usage

---

DearPyGui is an all included GUI framework. A variety of examples demonstrating usage can be found in the Examples folder /Examples. To get started checkout the Tutorials and for all other references visit the Documentation or from within the library by using the show_documentation command.

Using DearPyGui is a simple as creating a python script like the one below:

Code:

from dearpygui.dearpygui import *

add_text("Hello world")
add_button("Save", callback="save_callback")
add_input_text("string")
add_slider_float("float")

def save_callback(sender, data):
    print("Save Clicked")

start_dearpygui()

Result:

Some Features

---

Plotting/Graphing

DearPyGui includes a plotting API (ImPlot Wrapping)

Themes

DearPyGui currently includes 10 themes and you can create your own:

Canvas

DearPyGui includes a drawing API to create custom drawings, plot, and even 2D games.

Tools

DearPyGui includes several tools to help developers with DearPyGui app development including built-in documentation, logging, source viewer, and other tools:

Support

If you are having issues or want to help or ask for ways you can help, here are some places you can go!

• Github Forum
• Discord Forum
• Reddit

Building

The actual builds of DearPyGui are created through github actions however, to develop and test locally, follow the instructions below. These are not well maintained at the moment and could use some work.

---

Windows 10

Build Requirements

• Visual Studio 2019 (windows) with the following workloads:
  • Python development
  • Desktop development with C++
  • Game development with C++
• git
• Python 3.7 or 3.8

Instructions

1. From within a local directory, enter the following bash commands:

git clone --recursive https://github.com/RaylockLLC/DearPyGui

2. Open the Scripts folder and run the BuildFor32.bat file (or BuildFor64.bat if using 64-bit python).

Linux

_{Only tested on Ubuntu 20.04}

Build Requirements

• cmake
• Python 3.7 or 3.8
• xorg-dev

Instructions

1. From within a local directory, enter the following bash commands:

git clone --recursive https://github.com/hoffstadt/DearPyGui

2. Open the Scripts folder.
3. Open the terminal and type the following commands:

chmod +x BuildForLinux.sh
sudo ./BuildForLinux.sh

Upcoming Changes

---

Some upcoming features:

• An object oriented interface
• Additional Plot types (bar graph, pie chart, etc.)
• Support for window docking and multiple viewports.
• 3D widget.
• Custom Widget API.

Credits

---

Developed by Jonathan Hoffstadt, Preston Cothren, and every direct or indirect contributor.

Omar Cornut for all his incredible work on Dear ImGui.

Evan Pezent for all his work on ImPlot

Aiekick for his work on the ImGuiFileDialog

Gallery

---

License

---

DearPyGui is licensed under the MIT License.