akaroka / DearPyGui

Dear PyGui: A fast and powerful Graphical User Interface Toolkit for Python with minimal dependencies

_{(This library is available under a free and permissive license however, if you Enjoy Dear PyGui please consider becoming a Sponsor)}

Dear PyGui is a simple to use (but powerful) Python GUI framework. Dear PyGui is NOT a wrapping of Dear ImGui in the normal sense. It is a library built with Dear ImGui which simulates a traditional retained mode GUI (as opposed to Dear ImGui's immediate mode paradigm).

Dear PyGui is fundamentally different than other Python GUI frameworks. Under the hood, Dear PyGui uses the immediate mode paradigm and your computer's GPU to facilitate extremely dynamic interfaces. Dear PyGui is currently supported on the following platforms:

Platform	Rendering API	Newest Version
Windows 10	DirectX 11
macOs	Metal
Linux	OpenGL 3
Raspberry Pi 4	OpenGL ES

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

Installing - Usage - Resources - Support
Features - Sponsors - Credits - License

Installation

---

Ensure you have at least Python 3.6 64bit.

pip install dearpygui
or
pip3 install dearpygui

Resources

---

• Documentation comprehensive documentaion, tutorials, and examples.
• Development Roadmap future features and changes.
• Internal Documentation: Run the show_documentation command from within the library to view an reference guide.
• Complete Demo: You can also view a mostly complete showcase of Dear PyGui by running the show_demo command found in dearpygui.demo.

Usage

---

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

Code:

from dearpygui import core, simple

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

with simple.window("Example Window"):
    core.add_text("Hello world")
    core.add_button("Save", callback=save_callback)
    core.add_input_text("string")
    core.add_slider_float("float")

core.start_dearpygui()

Result:

Some Features

---

Plotting/Graphing

Dear PyGui includes a plotting API (ImPlot Wrapping)

Node Editor

Dear PyGui includes a node editor API (imnodes Wrapping)

Themes

Dear PyGui currently includes 10 themes and you can create your own:

Canvas

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

Tools

Dear PyGui 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, here are some places you can go:

• Github Discussions
• Discord Forum
• Reddit

Sponsors

---

If you enjoy Dear PyGui please consider becoming a sponsor.

Ongoing Dear PyGui development is financially supported by users and private sponsors.

These include:

• 🏆 Tkachenko Igor Partner Sponsor
• 🏆 Dean Keinan Partner Sponsor
• 🏆 何凌锋 Partner Sponsor
• 🏆 Nikki Luzader Partner Sponsor
• 🏆 Ray Heasman Partner Sponsor
• 🥇 Caden Bloxham Gold Sponsor
• 🥇 Michael Kadziela Gold Sponsor
• 🥇 Yan Zaretskiy Gold Sponsor
• 🥇 Trinnik Gold Sponsor
• 🥇 Anthony Doupe Gold Sponsor
• 🥇 Derek Barker Gold Sponsor

Thank you to all other sponsors for keeping this project moving forward!

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

Johann Muszynski for all of his work on imnodes

License

---

Dear PyGui is licensed under the MIT License.