streamlit-flexnav 0.1.0

Navigation toolkit, menu schema, and Streamlit integration

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
  • ✨ Features
  • 📦 Installation
  • 🚀 Quick Start
    • 1. Create a menu schema (menu.yaml)
    • 2. Load and register the schema
  • 🧭 Navigation Behavior
  • ⚙️ Configuration
  • 🛠 CLI Tools
  • 📁 Project Structure
  • 🧪 Development
  • 📄 License
  • ⭐ 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:
Renders menu groups and pages
Applies role‑based access control
Highlights the active page
Supports icons, dividers, and collapsible groups
Integrates seamlessly with Streamlit’s session state

---

⚙️ Configuration

TODO
menu settings
Page settings

🛠 CLI Tools

After installation, the CLI becomes available:
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.