Building For Development

Windows

Requirements

• git
• Visual Studio 2019 (windows) with the following workflows:
  • Python development
  • Desktop development with C++
  • Game development with C++

Instructions:

1. From within a local directory, enter the following bash commands:

git clone --recursive https://github.com/hoffstadt/DearPyGui

3. Open the Scripts folder and run the BuildPythonForWindows.bat file.
4. In Visual Studio, use Open a local folder to open Dear PyGui folder. This will use CMakeLists.txt as the project file.
5. Run Build All.

Linux

Requirements

• git
• cmake
• xorg-dev
• libglu1-mesa-dev
• libgl1-mesa-dev
• libxrandr-dev
• build-essential

Instructions:

1. From within a local directory, enter the following bash commands:

git clone --recursive https://github.com/hoffstadt/DearPyGui

2. From the terminal, enter the Scripts folder and run the following bash commands:

chmod +x BuildPythonForLinux.sh
./BuildPythonForLinux.sh

3. Then from within the DPG root directory, build with cmake:

mkdir cmake-build-debug
cd cmake-build-debug
cmake ..
cd ..
cmake --build cmake-build-debug --config Debug

MacOS

Requirements

• git
• cmake
• XCode
• harfbuzz

Instructions:

1. From within a local directory, enter the following bash commands:

git clone --recursive https://github.com/hoffstadt/DearPyGui

2. From the terminal, enter the Scripts folder and run the following bash commands:

chmod +x BuildPythonForMac.sh
./BuildPythonForMac.sh

3. Then from within the DPG root directory, build with cmake:

mkdir cmake-build-debug
cd cmake-build-debug
cmake ..
cd ..
cmake --build cmake-build-debug --config Debug

---

DearSandbox

DearSandbox is the embedded version of Python used for developing.