sqldash 0.1.0__tar.gz

sqldash-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+dist/
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+.knowledge
+AGENTS.local.md
+CLAUDE.local.md

sqldash-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sqldash-0.1.0/PKG-INFO

@@ -0,0 +1,363 @@
+Metadata-Version: 2.5
+Name: sqldash
+Version: 0.1.0
+Summary: Single-file SQL dashboards. Pure Python, no cloud, no build step.
+Project-URL: Homepage, https://github.com/dylan-murray/sqldash
+Project-URL: Repository, https://github.com/dylan-murray/sqldash
+Project-URL: Issues, https://github.com/dylan-murray/sqldash/issues
+Author: Dylan Murray
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: analytics,athena,bi,bigquery,clickhouse,dashboards,databricks,duckdb,mcp,mysql,postgres,redshift,semantic-layer,snowflake,sql,trino,yaml
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.11
+Requires-Dist: duckdb-engine>=0.13
+Requires-Dist: duckdb>=1.1
+Requires-Dist: fastapi>=0.115
+Requires-Dist: jinja2>=3.1
+Requires-Dist: markdown-it-py>=3
+Requires-Dist: mcp<3,>=2
+Requires-Dist: platformdirs>=4
+Requires-Dist: pydantic>=2.9
+Requires-Dist: questionary>=2.1.1
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn[standard]>=0.30
+Requires-Dist: watchdog>=5
+Provides-Extra: all
+Requires-Dist: clickhouse-sqlalchemy>=0.3; extra == 'all'
+Requires-Dist: databricks-sqlalchemy>=2.0; extra == 'all'
+Requires-Dist: lkml>=1.3; extra == 'all'
+Requires-Dist: playwright>=1.45; extra == 'all'
+Requires-Dist: psycopg[binary]>=3.2; extra == 'all'
+Requires-Dist: pyathena>=3.8; extra == 'all'
+Requires-Dist: pymysql>=1.1; extra == 'all'
+Requires-Dist: redshift-connector>=2.1; extra == 'all'
+Requires-Dist: snowflake-connector-python[secure-local-storage]>=3.12; extra == 'all'
+Requires-Dist: snowflake-sqlalchemy>=1.6; extra == 'all'
+Requires-Dist: sqlalchemy-bigquery>=1.11; extra == 'all'
+Requires-Dist: sqlalchemy-redshift>=0.8; extra == 'all'
+Requires-Dist: trino>=0.330; extra == 'all'
+Provides-Extra: athena
+Requires-Dist: pyathena>=3.8; extra == 'athena'
+Provides-Extra: bigquery
+Requires-Dist: sqlalchemy-bigquery>=1.11; extra == 'bigquery'
+Provides-Extra: clickhouse
+Requires-Dist: clickhouse-sqlalchemy>=0.3; extra == 'clickhouse'
+Provides-Extra: databricks
+Requires-Dist: databricks-sqlalchemy>=2.0; extra == 'databricks'
+Provides-Extra: lookml
+Requires-Dist: lkml>=1.3; extra == 'lookml'
+Provides-Extra: mysql
+Requires-Dist: pymysql>=1.1; extra == 'mysql'
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.2; extra == 'postgres'
+Provides-Extra: redshift
+Requires-Dist: redshift-connector>=2.1; extra == 'redshift'
+Requires-Dist: sqlalchemy-redshift>=0.8; extra == 'redshift'
+Provides-Extra: snapshot
+Requires-Dist: playwright>=1.45; extra == 'snapshot'
+Provides-Extra: snowflake
+Requires-Dist: snowflake-connector-python[secure-local-storage]>=3.12; extra == 'snowflake'
+Requires-Dist: snowflake-sqlalchemy>=1.6; extra == 'snowflake'
+Provides-Extra: trino
+Requires-Dist: trino>=0.330; extra == 'trino'
+Description-Content-Type: text/markdown
+
+<h4 align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="assets/wordmark-dark.svg">
+    <img src="assets/wordmark-light.svg" alt="sqldash" width="230">
+  </picture>
+  <br>
+  BI for the agentic era
+</h4>
+
+<p align="center">
+  <a href="https://github.com/dylan-murray/sqldash/actions/workflows/tests.yml"><img src="https://github.com/dylan-murray/sqldash/actions/workflows/tests.yml/badge.svg?branch=main" alt="Lint &amp; Test"></a>
+  <a href="https://github.com/dylan-murray/sqldash/actions/workflows/codeql.yml"><img src="https://github.com/dylan-murray/sqldash/actions/workflows/codeql.yml/badge.svg?branch=main" alt="CodeQL"></a>
+  <a href="https://github.com/dylan-murray/sqldash/actions/workflows/semgrep.yml"><img src="https://github.com/dylan-murray/sqldash/actions/workflows/semgrep.yml/badge.svg?branch=main" alt="Semgrep"></a>
+  <a href="https://github.com/dylan-murray/sqldash/blob/main/pyproject.toml"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python 3.11+"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache--2.0-green" alt="License: Apache 2.0"></a>
+</p>
+
+<h2></h2>
+
+sqldash serves dashboards and metrics straight from your repos. Work with every
+dashboard and metric from a local CLI. Dashboards run locally on your machine. No
+infrastructure to stand up and no complicated deployments. Agents build dashboards
+quickly through the CLI or MCP server and can self-serve business questions the same way.
+
+<img src="assets/demo.webp" alt="sqldash in action: the dashboard library, a governed revenue dashboard, filters, a tile built from SQL in + Explore and added to the dashboard, three AI Studio edits including two custom themes, and the shared metric behind it">
+
+## 💡 Why sqldash
+
+Most BI tools keep your dashboards on their server, behind their login, in their
+editor. sqldash keeps them in your repo as YAML, with the same review, the same
+history, and the same deploy as the rest of your code.
+
+- **Local first.** Pure Python, no cloud, no build step. A small server on your machine,
+  nothing hosted, nothing to sign up for.
+- **Dashboards as code.** One YAML file per dashboard. The browser is an editor over
+  that file: add a tile, change a chart, adjust a filter, or drag the layout, and
+  sqldash writes the YAML back, so the change shows up as a normal diff in git.
+- **Edit with your coding agent.** Pin a change in AI Studio, choose Claude Code,
+  Codex, or your own entrypoint, and keep chatting as the dashboard updates. Undo
+  the latest edit when you want to try another direction.
+- **Metrics as code.** Define revenue once. Tiles, the CLI, and agents all use that
+  definition, and nobody re-derives it in raw SQL.
+- **Most SQL databases.** Flat, human config for Snowflake, BigQuery, Databricks,
+  Redshift, Athena, Postgres, MySQL, Trino, ClickHouse, SQLite, and DuckDB, or a raw
+  SQLAlchemy URL for anything else SQLAlchemy speaks. One dashboard can pull from
+  several at once. `sqldash lint` catches typos and missing drivers before you serve.
+- **Credentials stay local.** Use `${env:VAR}` references or a per-user profile
+  to keep credentials outside committed dashboard files. Everyone connects as themselves.
+- **Built for agents too.** `sqldash mcp` serves governed metrics to Claude Code and
+  friends. Agents pass names and values; sqldash compiles the SQL.
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="assets/how-it-works-dark.svg">
+  <img src="assets/how-it-works-light.svg" alt="How sqldash works: YAML dashboards, metrics, and agent definitions in your repo, served locally to the browser and to agents over MCP, querying your warehouse with your own credentials">
+</picture>
+
+## 🚀 Quick start
+
+Try the demo. It runs on DuckDB, so there is nothing to connect:
+
+```bash
+uvx sqldash init --demo   # sample dashboard and metrics in .sqldash/
+uvx sqldash serve         # opens the dashboard in your browser
+```
+
+Once you're ready for your own warehouse, `setup` does the onboarding. It asks which
+warehouse you use, writes a local profile with your credentials, tests the connection,
+and writes the project source:
+
+```bash
+uvx sqldash setup         # pick a warehouse, write a profile, test the connection
+uvx sqldash serve
+```
+
+Then prompt your agent to build the dashboards. `sqldash mcp` hands it your schema, any
+metrics you've already defined, and validators for checking candidate YAML before
+saving it:
+
+```bash
+claude mcp add sqldash -- uvx sqldash mcp .
+```
+
+<img src="assets/demo-agent.svg" alt="An agent building a dashboard over MCP: it reads the schema and metrics, validates the YAML, and writes the file">
+
+Everything stays inside a `.sqldash/` folder, so you can add it to any existing repo
+without touching the root. For something bigger than the demo, `examples/` is a
+runnable project on DuckDB with a dashboard and a metrics file, no credentials needed:
+
+```bash
+uvx sqldash serve examples
+```
+
+## ✨ AI Studio
+
+Open **AI Studio**, pin what should change, and send your requests together. Your
+coding agent edits the dashboard files while you keep working in the browser. Choose
+Claude Code, Codex, or a custom headless entrypoint, including your own aliases.
+Approve supported Claude tool requests in the panel, keep chatting, and use
+**Undo last edit** to try a different direction. Changes stay in your local files,
+ready for a git diff.
+
+Ask for a look in plain words and the agent writes it as CSS in the dashboard YAML.
+Six one-line requests, six answers, same metrics and filters underneath:
+
+<img src="assets/demo-themes.webp" alt="Six themes an agent wrote from a one-line request each, with the AI Studio conversation open: Neon observatory, Rose quartz, Electric citrus, Morning broadsheet, Ember, and Amber terminal">
+
+[Try the themed examples](examples/studio/README.md) · [Studio guide](docs/studio.md) ·
+[Custom themes](docs/themes.md)
+
+## 📦 Install
+
+`uvx` runs sqldash without installing it. To install it:
+
+```bash
+uv tool install sqldash                          # recommended
+uv tool install 'sqldash[snowflake]'             # with the driver for your warehouse
+uv tool install 'sqldash[snowflake,postgres]'    # or several
+pip install 'sqldash[snowflake]'                 # plain pip works the same, Python 3.11+
+```
+
+Extras work with `uvx` too: `uvx --from 'sqldash[snowflake]' sqldash serve`.
+
+DuckDB ships in the core. Every other warehouse is an extra: `snowflake`, `postgres`,
+`bigquery`, `databricks`, `redshift`, `athena`, `mysql`, `trino`, and `clickhouse`.
+`sqldash lint` names the one a dashboard needs.
+
+## 📊 A dashboard is a YAML file
+
+```yaml
+title: Revenue Overview
+source: {type: duckdb, attach_files: true}
+
+filters:
+  - {name: dates, type: daterange, default: last_30_days}
+
+tiles:
+  - title: Daily revenue
+    chart: area
+    format: currency
+    sql: |
+      SELECT order_date, SUM(amount) AS revenue
+      FROM orders
+      WHERE order_date BETWEEN {{ dates_start }} AND {{ dates_end }}
+      GROUP BY 1 ORDER BY 1
+```
+
+Edit a chart, add a filter, or drag a tile in the browser, and the change lands back
+in this file as a git diff. Dashboards can mix databases and display charts, tables,
+big numbers, and markdown. See the [dashboard reference](docs/dashboard-file.md)
+for layouts, filters, [multiple sources](docs/dashboard-file.md#sources), and
+[credential profiles](docs/dashboard-file.md#credential-profiles).
+
+## 🧠 One metric for dashboards and agents
+
+The demo already defines revenue in `.sqldash/metrics.yaml`. Here is a minimal
+version of that definition; keep the other metrics when editing the demo file:
+
+```yaml
+source: {type: duckdb, attach_files: true}
+
+metrics:
+  revenue:
+    table: orders
+    expr: SUM(amount)
+    format: currency
+    time_dimension: {name: order_date, grain: day}
+    dimensions: [{name: region}]
+```
+
+The dashboard above can replace its SQL tile with a metric tile. Its date filter
+still applies:
+
+```yaml
+tiles:
+  - title: Daily revenue
+    metric: {name: revenue, grain: day}
+```
+
+An agent connected through `sqldash mcp` uses that same definition by calling
+`query_metric`. For daily revenue in the last 30 days, it passes:
+
+```json
+{"name": "revenue", "grain": "day", "start": "-30d", "end": "today"}
+```
+
+The metric query tools accept declared metric and dimension names and bind filter
+values as SQL parameters. The built-in raw-SQL tool stays off unless you enable
+`--allow-sql`.
+
+See the [semantic-layer guide](docs/semantic-layer.md) for derived metrics, period
+comparisons, and imports and exports.
+
+## 🤖 Agents
+
+Define an agent in `agents.yaml`, next to `metrics.yaml`, and `sqldash mcp` serves it
+as a prompt to your coding agent. The host runs it with its own model and calls
+sqldash for the numbers.
+
+```yaml
+# agents.yaml
+agents:
+  finance_analyst:
+    description: Answers revenue questions for the finance team
+    instructions: Compare revenue to the previous period when asked how it did.
+    metrics: [revenue]
+    sample_questions:
+      - How did revenue do over the last 30 days?
+    evals:
+      - question: How did revenue do over the last 30 days?
+        expect:
+          tool: query_metric
+          args:
+            name: revenue
+            start: -30d
+            end: today
+            compare: previous_period
+```
+
+Evals live with the agent definition. With MCP configured in your host, run them
+through it:
+
+```bash
+sqldash agent eval finance_analyst \
+  --runner 'claude -p --append-system-prompt "$(cat "$SQLDASH_AGENT_PROMPT_FILE")"'
+```
+
+sqldash runs the expected query and checks the answer against its result, without a
+judge model. Without `--runner`, the command checks the definition and references;
+`sqldash lint` runs those checks too. See [agents and evals](docs/agents.md) for data
+tools, response instructions, and grading details.
+
+## 📚 Go further
+
+- [Dashboard files](docs/dashboard-file.md) — charts, filters, layouts, connections, and profiles.
+- [Metrics](docs/semantic-layer.md) — shared definitions, MCP tools, and BI interoperability.
+- [Agents](docs/agents.md) — prompts, data tools, and evals.
+- [Studio](docs/studio.md) — pins, agent entrypoints, approvals, conversation, and undo.
+- [Custom themes](docs/themes.md) — dashboard CSS and runnable designs.
+- [Workspaces and sharing](docs/workspaces.md) — serve Git repos together or export static snapshots.
+- [CLI reference](docs/cli.md) — query, inspect, validate, and export from the terminal.
+
+## ❓ FAQ
+
+**How is this different from Metabase?** Metabase is a server with its own database
+of dashboards, users, and permissions, and you build everything in its GUI. sqldash
+has no server to deploy or operate and no accounts to manage. A dashboard is a file in your repo,
+the pull request is the review, git is the history, and your warehouse credentials
+are the permission model.
+
+**How is this different from Evidence?** Evidence pages are markdown with SQL, and
+Node builds them into a static site whose data is extracted at build time, so viewers
+see whatever the last build fetched. sqldash is pure Python with no build step. A
+dashboard is one YAML file, every query runs live against your warehouse with the
+viewer's own credentials, and the same metrics are served to agents over MCP.
+
+**How is this different from Rill?** Rill is also BI as code with YAML metrics views,
+but it is built around its own OLAP engines (DuckDB, ClickHouse) and its git workflow
+lives in Rill Cloud. sqldash queries the warehouse you already have, and git is in the
+tool itself: serve a git URL, register several repos as one workspace, edit in the
+browser and commit the diff. No cloud required, and the semantic layer is served to
+agents over MCP from your laptop.
+
+**How is this different from Streamlit?** Streamlit is a framework for writing apps in
+Python. sqldash is declarative: a dashboard is data, not code, so there is nothing to
+program, and an agent can write one as easily as a person.
+
+**Do I need to run a server?** No server to deploy—the local server runs on your
+laptop. `sqldash serve` queries your databases with your own credentials. For people
+who have no warehouse access, `sqldash snapshot` renders static pages they can open
+anywhere.
+
+**Where do credentials go?** Use `${env:VAR}` references to read credentials from
+your environment, or a per-user profile file. This keeps credential values outside
+the dashboard YAML you commit.
+
+**Does it work with my warehouse?** Snowflake, BigQuery, Databricks, Redshift, Athena,
+Postgres, MySQL, Trino, ClickHouse, SQLite, and DuckDB have flat config. Anything else
+SQLAlchemy can reach works with a raw URL.
+
+## 🤝 Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, ground rules, and how to report
+issues. First-time contributors sign the [CLA](CLA.md) by adding one line to it in
+their pull request.
+
+## 📄 License
+
+sqldash is licensed under the [Apache License 2.0](LICENSE).