Metadata-Version: 2.4
Name: brickflowui
Version: 0.1.7
Summary: A Databricks-first Python UI framework for building secure dashboards, portals, and web apps with pure Python.
Project-URL: Homepage, https://github.com/AjayAJ2000/brickflowUI
Project-URL: Documentation, https://ajayaj2000.github.io/brickflowUI/
Project-URL: Repository, https://github.com/AjayAJ2000/brickflowUI
Project-URL: Issues, https://github.com/AjayAJ2000/brickflowUI/issues
Author: BrickflowUI Contributors
License: MIT License
        
        Copyright (c) 2026 BrickflowUI Contributors
        
        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.
License-File: LICENSE
Keywords: dashboard,databricks,fastapi,portal,python-framework,ui
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
Classifier: Topic :: Software Development :: User Interfaces
Requires-Python: >=3.10
Requires-Dist: fastapi>=0.110.0
Requires-Dist: python-dotenv>=1.2.2
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: starlette>=0.37.0
Requires-Dist: typer>=0.12.0
Requires-Dist: uvicorn[standard]>=0.29.0
Requires-Dist: websockets>=12.0
Provides-Extra: all
Requires-Dist: databricks-sdk>=0.20.0; extra == 'all'
Requires-Dist: databricks-sql-connector>=3.0.0; extra == 'all'
Requires-Dist: httpx>=0.27.0; extra == 'all'
Requires-Dist: mkdocs-material>=9.6.0; extra == 'all'
Requires-Dist: mkdocs>=1.6.0; extra == 'all'
Requires-Dist: mypy>=1.10.0; extra == 'all'
Requires-Dist: pandas>=2.0.0; extra == 'all'
Requires-Dist: plotly>=5.0.0; extra == 'all'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'all'
Requires-Dist: pytest>=9.0.3; extra == 'all'
Requires-Dist: ruff>=0.4.0; extra == 'all'
Provides-Extra: databricks
Requires-Dist: databricks-sdk>=0.20.0; extra == 'databricks'
Requires-Dist: databricks-sql-connector>=3.0.0; extra == 'databricks'
Requires-Dist: pandas>=2.0.0; extra == 'databricks'
Provides-Extra: dev
Requires-Dist: httpx>=0.27.0; extra == 'dev'
Requires-Dist: mypy>=1.10.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest>=9.0.3; extra == 'dev'
Requires-Dist: ruff>=0.4.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.6.0; extra == 'docs'
Requires-Dist: mkdocs>=1.6.0; extra == 'docs'
Provides-Extra: viz
Requires-Dist: plotly>=5.0.0; extra == 'viz'
Description-Content-Type: text/markdown

# BrickflowUI

Databricks-first Python UI framework for building dashboards, portals, chatbot workspaces, landing pages, and internal web apps with pure Python.

Canonical package name: `brickflowui`

Install:

```bash
pip install brickflowui
```

Import:

```python
import brickflowui as db
```

Documentation:

- [Docs site](https://ajayaj2000.github.io/brickflowUI/)
- [Learn BrickflowUI](https://ajayaj2000.github.io/brickflowUI/learning/)
- [Component Gallery](https://ajayaj2000.github.io/brickflowUI/components/)
- [Architecture](https://ajayaj2000.github.io/brickflowUI/ARCHITECTURE/)

## What BrickflowUI is for

Use BrickflowUI when you want to stay in Python and still ship a serious interactive app.

Good fits:

- executive dashboards
- data engineering pipeline portals
- Databricks App experiences
- internal ops tools
- chatbot and copilot UIs
- product-style landing pages

## Why teams use it

- Python-first authoring model
- session-scoped reactive state
- multi-page routing and app shell support
- built-in tables, forms, overlays, charts, pipeline graphs, workflow boards, and chat patterns
- packaged frontend assets that work in stricter CSP environments
- branding and theme tokens for enterprise rollout

## Quick start

Scaffold a new app:

```bash
brickflowui new my_app
cd my_app
brickflowui dev
```

Or write one manually:

```python
import brickflowui as db

app = db.App(title="Hello BrickflowUI")

@app.page("/", title="Home")
def home():
    count, set_count = db.use_state(0)
    return db.Column(
        [
            db.Text("Hello BrickflowUI", variant="h1"),
            db.Text(f"Count: {count}"),
            db.Button("Increment", on_click=lambda: set_count(count + 1)),
        ],
        gap=4,
        padding=6,
    )

if __name__ == "__main__":
    app.run()
```

## Core concepts

BrickflowUI works as:

1. Python page functions produce a `VNode` tree.
2. The server serializes that tree and sends it over WebSocket.
3. The frontend renders it and returns interaction events.
4. Python handlers update state and trigger rerenders.

This gives you a React-style interaction model without requiring users to write frontend code.

## Current component surface

### Layout and app structure

- `Column`
- `Row`
- `Grid`
- `Card`
- `Divider`
- `Spacer`
- `Hero`
- `SectionHeader`
- `StatusStrip`

### Inputs and overlays

- `Button`
- `Input`
- `Select`
- `Checkbox`
- `Toggle`
- `Slider`
- `DateRangePicker`
- `MultiSelect`
- `Form`
- `Modal`
- `Drawer`
- `Popup`

### Data and workflow

- `Table`
- `Timeline`
- `SparklineStat`
- `Stepper`
- `KanbanBoard`
- `ChatMessage`
- `ChatInput`
- `PipelineGraph`

### Charts

- `Plot`
- `AreaChart`
- `BarChart`
- `LineChart`
- `DonutChart`
- `ScatterChart`
- `ComposedChart`
- `GaugeChart`
- `RadarChart`
- `Heatmap`
- `FunnelChart`
- `TreeMap`

## Databricks Apps

Use this minimum setup:

`requirements.txt`

```text
brickflowui>=0.1.6
```

Install from GitHub instead:

```text
brickflowui @ git+https://github.com/AjayAJ2000/brickflowUI.git@main
```

`app.yaml`

```yaml
command:
  - python
  - app.py
```

Important packaging rule:

The installed package must contain:

```text
brickflowui/frontend/dist/index.html
brickflowui/frontend/dist/assets/*
```

If those files are missing, Databricks Apps often stop at the loading shell.

## Local development

Framework tests:

```bash
python -m pytest -q
```

Frontend build:

```bash
cd frontend
npm run build
```

Docs build:

```bash
python -m mkdocs build
```

Package build:

```bash
python -m build
```

## Repo map

```text
brickflowui/
  app.py
  components.py
  server.py
  state.py
  vdom.py
  frontend/dist/
  cli/
  databricks/

frontend/
  src/
  vite.config.ts

docs/
  learning/
  components/
  ARCHITECTURE.md
```

## License

MIT
