streamlit-flexnav 0.1.0__tar.gz

streamlit_flexnav-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nednaz-IT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

streamlit_flexnav-0.1.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: streamlit-flexnav
+Version: 0.1.0
+Summary: Navigation toolkit, menu schema, and Streamlit integration
+Author-email: Nednaz-IT <informatie@nednazit.nl>
+License: MIT
+Project-URL: Homepage, https://github.com/informatie/streamlit-flexnav
+Project-URL: Source, https://github.com/informatie/streamlit-flexnav
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: streamlit>=1.53.1
+Requires-Dist: structlog>=25.5.0
+Requires-Dist: typer>=0.21.1
+Dynamic: license-file
+
+# streamlit-flexnav
+
+A modular, schema‑driven navigation framework for Streamlit applications.  
+`streamlit-flexnav` provides a clean, extensible way to define menus, pages, roles, and navigation behavior using YAML/JSON schemas — with automatic UI rendering, access control, and a powerful plugin‑ready architecture.
+- [streamlit-flexnav](#streamlit-flexnav)
+  - [✨ Features](#-features)
+  - [📦 Installation](#-installation)
+  - [🚀 Quick Start](#-quick-start)
+    - [1. Create a menu schema (`menu.yaml`)](#1-create-a-menu-schema-menuyaml)
+    - [2. Load and register the schema](#2-load-and-register-the-schema)
+  - [🧭 Navigation Behavior](#-navigation-behavior)
+  - [⚙️ Configuration](#️-configuration)
+  - [🛠 CLI Tools](#-cli-tools)
+  - [📁 Project Structure](#-project-structure)
+  - [🧪 Development](#-development)
+  - [📄 License](#-license)
+  - [⭐ Acknowledgements](#-acknowledgements)
+  - [](#)
+
+---
+
+## ✨ Features
+
+- **Schema‑driven navigation** (YAML/JSON)
+- **Automatic Streamlit UI rendering**
+- **Role‑based access control**
+- **Menu groups, pages, icons, and metadata**
+- **Configurable sidebar behavior**
+- **CLI tools for debugging, linting, and fixing schemas**
+- **Plugin‑friendly architecture**
+- **Fast, reproducible builds using uv**
+
+---
+
+## 📦 Installation
+
+Install from PyPI:
+```
+pip install streamlit-flexnav
+```
+Or using uv:
+```
+uv add streamlit-flexnav
+```
+
+---
+## 🚀 Quick Start 
+### 1. Create a menu schema (`menu.yaml`)
+### 2. Load and register the schema
+
+## 🧭 Navigation Behavior
+Navigator automatically:<br>
+    Renders menu groups and pages<br>
+    Applies role‑based access control<br>
+    Highlights the active page<br>
+    Supports icons, dividers, and collapsible groups<br>
+    Integrates seamlessly with Streamlit’s session state
+
+---
+## ⚙️ Configuration
+
+```
+TODO
+menu settings
+Page settings
+```
+## 🛠 CLI Tools
+After installation, the CLI becomes available:<br>
+streamlit-flexnav
+```
+Command   	Description
+doctor	    Diagnose common configuration issues
+fix-keys    Normalize schema keys
+debug-paths	Show resolved paths
+linter	    Validate schema structure
+startup-checks	Run environment checks
+```
+
+## 📁 Project Structure
+src/streamlit_flexnav/
+  core/          # Loaders, registries, settings, schema logic
+  ui/            # Streamlit UI components
+  tools/         # CLI tools
+  configs/       # Default configuration files
+  images/        # Icons and static assets
+  menupages/     # Built-in menu pages
+
+See API_REFERENCE.md for full details.
+
+## 🧪 Development
+Clone the repository:
+```
+git clone https://github.com/informatie/streamlit-flexnav
+cd streamlit-flexnav
+```
+Set up the environment:
+```
+uv venv
+uv sync
+source .venv/bin/activate
+```
+## 📄 License
+MIT License — see LICENSE for details.
+
+## ⭐ Acknowledgements
+If you want, I can also generate:
+
+TODO
+
+Just tell me which one you want next.
+
+## 

streamlit_flexnav-0.1.0/README.md

@@ -0,0 +1,112 @@
+# streamlit-flexnav
+
+A modular, schema‑driven navigation framework for Streamlit applications.  
+`streamlit-flexnav` provides a clean, extensible way to define menus, pages, roles, and navigation behavior using YAML/JSON schemas — with automatic UI rendering, access control, and a powerful plugin‑ready architecture.
+- [streamlit-flexnav](#streamlit-flexnav)
+  - [✨ Features](#-features)
+  - [📦 Installation](#-installation)
+  - [🚀 Quick Start](#-quick-start)
+    - [1. Create a menu schema (`menu.yaml`)](#1-create-a-menu-schema-menuyaml)
+    - [2. Load and register the schema](#2-load-and-register-the-schema)
+  - [🧭 Navigation Behavior](#-navigation-behavior)
+  - [⚙️ Configuration](#️-configuration)
+  - [🛠 CLI Tools](#-cli-tools)
+  - [📁 Project Structure](#-project-structure)
+  - [🧪 Development](#-development)
+  - [📄 License](#-license)
+  - [⭐ Acknowledgements](#-acknowledgements)
+  - [](#)
+
+---
+
+## ✨ Features
+
+- **Schema‑driven navigation** (YAML/JSON)
+- **Automatic Streamlit UI rendering**
+- **Role‑based access control**
+- **Menu groups, pages, icons, and metadata**
+- **Configurable sidebar behavior**
+- **CLI tools for debugging, linting, and fixing schemas**
+- **Plugin‑friendly architecture**
+- **Fast, reproducible builds using uv**
+
+---
+
+## 📦 Installation
+
+Install from PyPI:
+```
+pip install streamlit-flexnav
+```
+Or using uv:
+```
+uv add streamlit-flexnav
+```
+
+---
+## 🚀 Quick Start 
+### 1. Create a menu schema (`menu.yaml`)
+### 2. Load and register the schema
+
+## 🧭 Navigation Behavior
+Navigator automatically:<br>
+    Renders menu groups and pages<br>
+    Applies role‑based access control<br>
+    Highlights the active page<br>
+    Supports icons, dividers, and collapsible groups<br>
+    Integrates seamlessly with Streamlit’s session state
+
+---
+## ⚙️ Configuration
+
+```
+TODO
+menu settings
+Page settings
+```
+## 🛠 CLI Tools
+After installation, the CLI becomes available:<br>
+streamlit-flexnav
+```
+Command   	Description
+doctor	    Diagnose common configuration issues
+fix-keys    Normalize schema keys
+debug-paths	Show resolved paths
+linter	    Validate schema structure
+startup-checks	Run environment checks
+```
+
+## 📁 Project Structure
+src/streamlit_flexnav/
+  core/          # Loaders, registries, settings, schema logic
+  ui/            # Streamlit UI components
+  tools/         # CLI tools
+  configs/       # Default configuration files
+  images/        # Icons and static assets
+  menupages/     # Built-in menu pages
+
+See API_REFERENCE.md for full details.
+
+## 🧪 Development
+Clone the repository:
+```
+git clone https://github.com/informatie/streamlit-flexnav
+cd streamlit-flexnav
+```
+Set up the environment:
+```
+uv venv
+uv sync
+source .venv/bin/activate
+```
+## 📄 License
+MIT License — see LICENSE for details.
+
+## ⭐ Acknowledgements
+If you want, I can also generate:
+
+TODO
+
+Just tell me which one you want next.
+
+## 

streamlit_flexnav-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+# --------------------------------------------------------------------
+# Patch: bugfix → 0.1.1
+# Minor: new features → 0.2.0
+# Major: breaking changes → 1.0.0
+# --------------------------------------------------------------------
+[project]
+name = "streamlit-flexnav"
+version = "0.1.0"
+description = "Navigation toolkit, menu schema, and Streamlit integration"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+
+authors = [
+    { name = "Nednaz-IT", email = "informatie@nednazit.nl" }
+]
+
+dependencies = [
+    "python-dotenv>=1.0.0",
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+    "streamlit>=1.53.1",
+    "structlog>=25.5.0",
+    "typer>=0.21.1",
+]
+
+[project.scripts]
+streamlit-flexnav = "streamlit_flexnav.tools.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/informatie/streamlit-flexnav"
+Source = "https://github.com/informatie/streamlit-flexnav"
+
+[tool.hatch.build.targets.wheel]
+packages = ["streamlit_flexnav"]
+sources = ["src"]
+
+[tool.hatch.build]
+include = [
+    "src/streamlit_flexnav/**/*",
+]

streamlit_flexnav-0.1.0/setup.cfg

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

streamlit_flexnav-0.1.0/src/streamlit_flexnav/__init__.py

@@ -0,0 +1,10 @@
+"""
+streamlit-flexnav
+-----------------
+A navigation toolkit, menu schema, and Streamlit integration layer.
+"""
+from .ui.navigator import render_navigation
+
+__all__ = [
+    "render_navigation",
+]

streamlit_flexnav-0.1.0/src/streamlit_flexnav/cli.py

@@ -0,0 +1,2 @@
+def main():
+    print("FlexNav CLI is running")

streamlit_flexnav-0.1.0/src/streamlit_flexnav/configs/__init__.py

@@ -0,0 +1,2 @@
+# flexnav/configs/__init__.py
+# Generated: 2026-01-31 • Version 0.1.0

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/__init__.py

@@ -0,0 +1,2 @@
+# flexnav/core/__init__.py
+# Generated: 2026-01-31 • Version 0.1.0

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/loader.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import importlib.util
+import sys
+from pathlib import Path
+import structlog
+
+from streamlit_flexnav.core.settings import MENUPAGES_ROOT
+from streamlit_flexnav.core.models.menustruct import MenuStruct
+from streamlit_flexnav.core.models.menugroup import MenuGroup
+
+log = structlog.get_logger().bind(component="loader")
+
+
+def _load_module_from_path(path: Path):
+    spec = importlib.util.spec_from_file_location(path.stem, path)
+    module = importlib.util.module_from_spec(spec)
+    sys.modules[path.stem] = module
+    spec.loader.exec_module(module)
+    return module
+
+
+def load_menupages() -> list[MenuStruct]:
+    """
+    Scan MENUPAGES_ROOT for .py files and extract PAGE = MenuStruct(...) definitions.
+    Folder structure is flattened into a single group name:
+        folder1/folder2/folder3 → "folder1_folder2_folder3"
+    """
+    results: list[MenuStruct] = []
+
+    for file in MENUPAGES_ROOT.rglob("*.py"):
+        if file.name.startswith("_"):
+            continue
+
+        try:
+            module = _load_module_from_path(file)
+
+            if not hasattr(module, "PAGE"):
+                log.warning("missing_PAGE_struct", file=str(file))
+                continue
+
+            page_struct = module.PAGE
+
+            if not isinstance(page_struct, MenuStruct):
+                log.error("invalid_PAGE_type", file=str(file))
+                continue
+
+            # Inject absolute path
+            page_struct.path = str(file.resolve())
+
+            # Compute flattened group name
+            relative = file.relative_to(MENUPAGES_ROOT)
+            parts = relative.parts[:-1]  # folders only
+
+            group = "_".join(parts) if parts else None
+            page_struct.group = group
+
+            results.append(page_struct)
+
+        except Exception as e:
+            log.exception("failed_loading_page", file=str(file), error=str(e))
+
+    log.info("menupages_loaded", count=len(results))
+    return results
+
+
+
+def load_menugroups() -> list[MenuGroup]:
+    """
+    Discover all MenuGroup definitions under MENUPAGES_ROOT.
+
+    Expected pattern inside each module:
+        MENU = MenuGroup(...)
+    """
+    results: list[MenuGroup] = []
+
+    for file in MENUPAGES_ROOT.rglob("*.py"):
+        if not file.name.startswith("__menu__"):
+            continue
+
+        try:
+            module = _load_module_from_path(file)
+
+            menu_struct = getattr(module, "MENU", None)
+            if menu_struct is None:
+                continue
+
+            if not isinstance(menu_struct, MenuGroup):
+                log.error("invalid_MENU_type", file=str(file))
+                continue
+
+            # Inject provenance
+            menu_struct.path = str(file.resolve())
+
+            results.append(menu_struct)
+
+        except Exception as e:
+            log.exception(
+                "failed_loading_menugroup",
+                file=str(file),
+                error=str(e),
+            )
+
+    log.info("menugroups_loaded", count=len(results))
+    return results
+

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/menuregistry.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+import structlog
+from streamlit_flexnav.core.loader import load_menupages
+from streamlit_flexnav.ui.converter import MenuStruct
+
+log = structlog.get_logger().bind(component="menuregistry")
+
+
+class MenuRegistry:
+    """
+    Holds the loaded MenuStruct objects.
+    Reloadable, but not manually mutable.
+    """
+
+    def __init__(self):
+        self._items: list[MenuStruct] = []
+        self.reload()
+
+    def reload(self):
+        self._items = load_menupages()
+        log.info("menuregistry_reloaded", count=len(self._items))
+
+    def all(self) -> list[MenuStruct]:
+        return self._items
+
+
+# Singleton
+menuregistry = MenuRegistry()

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/models/__init__.py

@@ -0,0 +1,2 @@
+# flexnav/core/__init__.py
+# Generated: 2026-01-31 • Version 0.1.0

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/models/accesscontrol.py

@@ -0,0 +1,37 @@
+from typing import List
+from pydantic import BaseModel, Field, model_validator
+from .rolemode import RoleMode
+
+class AccessControl(BaseModel):
+    """
+    Role-based access control for a menu item.
+    Ensures no overlap between allowed and denied roles.
+    """
+
+    allowed_roles: List[RoleMode] = Field(
+        default_factory=list,
+        description="Roles that may see/use this menu item."
+    )
+    denied_roles: List[RoleMode] = Field(
+        default_factory=list,
+        description="Roles that must never see/use this menu item."
+    )
+
+    @model_validator(mode="after")
+    def validate_no_overlap(self):
+        overlap = set(self.allowed_roles) & set(self.denied_roles)
+        if overlap:
+            names = ", ".join(r.display_name() for r in overlap)
+            raise ValueError(f"Role(s) cannot be both allowed and denied: {names}")
+        return self
+
+    def is_allowed(self, role: RoleMode) -> bool:
+        """
+        Returns True if the given role is permitted.
+        Denied roles always override allowed roles.
+        """
+        if role in self.denied_roles:
+            return False
+        if self.allowed_roles and role not in self.allowed_roles:
+            return False
+        return True

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/models/linktarget.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+class LinkTarget(str, Enum):
+    self_ = "_self"
+    blank = "_blank"
+    parent = "_parent"
+    top = "_top"

streamlit_flexnav-0.1.0/src/streamlit_flexnav/core/models/menugroup.py

@@ -0,0 +1,30 @@
+from __future__ import annotations
+from pydantic import BaseModel, Field
+from typing import Optional, List
+
+
+class MenuGroup(BaseModel):
+    """
+    Represents a styled menu/submenu section.
+    This is NOT a page. It is a visual grouping.
+    """
+
+    key: str = Field(..., description="Unique group identifier")
+    label: str = Field(..., description="Displayed group label")
+
+    order: int = Field(
+        default=100,
+        ge=-10_000,
+        le=10_000,
+        description="Ordering in of menu",
+    )
+
+    # Styling
+    icon: Optional[str] = None
+    color: Optional[str] = None
+    bold: bool = False
+    italic: bool = False
+    size: Optional[int] = None  # 1–3 simulated sizes
+
+    # Pages inside this group
+    pages: List[object] = Field(default_factory=list)