📚 Data Dictionary Web UI

A modern, full-stack web application for exploring, managing, and governing your data catalog — powered by Flask, React, and YAML-based metadata.

✨ Features

🚀 Quick Setup

Prerequisites

• Python 3.9+
• Node.js 18+ (for frontend development only)

1. Install

Install directly via pip:

pip install data-dictionary-web

2. Configure (Optional)

By default, the app looks for YAML files in ./models and stores the database in ./data_dictionary.db. You can configure this via environment variables or CLI flags.

Create a .env file for secure configuration:

SECRET_KEY=your-random-secret-key
JWT_SECRET_KEY=your-random-jwt-secret
YAML_DIRECTORY=./dbt_models
DATABASE=./data_dictionary.db

3. Run

Start the server using the bundled CLI:

ddweb

Or with custom options:

ddweb --port 8080 --yaml-dir ./dbt_models

Open http://localhost:5002 (or your custom port) and log in with:

• Username: admin
• Password: admin123

⚠️ Change the default admin password immediately after first login.

📖 Documentation

See DOCUMENTATION.md for the full guide covering:

• Architecture & project structure
• Environment configuration
• Frontend development setup
• All features in detail
• REST API reference
• Deployment (Gunicorn, Nginx, Docker)
• Security model & best practices
• Troubleshooting

📄 License

This project is licensed under the MIT License — see the LICENSE file for details.