Install for Python - Dear ImGui Bundle

Install from pypi¶

# Minimal install
pip install imgui-bundle

# or to get all optional features:
pip install "imgui-bundle[full]"

Binary wheels are available for Windows, macOS and Linux. If a compilation from source is needed, the build process might take up to 5 minutes, and will require an internet connection.

Platform notes

Windows: Under windows, you might need to install the msvc redist
macOS : under macOS, if a binary wheel is not available (e.g. for older macOS versions), pip will try to compile from source. This might fail if you do not have XCode installed. In this case, install imgui-bundle with the following command SYSTEM_VERSION_COMPAT=0 pip install --only-binary=:all: imgui_bundle

Install from source¶

# Clone the repository
git clone https://github.com/pthom/imgui_bundle.git
cd imgui_bundle

# Build and install the package (minimal install)
pip install -v .

# or build and install the package with all optional features:
#     pip install -v ".[full]"

The build process might take up to 5 minutes, and will clone the submodules if needed (an internet connection is required).

Run the python demo¶

The demo needs the optional features: after a minimal install, it stops at start (“Dear ImGui Bundle Explorer requires numpy!”).

pip install "imgui-bundle[full]"
imgui_bundle_demo

The source for the demos can be found inside bindings/imgui_bundle/demos_python.

TIP: Consider imgui_bundle_demo as an always available manual for Dear ImGui Bundle with lots of examples and related code source.

Next Steps¶

Dear ImGui Basics – Learn ImGui concepts (widgets, IDs, patterns)
Hello ImGui & ImmApp – App runners, configuration, DPI handling
Python Tips – Context managers, C++ to Python translation, debugging
Assets – Managing fonts, images, and resources