Skip to main content

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

Project description

Duit (Data UI Toolkit)

Documentation PyPI Github

Duit is a Python library that provides a set of tools for working with data in a structured and efficient way. The goal of duit is to make it easy for developers to create and manage data models and create simple user interfaces for data entry and display. The implementation is based on the ideas of cansik/bildspur-base and cansik/bildspur-ui.

gui-demo

Example UI rendered with Open3D (left) and tkinter (right).

Features

  • Data Modeling: duit provides a flexible data modeling framework to create structured data models and fields.

  • Annotations: Use annotations to attach metadata to data fields, making it easier to work with them.

  • Command-line Arguments: Easily parse and configure command-line arguments in your applications based on data fields.

  • Settings Serialization: Serialize and deserialize settings from data fields to and from json.

  • User Interface: Create simple user-interfaces for data fields.

Installation

By default, only the data modeling, annotation, arguments and settings modules are installed.

pip install duit

To support user interface creation for data fields, one of the following backends can be installed:

  • open3d - Cross platform UI framework with support for 3d visualisation.
  • tkinter - More stable UI framework, currently not feature complete.

At the moment open3d is the recommended choice as gui backend.

pip install "duit[open3d]"

To install tkinter use the following command:

pip install "duit[tkinter]"

To install duit with all backends call pip like this:

pip install "duit[all]"

Example

This is a very basic example on how to use duit. Read to documentation for a more information about the core concepts.

import argparse

from open3d.visualization import gui

from duit import ui
from duit.arguments.Argument import Argument
from duit.arguments.Arguments import DefaultArguments
from duit.model.DataField import DataField
from duit.settings.Settings import DefaultSettings
from duit.ui.ContainerHelper import ContainerHelper
from duit.ui.open3d.Open3dPropertyPanel import Open3dPropertyPanel
from duit.ui.open3d.Open3dPropertyRegistry import init_open3d_registry


class Config:
    def __init__(self):
        container_helper = ContainerHelper(self)

        with container_helper.section("User"):
            self.name = DataField("Cat") | ui.Text("Name")
            self.age = DataField(21) | ui.Slider("Age", limit_min=18, limit_max=99)

        with container_helper.section("Application"):
            self.enabled = DataField(True) | ui.Boolean("Enabled") | Argument()


def main():
    # create initial config
    config = Config()

    # register a custom listener for the enabled flag
    config.enabled.on_changed += lambda e: print(f"Enabled: {e}")

    # add arguments and parse
    parser = argparse.ArgumentParser()
    args = DefaultArguments.add_and_configure(parser, config)

    # store current config
    DefaultSettings.save("config.json", config)

    # create open3d gui for to display config
    init_open3d_registry()

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

    window: gui.Window = gui.Application.instance.create_window("Demo Window", 400, 200)
    panel = Open3dPropertyPanel(window)
    window.add_child(panel)
    panel.data_context = config

    app.run()


if __name__ == "__main__":
    main()

Which results in the following GUI.

example-window

Development

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

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

Generate Documentation

# create documentation into "./docs
python setup.py doc

# launch pdoc webserver
python setup.py doc --launch

About

MIT License - Copyright (c) 2023 Florian Bruggisser

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

duit-0.1.9.1-py3-none-any.whl (71.9 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page