feat: add demo env

[nadeem4]

This pull request introduces a major overhaul of configuration management and adapter validation for the NL2SQL system. The main changes include stricter schema validation for database adapters, standardized and versioned configuration files for datasources, LLMs, and policies, and cleanup of legacy files. These updates improve reliability, maintainability, and clarity of the system's setup and access control.

Configuration and Schema Standardization

• All configuration files for datasources, LLMs, and policies now use explicit versioning and standardized schemas, including demo and example variants for easier onboarding and reproducibility. (configs/datasources.demo.yaml, configs/datasources.example.yaml, configs/llm.demo.yaml, configs/llm.yaml, configs/policies.demo.json, configs/policies.example.json) [1] [2] [3] [4] [5] [6]

• Policy configuration files now include a top-level version field and organize roles, allowed datasources, and tables in a structured manner for both demo and example environments. (configs/policies.demo.json, configs/policies.example.json) [1] [2] [3]

Database Adapter Validation

• All major database adapters (sqlite, postgres, mysql, mssql) now use strict Pydantic schemas for validating connection configuration, improving error handling and ensuring only valid connection parameters are used. (packages/adapters/sqlite/src/nl2sql_sqlite/adapter.py, packages/adapters/postgres/src/nl2sql_postgres/adapter.py, packages/adapters/mysql/src/nl2sql_mysql/adapter.py, packages/adapters/mssql/src/nl2sql_mssql/adapter.py) [1] [2] [3] [4]

Cleanup and Dependency Updates

• Removed the legacy docker-compose.yaml and updated documentation to provide a minimal example for API deployment, reflecting the move to SQLite-based demo environments and reducing setup complexity. (docker-compose.yaml, docs/guides/deployment.md) [1] [2]

• Added inquirerpy as a CLI dependency for improved interactive command-line experiences. (packages/cli/pyproject.toml)

CLI and Benchmarking Improvements

• Refactored the CLI benchmarking command to use a new BenchmarkRunner, removed unnecessary imports, and added a decorator for robust error handling. (packages/cli/src/nl2sql_cli/commands/benchmark.py)

Legacy File Removal

• Removed outdated and unversioned policy and datasource configuration files to avoid confusion and ensure only standardized versions are used. (configs/policies.json, configs/datasources.yaml) [1] [2]

Let me know if you'd like a deeper dive into how the new validation schemas work or how the configuration files should be used in practice!

[gitguardian]

⚠️ GitGuardian has uncovered 2 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
24538870	Triggered	Generic Password	e5a6b53	packages/cli/src/nl2sql_cli/demo/writers/docker.py	View secret
24538871	Triggered	Generic Password	e5a6b53	packages/cli/src/nl2sql_cli/demo/writers/docker.py	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secrets safely. Learn here the best practices.
3. Revoke and rotate these secrets.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}