structui 0.5.0

A format-agnostic, schema-driven, hierarchical configuration UI.

StructUI

StructUI is a format-agnostic, schema-driven, hierarchical configuration UI engine built in Python. Designed as a flexible architectural backbone, it parses standard configuration files (YAML, JSON, CSV, XML) and dynamically generates a live web-based property editor based on constraints and metadata defined in a schema file.

The architecture is explicitly decoupled, making it readily extensible to strict domain-specific specifications (e.g., AUTOSAR configurators) and agent-driven programmatic workflows.

Features

• Pillar A: Format-Agnostic Parsers: cleanly separate UI generation from underlying data formats. Out-of-the-box support for YAML, JSON, and XML (including schema-driven arrays and attributes), with abstract base classes extensible to CSV and others.
• Pillar B: Hierarchical UI: Dynamic tree-based rendering with full support for multidimensional containers, dynamic polymorphic list additions, and node mapping. Powered natively by NiceGUI.
• Pillar C: Data Validity: Enforces schema metadata strictly at the UI layer. Missing fields gracefully populate via defaults, required flags trigger locking, and nested typings are continuously evaluated.
• Pillar D: Extensibility & Programmatic Control: Decomposed core logic (App, Parser, State, Schema, UI) allowing external tools and wrappers (e.g. CLI, Agent Workflows) to invoke the editor or inject properties safely.
• Hex/Decimal Toggling: Automatically detects and preserves hex formatting (0x...) loaded from YAML configurations. Supports inline format toggling between hex and decimal, with validation logic to restrict inputs to valid hex formats and enforce platform/64-bit size limits.

Installation

From PyPI (recommended)

pip install structui

From Source (development)

git clone https://github.com/MoSaeedHammad/structui.git
cd structui
pip install -e .

Quick Start

Launch the editor in the current directory against your local configuration files by simply typing:

structui --dir . --schema .structui_schema.yaml --port 8080

Testing

To run the test suite and verify code coverage, first install the necessary development dependencies:

pip install -e . pytest pytest-cov pytest-asyncio pyyaml nicegui

Then, run pytest with coverage reporting:

PYTHONPATH=src python3 -m pytest tests/ --cov=structui --cov-report=term-missing