Skip to content

heptau/sqlfluffui

Repository files navigation

SQLFluffUI

Interactive GUI tool for visually creating and managing SQLFluff configuration. Built with Python + PySide6 (Qt).

🌐 https://sqlfluffui.80.cz

Features

  • Visual configurator – all parameters organized in categories with descriptions
  • Live preview – see the generated .sqlfluff file instantly
  • Sample SQL – apply configuration to a sample SQL query and see changes
  • Rules – configure all linting rules
  • Layout – set spacing and line-breaking for each element type
  • Indentation – spaces/tabs, JOIN/CASE/CTE indentation, etc.
  • Export – save configuration as .sqlfluff, setup.cfg section, or pyproject.toml
  • Presets – save and load entire configuration profiles

Installation

pip install sqlfluff-ui

Or from the repository:

git clone https://github.com/yourusername/sqlfluff-ui.git
cd sqlfluff-ui
pip install -e .

macOS (Homebrew)

Coming soon.

Usage

# Launch GUI
sqlfluff-ui

# Or as a Python module
python -m sqlfluff_ui

Development

# Environment
python -m venv .venv
source .venv/bin/activate

# Install including dev dependencies
pip install -e ".[dev]"

# Run
python -m sqlfluff_ui

Project structure

sqlfluff-ui/
├── src/sqlfluff_ui/
│   ├── config/       # Data model and logic
│   │   ├── model.py      # ConfigOption, ConfigSection dataclasses
│   │   ├── loader.py     # Loading config info from sqlfluff
│   │   └── generator.py  # Generating .sqlfluff output
│   ├── ui/           # Qt widgets
│   │   ├── main_window.py
│   │   ├── core_panel.py
│   │   ├── indentation_panel.py
│   │   ├── layout_panel.py
│   │   ├── rules_panel.py
│   │   ├── preview_panel.py
│   │   └── sample_panel.py
│   ├── app.py
│   └── __main__.py
├── tests/
├── pyproject.toml
└── README.md

License

MIT

About

Visual configurator for SQLFluff Configure SQL linting rules through a clean GUI. Dialect, indentation, layout and hundreds of rules — see the result live.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Contributors