structui 0.2.0__tar.gz → 0.4.0__tar.gz

{structui-0.2.0 → structui-0.4.0}/PKG-INFO

@@ -1,62 +1,76 @@
-Metadata-Version: 2.4
-Name: structui
-Version: 0.2.0
-Summary: A format-agnostic, schema-driven, hierarchical configuration UI.
-Author: structui contributors
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Web Environment
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: nicegui>=1.4.0
-Requires-Dist: pyyaml>=6.0.1
-Requires-Dist: pywin32>=300; sys_platform == "win32"
-
-# StructUI
-
-[![PyPI version](https://img.shields.io/pypi/v/structui.svg)](https://pypi.org/project/structui/)
-[![CI](https://github.com/MoSaeedHammad/structui/actions/workflows/ci.yml/badge.svg)](https://github.com/MoSaeedHammad/structui/actions/workflows/ci.yml)
-[![CD](https://github.com/MoSaeedHammad/structui/actions/workflows/publish.yml/badge.svg)](https://github.com/MoSaeedHammad/structui/actions/workflows/publish.yml)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-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.
-
-## Installation
-
-### From PyPI (recommended)
-
-```bash
-pip install structui
-```
-
-### From Source (development)
-
-```bash
-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:
-
-```bash
-structui --dir . --schema .structui_schema.yaml --port 8080
-```
+Metadata-Version: 2.4
+Name: structui
+Version: 0.4.0
+Summary: A format-agnostic, schema-driven, hierarchical configuration UI.
+Author: structui contributors
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: nicegui>=1.4.0
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: pywin32>=300; sys_platform == "win32"
+
+# StructUI
+
+[![PyPI version](https://img.shields.io/pypi/v/structui.svg)](https://pypi.org/project/structui/)
+[![CI](https://github.com/MoSaeedHammad/structui/actions/workflows/ci.yml/badge.svg)](https://github.com/MoSaeedHammad/structui/actions/workflows/ci.yml)
+[![CD](https://github.com/MoSaeedHammad/structui/actions/workflows/publish.yml/badge.svg)](https://github.com/MoSaeedHammad/structui/actions/workflows/publish.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+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.
+
+## Installation
+
+### From PyPI (recommended)
+
+```bash
+pip install structui
+```
+
+### From Source (development)
+
+```bash
+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:
+
+```bash
+structui --dir . --schema .structui_schema.yaml --port 8080
+```
+
+## Testing
+
+To run the test suite and verify code coverage, first install the necessary development dependencies:
+
+```bash
+pip install -e . pytest pytest-cov pytest-asyncio pyyaml nicegui
+```
+
+Then, run `pytest` with coverage reporting:
+
+```bash
+PYTHONPATH=src python3 -m pytest tests/ --cov=structui --cov-report=term-missing
+```

{structui-0.2.0 → structui-0.4.0}/README.md

@@ -39,3 +39,17 @@ Launch the editor in the current directory against your local configuration file
 ```bash
 structui --dir . --schema .structui_schema.yaml --port 8080
 ```
+
+## Testing
+
+To run the test suite and verify code coverage, first install the necessary development dependencies:
+
+```bash
+pip install -e . pytest pytest-cov pytest-asyncio pyyaml nicegui
+```
+
+Then, run `pytest` with coverage reporting:
+
+```bash
+PYTHONPATH=src python3 -m pytest tests/ --cov=structui --cov-report=term-missing
+```

{structui-0.2.0 → structui-0.4.0}/pyproject.toml

@@ -1,36 +1,36 @@
-[build-system]
-requires = ["setuptools>=61.0"]
-build-backend = "setuptools.build_meta"
-
-[project]
-name = "structui"
-version = "0.2.0"
-description = "A format-agnostic, schema-driven, hierarchical configuration UI."
-readme = "README.md"
-authors = [
-    { name = "structui contributors" }
-]
-license = { text = "MIT" }
-requires-python = ">=3.9"
-dependencies = [
-    "nicegui>=1.4.0",
-    "pyyaml>=6.0.1",
-    "pywin32>=300; sys_platform == 'win32'"
-]
-classifiers = [
-    "Development Status :: 4 - Beta",
-    "Environment :: Web Environment",
-    "Intended Audience :: Developers",
-    "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12"
-]
-
-[project.scripts]
-structui = "structui.cli:main"
-
-[tool.setuptools.packages.find]
-where = ["src"]
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "structui"
+version = "0.4.0"
+description = "A format-agnostic, schema-driven, hierarchical configuration UI."
+readme = "README.md"
+authors = [
+    { name = "structui contributors" }
+]
+license = { text = "MIT" }
+requires-python = ">=3.9"
+dependencies = [
+    "nicegui>=1.4.0",
+    "pyyaml>=6.0.1",
+    "pywin32>=300; sys_platform == 'win32'"
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[project.scripts]
+structui = "structui.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

{structui-0.2.0 → structui-0.4.0}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

{structui-0.2.0 → structui-0.4.0}/src/structui/__init__.py

@@ -1,7 +1,7 @@
-"""StructUI - A format-agnostic, schema-driven, hierarchical configuration UI."""
-
-__version__ = "0.1.0"
-
-from .app import run_app
-
-__all__ = ["run_app"]
+"""StructUI - A format-agnostic, schema-driven, hierarchical configuration UI."""
+
+__version__ = "0.1.0"
+
+from .app import run_app
+
+__all__ = ["run_app"]

{structui-0.2.0 → structui-0.4.0}/src/structui/app.py

@@ -1,25 +1,25 @@
-from typing import Optional
-from nicegui import ui
-from structui.ui import StructUI
-from structui.state import AppState
-from structui.schema import SchemaManager
-
-def run_app(data_dir: str = ".", schema_filepath: str = ".structui_schema.yaml", port: int = 8080, dark_mode: Optional[bool] = False):
-    schema_manager = SchemaManager(schema_filepath)
-    try:
-        app_state = AppState(data_dir, schema_manager)
-        load_error = None
-    except Exception as e:
-        app_state = AppState(".", schema_manager)
-        app_state.config_data = {}
-        load_error = str(e)
-    
-    ui_instance = StructUI(app_state, schema_manager, dark_mode)
-    
-    @ui.page('/')
-    def main_page():
-        ui_instance.render()
-        if load_error:
-            ui.notify(f"XML/Config Load Error: {load_error}", type="negative", position="top", timeout=8000)
-            
-    ui.run(port=port, title="StructUI Editor", reload=False)
+from typing import Optional
+from nicegui import ui
+from structui.ui import StructUI
+from structui.state import AppState
+from structui.schema import SchemaManager
+
+def run_app(data_dir: str = ".", schema_filepath: str = ".structui_schema.yaml", port: int = 8080, dark_mode: bool = False):
+    schema_manager = SchemaManager(schema_filepath)
+    try:
+        app_state = AppState(data_dir, schema_manager)
+        load_error = None
+    except Exception as e:
+        app_state = AppState(".", schema_manager)
+        app_state.config_data = {}
+        load_error = str(e)
+    
+    ui_instance = StructUI(app_state, schema_manager, dark_mode)
+    
+    @ui.page('/')
+    def main_page():
+        ui_instance.render()
+        if load_error:
+            ui.notify(f"XML/Config Load Error: {load_error}", type="negative", position="top", timeout=8000)
+            
+    ui.run(port=port, title="StructUI Editor", reload=False)

{structui-0.2.0 → structui-0.4.0}/src/structui/cli.py

@@ -1,20 +1,20 @@
-import argparse
-import sys
-from structui.app import run_app
-
-def main():
-    parser = argparse.ArgumentParser(description="StructUI Configuration Editor")
-    parser.add_argument("--dir", type=str, default=".", help="Directory containing config files")
-    parser.add_argument("--schema", type=str, default=".structui_schema.yaml", help="Path to schema file")
-    parser.add_argument("--port", type=int, default=8080, help="Port to run the UI on (default: 8080)")
-    
-    args = parser.parse_args()
-    
-    try:
-        run_app(data_dir=args.dir, schema_filepath=args.schema, port=args.port)
-    except Exception as e:
-        print(f"Error starting StructUI: {e}", file=sys.stderr)
-        sys.exit(1)
-
-if __name__ in {"__main__", "__mp_main__"}:
-    main()
+import argparse
+import sys
+from structui.app import run_app
+
+def main():
+    parser = argparse.ArgumentParser(description="StructUI Configuration Editor")
+    parser.add_argument("--dir", type=str, default=".", help="Directory containing config files")
+    parser.add_argument("--schema", type=str, default=".structui_schema.yaml", help="Path to schema file")
+    parser.add_argument("--port", type=int, default=8080, help="Port to run the UI on (default: 8080)")
+    
+    args = parser.parse_args()
+    
+    try:
+        run_app(data_dir=args.dir, schema_filepath=args.schema, port=args.port)
+    except Exception as e:
+        print(f"Error starting StructUI: {e}", file=sys.stderr)
+        sys.exit(1)
+
+if __name__ in {"__main__", "__mp_main__"}:  # pragma: no cover
+    main()

{structui-0.2.0 → structui-0.4.0}/src/structui/file_picker.py

@@ -1,95 +1,100 @@
-import platform
-from pathlib import Path
-from typing import Optional
-
-from nicegui import events, ui
-
-
-class LocalFilePicker(ui.dialog):
-
-    def __init__(self, directory: str, *,
-                 upper_limit: Optional[str] = ..., multiple: bool = False, show_hidden_files: bool = False,
-                 dirs_only: bool = False) -> None:
-        """Local File Picker
-
-        This is a simple file picker that allows you to select a file from the local filesystem where NiceGUI is running.
-
-        :param directory: The directory to start in.
-        :param upper_limit: The directory to stop navigating up (e.g. the root directory).
-        :param multiple: Whether to allow multiple files to be selected.
-        :param show_hidden_files: Whether to show hidden files.
-        :param dirs_only: Whether to only show directories.
-        """
-        super().__init__()
-
-        self.path = Path(directory).expanduser().resolve()
-        if upper_limit is None:
-            self.upper_limit = None
-        else:
-            self.upper_limit = Path(directory if upper_limit == ... else upper_limit).expanduser().resolve()
-        self.show_hidden_files = show_hidden_files
-        self.dirs_only = dirs_only
-
-        with self, ui.card():
-            self.add_drives_toggle()
-            self.grid = ui.aggrid({
-                'columnDefs': [{'field': 'name', 'headerName': 'File'}],
-                'rowSelection': 'multiple' if multiple else 'single',
-            }, html_columns=[0]).classes('w-96').on('cellDoubleClicked', self.handle_double_click)
-            with ui.row().classes('w-full justify-end'):
-                ui.button('Cancel', on_click=self.close).props('outline')
-                ui.button('Ok', on_click=self._handle_ok)
-        self.update_grid()
-
-    def add_drives_toggle(self):
-        if platform.system() == 'Windows':
-            import win32api
-            drives = win32api.GetLogicalDriveStrings().split('\000')[:-1]
-            self.drives_toggle = ui.toggle(drives, value=drives[0], on_change=self.update_drive)
-
-    def update_drive(self):
-        self.path = Path(self.drives_toggle.value).expanduser()
-        self.update_grid()
-
-    def update_grid(self) -> None:
-        paths = list(self.path.iterdir())
-        if not self.show_hidden_files:
-            paths = [p for p in paths if not p.name.startswith('.')]
-        if self.dirs_only:
-            paths = [p for p in paths if p.is_dir()]
-        paths.sort(key=lambda p: p.name.lower())
-        paths.sort(key=lambda p: not p.is_dir())
-
-        self.grid.options['rowData'] = [
-            {
-                'name': f'📁 <strong>{p.name}</strong>' if p.is_dir() else p.name,
-                'path': str(p),
-            }
-            for p in paths
-        ]
-        if self.upper_limit is None or self.path != self.upper_limit:
-            self.grid.options['rowData'].insert(0, {
-                'name': '📁 <strong>..</strong>',
-                'path': str(self.path.parent),
-            })
-        self.grid.update()
-
-    def handle_double_click(self, e: events.GenericEventArguments) -> None:
-        self.path = Path(e.args['data']['path'])
-        if self.path.is_dir():
-            self.update_grid()
-        else:
-            self.submit([str(self.path)])
-
-    async def _handle_ok(self):
-        try:
-            rows = await self.grid.get_selected_rows()
-        except TimeoutError:
-            rows = []
-            
-        if rows:
-            self.submit([r['path'] for r in rows])
-        elif self.dirs_only:
-            self.submit([str(self.path)])
-        else:
-            ui.notify('No file selected.')
+import platform
+from pathlib import Path
+from typing import Optional
+
+from nicegui import events, ui
+
+
+class LocalFilePicker(ui.dialog):
+
+    def __init__(self, directory: str, *, allowed_extensions: Optional[list] = None,
+                 upper_limit: Optional[str] = None, multiple: bool = False, show_hidden_files: bool = False,
+                 dirs_only: bool = False) -> None:
+        """Local File Picker
+
+        This is a simple file picker that allows you to select a file from the local filesystem where NiceGUI is running.
+
+        :param directory: The directory to start in.
+        :param upper_limit: The directory to stop navigating up (e.g. the root directory).
+        :param multiple: Whether to allow multiple files to be selected.
+        :param show_hidden_files: Whether to show hidden files.
+        :param dirs_only: Whether to only show directories.
+        """
+        super().__init__()
+
+        self.path = Path(directory).expanduser().resolve()
+        if upper_limit is None:
+            self.upper_limit = None
+        else:
+            self.upper_limit = Path(directory if upper_limit == ... else upper_limit).expanduser().resolve()
+        self.show_hidden_files = show_hidden_files
+        self.dirs_only = dirs_only
+        self.allowed_extensions = allowed_extensions
+
+        with self, ui.card():
+            self.add_drives_toggle()
+            self.grid = ui.aggrid({
+                'columnDefs': [{'field': 'name', 'headerName': 'File'}],
+                'rowSelection': 'multiple' if multiple else 'single',
+            }, html_columns=[0]).classes('w-96').on('cellDoubleClicked', self.handle_double_click)
+            with ui.row().classes('w-full justify-end'):
+                ui.button('Cancel', on_click=self.close).props('outline')
+                ui.button('Ok', on_click=self._handle_ok)
+        self.update_grid()
+
+    def add_drives_toggle(self):
+        if platform.system() == 'Windows':
+            import win32api
+            drives = win32api.GetLogicalDriveStrings().split('\000')[:-1]
+            self.drives_toggle = ui.toggle(drives, value=drives[0], on_change=self.update_drive)
+
+    def update_drive(self):
+        self.path = Path(self.drives_toggle.value).expanduser()
+        self.update_grid()
+
+    def update_grid(self) -> None:
+        paths = list(self.path.iterdir())
+        if not self.show_hidden_files:
+            paths = [p for p in paths if not p.name.startswith('.')]
+        if self.dirs_only:
+            paths = [p for p in paths if p.is_dir()]
+        elif self.allowed_extensions:
+            allowed_exts = [ext.lower() if ext.startswith('.') else f'.{ext.lower()}' for ext in self.allowed_extensions]
+            paths = [p for p in paths if p.is_dir() or p.suffix.lower() in allowed_exts]
+        paths.sort(key=lambda p: p.name.lower())
+
+        paths.sort(key=lambda p: not p.is_dir())
+
+        self.grid.options['rowData'] = [
+            {
+                'name': f'📁 <strong>{p.name}</strong>' if p.is_dir() else p.name,
+                'path': str(p),
+            }
+            for p in paths
+        ]
+        if self.upper_limit is None or self.path != self.upper_limit:
+            self.grid.options['rowData'].insert(0, {
+                'name': '📁 <strong>..</strong>',
+                'path': str(self.path.parent),
+            })
+        self.grid.update()
+
+    def handle_double_click(self, e: events.GenericEventArguments) -> None:
+        self.path = Path(e.args['data']['path'])
+        if self.path.is_dir():
+            self.update_grid()
+        else:
+            self.submit([str(self.path)])
+
+    async def _handle_ok(self):
+        try:
+            rows = await self.grid.get_selected_rows()
+        except TimeoutError:
+            rows = []
+            
+        if rows:
+            self.submit([r['path'] for r in rows])
+        elif self.dirs_only:
+            self.submit([str(self.path)])
+        else:
+            ui.notify('No file selected.')