Registry / web-framework / dpgui

dpgui

JSON →

library1.0.1pypypi✓ verified 89d ago

A web-based GUI for user inputs, built on top of Dear PyGui. Version 1.0.1, maintenance mode with infrequent releases.

web-framework http-networking

pip install dpgui

github ↗package ↗

INSTALL

IMPORT

SIG · DPGUI

dpgui

web-frameworkpythonv1.0.1

Install

2.2s avg

Import

680ms

Disk

27MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.728s · 28.8MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.2s · import 0.632s · 29MB

27MB installed

● package 27MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

✓ import dpgui as dp

✗ from dpgui import *

Using wildcard imports is discouraged; use the module alias 'dp' for clarity.

start

✓ import dpgui as dp; dp.start()

✗ from dpgui.start import start

start is a function in the dpgui module, not a submodule.

Creates a simple web GUI with a text input field and displays the submitted value.

import dpgui as dp def callback(values): print('User input:', values) dp.start(callback=callback, title='My App', fields=[{'name': 'name', 'type': 'text', 'label': 'Your Name'}])

Debug

Known issues

breakingdpgui 1.0.0 changed the API: the `start` function no longer accepts a `port` argument; use environment variable `DPGUI_PORT` or modify source.

fix

Set the port via `os.environ['DPGUI_PORT'] = '8080'` before calling `start()`.

affects: >=1.0.0

deprecatedThe `fields` parameter in `start()` expects 'name', 'type', 'label' keys; using 'id' instead of 'name' is deprecated and will be removed in 2.0.

fix

Use 'name' as the key for field identifiers.

affects: <=1.0.1

gotchadpgui requires Dear PyGui to be installed. If you install dpgui without dearpygui, it will fail at runtime.

fix

Install dearpygui via `pip install dearpygui`.

affects: all

gotchaThe web GUI runs on localhost only by default. To expose it to other machines, you must set `DPGUI_HOST` environment variable to '0.0.0.0'.

fix

Set `os.environ['DPGUI_HOST'] = '0.0.0.0'` before running `start()`.

affects: all

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'dearpygui'

dpgui depends on dearpygui but does not install it automatically.

fix

Run `pip install dearpygui`.

TypeError: start() got an unexpected keyword argument 'port'

The 'port' argument was removed in v1.0.0; set via environment variable instead.

fix

Use `os.environ['DPGUI_PORT'] = '8080'` before calling `dp.start()`.

ValueError: Unknown field key: 'id'

The field definition key 'id' was renamed to 'name' in v1.0.0.

fix

Change 'id' to 'name' in the field dictionary.

Upgrade

Version history

1.0.1latest on PyPI · released Nov 17, 2024

Audit

Dependencies

dearpyguirequiredCore dependency for the GUI backend.

Agent activity

20 hits · last 30 days

node

Bingbot

OpenAI (training)

Resources

githubhttps://github.com/deepmodeling/dpgui ↗

packagehttps://pypi.org/project/dpgui/ ↗