DearPyGui README

The project's README from github.com/hoffstadt/DearPyGui. As one markdown file: README.md.


Dear PyGui logo

A modern, fast and powerful GUI framework for Python

Python versions PYPI Downloads MIT License

static-analysis static-analysis Deployment Documentation Status

Features • Installation • How To Use • Demo • Resources • Support • Tech stack • Credits • License • Gallery


Themes

Features

        

        

Installation

Ensure you have at least Python 3.8 64bit.

pip install dearpygui
or
pip3 install dearpygui

How to use?

Using Dear PyGui is as simple as the following Python script.

import dearpygui.dearpygui as dpg

def save_callback():
    print("Save Clicked")

dpg.create_context()
dpg.create_viewport()
dpg.setup_dearpygui()

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

dpg.show_viewport()
dpg.start_dearpygui()
dpg.destroy_context()

Dear PyGui example window

Demo

The built-in demo shows all of Dear PyGui's functionality. To run the demo, you can run:

python -m dearpygui.demo

Or you can use this code to run the demo. The following impression shows a few, but not nearly all, of the available widgets and features. Since the Python code of the demo can be inspected, you can leverage the demo code to build your own apps.

Dear PyGui demo

Resources

Support

If you are having issues or want to help, here are some places you can go.

Chat on Discord       Reddit

Tech stack

Dear PyGui is built on top of Dear ImGui, including the ImPlot and imnodes extensions, and is fundamentally different than other Python GUI frameworks. Under the hood, it uses the immediate mode paradigm and your computer's GPU to facilitate extremely dynamic interfaces. 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. Dear PyGui is written in C/C++ resulting in highly performant Python applications. Dear PyGui is currently supported on the following platforms.

Platform Graphics API Newest Version
Windows 10 DirectX 11 PYPI
macOS Metal PYPI
Linux OpenGL 3 PYPI
Raspberry Pi 4 OpenGL ES PYPI

Credits

License

Dear PyGui is licensed under the MIT License.

Sponsor

Continued maintenance and development are a full-time endeavor which we would like to sustain and grow. Ongoing development is financially supported by users and private sponsors. If you enjoy Dear PyGui please consider becoming a sponsor or buy us a cup of coffee.

     

Plotting/Graphing

Dear PyGui includes a plotting API built with ImPlot

        

        

        

        

Node Editor

Dear PyGui includes a node editor built with imnodes

Canvas

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


BasicUsageExample

SAST Tools

PVS-Studio - static analyzer for C, C++, C#, and Java code.

DearPyGui (hoffstadt/DearPyGui)

Searching Database…

15.6K ·GitHub
What is this?Dear PyGui is a fast and powerful GUI toolkit for Python: you write Python code and get native desktop windows with widgets, plots and a node editor. A built-in demo app showcases all of it.
Is it a library I import into my Python scripts, or a separate app?It is a Python library — you install it into your Python environment and import it from your own script to build the GUI. The only separate app is the built-in demo, which exists to show off the toolkit.
How do I get it running?Make sure you have 64-bit Python 3.8 or newer, then install the dearpygui package (pip install dearpygui), import it in your script, and run the built-in demo to see everything in action.
Do I need anything besides Python to use it?Just 64-bit Python 3.8+ — dependencies are minimal. Performance comes from the C/C++ core and GPU-based rendering rather than extra packages.
Which platforms does it run on?Windows 10 (DirectX 11), macOS (Metal), Linux (OpenGL 3) and Raspberry Pi 4 (OpenGL ES) are officially supported.
What can it do out of the box?Complete theme and style control, GPU-rendered graphs that display over a million datapoints at 60 fps with zoom and pan, a node editor, a canvas drawing API for custom drawings, plots and even 2D games, asynchronous function support, and developer tools: theme and resource inspection, runtime metrics and a debugger.
Is there an easy way to learn it?Yes — the built-in demo shows all of Dear PyGui's functionality, and since the demo's Python source can be inspected, you can borrow its code for your own apps. The README also links docs, tutorials, a FAQ, best-practice snippets and showcase apps with source code.
Why did the authors build it?Dear ImGui gave game developers a simple way to create tools, and the authors wanted the same for Python: quick, powerful GUIs for scripts. It is developed by Jonathan Hoffstadt and Preston Cothren as a full-time endeavor funded by users and sponsors.
What are similar projects?imgui, Nuklear, kivy, slint, nuklear, shadPS4, mygo, bgfx
Creator
hoffstadt
Size
143.2 MB
Stars
15.6K
Age
6y
Commits · 90 Days