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
Что это такое?Dear PyGui — это быстрая и мощная библиотека для создания графических интерфейсов на Python: вы пишете код на Python и получаете нативные оконные приложения с виджетами, графиками и редактором нод. Встроенное демо показывает все возможности библиотеки.
Это библиотека, которую я импортирую в свои Python-скрипты, или отдельное приложение?Это библиотека для Python — вы устанавливаете её в своё окружение Python и импортируете из своего скрипта, чтобы построить интерфейс. Единственное отдельное приложение — встроенное демо, которое существует специально для демонстрации возможностей библиотеки.
Как его запустить?Убедитесь, что у вас 64-битный Python 3.8 или новее, установите пакет dearpygui (pip install dearpygui), импортируйте его в своём скрипте и запустите встроенное демо, чтобы увидеть всё в действии.
Нужно ли что-то ещё, кроме Python?Только 64-битный Python 3.8+ — зависимостей минимум. Производительность обеспечивается ядром на C/C++ и рендерингом через GPU, а не дополнительными пакетами.
На каких платформах он работает?Официально поддерживаются Windows 10 (DirectX 11), macOS (Metal), Linux (OpenGL 3) и Raspberry Pi 4 (OpenGL ES).
Что он умеет из коробки?Полный контроль над темами и стилями, графики с рендерингом на GPU, которые отображают более миллиона точек данных при 60 fps с зумом и панорамированием, редактор нод, API для рисования на канвасе — собственных рисунков, графиков и даже 2D-игр, поддержка асинхронных функций, а также инструменты разработчика: инспекция тем и ресурсов, метрики времени выполнения и отладчик.
Есть ли простой способ его освоить?Да — встроенное демо показывает все возможности Dear PyGui, а поскольку исходный код демо на Python доступен для просмотра, вы можете заимствовать его код для своих приложений. В README также есть ссылки на документацию, туториалы, FAQ, примеры лучших практик и приложения-примеры с исходным кодом.
Почему авторы его создали?Dear ImGui дал разработчикам игр простой способ создавать инструменты, и авторы хотели того же для Python: быстрые и мощные GUI для скриптов. Разработкой занимаются Джонатан Хоффштадт (Jonathan Hoffstadt) и Престон Котрин (Preston Cothren), для которых это работа на полный день, финансируемая пользователями и спонсорами.
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