duit 0.1.8.1

Duit is a toolkit to create simple user-interfaces for python.

Duit (Data UI Toolkit)

Duit is a toolkit to create simple user-interfaces for python. It is based on the ideas of cansik/bildspur-base and cansik/bildspur-ui.

Example UI rendered with Open3D

Installation

To install duit with all dependencies call pip like this:

pip install "duit[all]"

It is also possible to only install certain packages (for example only Open3D):

pip install "duit[open3d]"

Example

To create a gui by code, create a new class with the data-fields you need.

from examples.Color import Color
from duit.model.DataField import DataField
import duit.ui as ui

class Config:
    def __init__(self):
        self.hungry = DataField(True) | ui.Boolean("Hungry")
        self.year = DataField(2021) | ui.Number("Year", 2000, 2050)
        self.temperature = DataField(30.2) | ui.Slider("Temperature", 0, 40)
        self.resolution = DataField(256) | ui.Options("Resolution", [64, 128, 256, 512, 1024])
        self.color = DataField(Color.White) | ui.Enum("Color")
        self.name = DataField("Test") | ui.Text("Name", readonly=True)

And use the open3d gui package to display them:

init_open3d_registry()

config = Config()
config.age.value = 10

app = o3d.visualization.gui.Application.instance
app.initialize()

win = DemoWindow(config)

app.run()

Settings

To save and load settings have a look at the following example. Serialization from and to json is automatically handled by duit.

config = Config()
settings = Settings()

settings.save("test.json", config)
settings.load("test.json", config)

Development

To develop it is recommended to clone this repository and install the dependencies like this:

# in the duit directory
pip install -e ".[all]"

About

MIT License - Copyright (c) 2023 Florian Bruggisser