databao-agent 0.1.4.dev4__tar.gz

databao_agent-0.1.4.dev4/.gitignore

@@ -0,0 +1,26 @@
+# Virtual environment
+.venv/
+# Python cache files
+__pycache__/
+*/__pycache__/
+**/__pycache__/
+dist/
+
+# Environment variables
+.env
+
+# OS generated files
+.DS_Store
+
+.idea/
+.ipynb_checkpoints/
+
+.memo
+examples/shopify001/
+examples/shopify002/
+
+# Client build artifacts
+client/out
+
+# Test artifacts
+tests/.pytest-artifacts/

databao_agent-0.1.4.dev4/LICENSE.md

@@ -0,0 +1,80 @@
+JetBrains Data Agent SDK EAP Terms and Conditions
+Copyright (c) 2025 JetBrains s.r.o.
+
+This program is licensed under the Apache License, Version 2.0 and the Additional Terms and Conditions (the "License"); you may not use this file except in compliance with the License.
+
+========================================
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of this License; and
+You must cause any modified files to carry prominent notices stating that You changed the files; and
+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
+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.
+
+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.
+
+========================================
+ADDITIONAL TERMS AND CONDITIONS
+========================================
+
+This is an Early Access Program (EAP) release. The software is experimental, may not be reliable, and may contain errors. Any use of this software is at your own risk.
+
+1. Disclaimers Regarding AI-Generated Content and Agentic Behavior
+
+You acknowledge that the software integrates artificial intelligence features that may generate code, queries, text, or other output ("Generated Content") and may perform autonomous actions on your local system ("Agentic Behavior").
+
+You are solely responsible for reviewing, testing, and validating all Generated Content for accuracy, security, and fitness for any purpose. You are also solely responsible for supervising all Agentic Behavior and for any consequences thereof, including but not limited to modification of files, code, or system configurations. JetBrains has no liability for any damages or losses arising from your use of, or reliance on, Generated Content or from any Agentic Behavior.
+
+2. Disclaimer Regarding Local Inference and Models
+
+The software is designed to operate with a local inference stack and third-party AI models, which may be bundled with the software or configured by you. JetBrains disclaims all warranties and assumes no liability for the performance, security, or compliance of any local inference stack or any AI models, whether provided by JetBrains or by a third party. You are solely responsible for your use of such components and for compliance with any applicable third-party licenses or terms.
+
+3. Disclaimer for Use in Production and Third-Party Applications
+
+As an EAP product, this software is not intended for use in production environments. If you choose to incorporate the software into any application, product, workflow or service, you do so at your own risk. JetBrains disclaims all warranties, express or implied, and shall not be liable for any direct, indirect, incidental, special, or consequential damages suffered by you or any third party arising from such use. You agree to defend, indemnify, and hold harmless JetBrains from any and all claims related to the use of the software within your applications.
+
+END OF TERMS AND CONDITIONS

databao_agent-0.1.4.dev4/PKG-INFO

@@ -0,0 +1,310 @@
+Metadata-Version: 2.4
+Name: databao-agent
+Version: 0.1.4.dev4
+Summary: databao-agent: NL queries for data
+Project-URL: Homepage, https://databao.app/
+Project-URL: Source, https://github.com/JetBrains/databao-agent
+License-Expression: Apache-2.0 AND LicenseRef-Additional-Terms
+License-File: LICENSE.md
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: <3.15,>=3.11
+Requires-Dist: databao-context-engine[mysql,postgresql,snowflake]~=0.5.0
+Requires-Dist: dbt-core~=1.9.0
+Requires-Dist: dbt-duckdb>=1.10.0
+Requires-Dist: diskcache>=5.6.3
+Requires-Dist: duckdb>=1.3.0
+Requires-Dist: edaplot-vl~=0.1.4
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: langchain-anthropic>=1.3.0
+Requires-Dist: langchain-ollama>=1.0.0
+Requires-Dist: langchain-openai>=1.1.3
+Requires-Dist: langchain>=1.1.3
+Requires-Dist: langgraph>=0.6.8
+Requires-Dist: matplotlib>=3.10.0
+Requires-Dist: mcp<2,>=1.0.0
+Requires-Dist: pandas-stubs~=2.3.3
+Requires-Dist: pandas>=2.2.2
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: pydantic<3,>=2.8.0
+Requires-Dist: snowflake-sqlalchemy>=1.8.2
+Requires-Dist: sqlalchemy-bigquery>=1.11.0
+Requires-Dist: sqlalchemy>=2.0.45
+Requires-Dist: tabulate>=0.9.0
+Requires-Dist: watchdog>=6.0.0
+Provides-Extra: examples
+Requires-Dist: anywidget>=0.9.0; extra == 'examples'
+Requires-Dist: notebook>=7.4.7; extra == 'examples'
+Requires-Dist: python-dotenv>=1.1.1; extra == 'examples'
+Requires-Dist: traitlets>=5.0.0; extra == 'examples'
+Provides-Extra: jupyter
+Requires-Dist: anywidget>=0.9.0; extra == 'jupyter'
+Requires-Dist: traitlets>=5.0.0; extra == 'jupyter'
+Description-Content-Type: text/markdown
+
+[![official project](https://jb.gg/badges/official.svg)](https://github.com/JetBrains#jetbrains-on-github)
+[![PyPI version](https://img.shields.io/pypi/v/databao-agent.svg)](https://pypi.org/project/databao-agent)
+[![Python versions](https://img.shields.io/pypi/pyversions/databao-agent.svg)](https://pypi.org/project/databao-agent/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/JetBrains/databao-agent/blob/main/LICENSE.md)
+[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1zYAlVbuOfIA3Ux5LVahM2eBU7wJplO48?usp=sharing)
+
+<h1 align="center">Databao Agent</h1>
+
+<p align="center">
+ <b>Talk to your data in plain English.</b><br/>
+ Ask questions → Get answers (Text, SQL, and interactive visual insights).
+</p>
+
+<p align="center">
+ <a href="https://databao.app">Website</a> •
+ <a href="#quickstart">Quickstart</a> •
+ <a href="#local-models">Local models</a> •
+ <a href="#contributing">Contributing</a> •
+ <a href="https://discord.gg/hEUqCcWdVh">Discord</a>
+</p>
+
+---
+
+<p align="center">
+ 🏆 <a href="https://jb.gg/ne7897"><b>Ranked #1</b> in the DBT track</a> of the Spider 2.0 Text2SQL benchmark
+</p>
+
+---
+
+## What is Databao Agent?
+
+Databao Agent is an **open-source AI agent** that lets you query your data sources using natural language. 
+
+Simply ask:
+- *"Show me all German shows"*
+- *"Plot revenue by month"*
+- *"Which customers churned last quarter?"*
+
+Get back **tables, charts, and explanations** — no SQL or code needed.
+
+<p align="center">
+ <img src="https://databao.app/agent.png" alt="Databao Agent Demo" width="500">
+</p>
+
+## Why choose Databao Agent?
+
+| Feature                   | What it means for you                                                |
+|:--------------------------|:---------------------------------------------------------------------|
+| **Interactive outputs**   | Tables you can sort/filter and charts you can zoom/hover (Vega-Lite) |
+| **Simple, Pythonic API**  | `thread.ask("question").df()`just works                              |
+| **Python-native**         | Fits perfectly into existing data science and exploratory workflows  |
+| **Natural language**      | Ask questions about your data just like asking a colleague           |
+| **Broad DB support**      | PostgreSQL, MySQL, SQLite, DuckDB... anything SQLAlchemy supports    |
+| **Auto-generated charts** | Get Vega-Lite visualizations without writing plotting code           |
+| **Local first**           | Use Ollama or LM Studio — your data never leaves your machine        |
+| **Cloud LLM ready**       | Built-in support for OpenAI, Anthropic, and OpenAI-compatible APIs   |
+| **Conversational**        | Maintains context for follow-up questions and iterative analysis     |
+
+## Installation
+
+```bash
+pip install databao-agent
+```
+
+## Supported data sources
+
+* <img src="https://cdn.simpleicons.org/pandas/150458" width="16" height="16" alt=""> Pandas DataFrame
+* <img src="https://cdn.simpleicons.org/postgresql/316192" width="16" height="16" alt=""> PostgreSQL
+* <img src="https://cdn.simpleicons.org/mysql/4479A1" width="16" height="16" alt=""> MySQL
+* <img src="https://cdn.simpleicons.org/sqlite/003B57" width="16" height="16" alt=""> SQLite
+* <img src="https://cdn.simpleicons.org/duckdb/FFF000" width="16" height="16" alt=""> DuckDB
+
+For PostgreSQL, MySQL, and SQLite, pass a SQLAlchemy `Engine` to `add_db()`. For DuckDB, pass `DuckDBPyConnection`.
+
+## Quickstart
+
+### 1. Create a database connection (SQLAlchemy)
+
+```python
+import os
+from sqlalchemy import create_engine
+
+user = os.environ.get("DATABASE_USER")
+password = os.environ.get("DATABASE_PASSWORD")
+host = os.environ.get("DATABASE_HOST")
+database = os.environ.get("DATABASE_NAME")
+
+engine = create_engine(
+   f"postgresql://{user}:{password}@{host}/{database}"
+)
+```
+
+### 2. Create a Databao agent and register sources
+
+```python
+import databao
+from databao import LLMConfig
+
+# Option A - Local: install and run any compatible local LLM
+# For list of compatible models, see "Local Models" below
+# llm_config = LLMConfig(name="ollama:gpt-oss:20b", temperature=0)
+
+# Option B - Cloud (requires an API key, e.g. OPENAI_API_KEY)
+llm_config = LLMConfig(name="gpt-4o-mini", temperature=0)
+agent = databao.new_agent(name="demo", llm_config=llm_config)
+
+# Add your database to the agent
+agent.add_db(engine)
+```
+
+### 3. Ask questions and materialize results
+
+```python
+# Start a conversational thread
+thread = agent.thread()
+
+# Ask a question and get a DataFrame
+df = thread.ask("list all german shows").df()
+print(df.head())
+
+# Get a textual answer
+print(thread.text())
+
+# Generate a visualization (Vega-Lite under the hood)
+plot = thread.plot("bar chart of shows by country")
+print(plot.code)  # access generated plot code if needed
+```
+
+## Environment variables
+
+Specify your API keys in the environment variables:
+
+| Variable            | Description                                          |
+|:--------------------|:-----------------------------------------------------|
+| `OPENAI_API_KEY`    | Required for OpenAI models or OpenAI-compatible APIs |
+| `ANTHROPIC_API_KEY` | Required for Anthropic models                        |
+
+Optional for local/OpenAI-compatible servers:
+
+| Variable          | Description                                     |
+|:------------------|:------------------------------------------------|
+| `OPENAI_BASE_URL` | Custom endpoint (aka `api_base_url` in code)    |
+| `OLLAMA_HOST`     | Ollama server address (e.g., `127.0.0.1:11434`) |
+
+Optional for tracing:
+
+| Variable            | Description                                                                      |
+|:--------------------|:---------------------------------------------------------------------------------|
+| `LANGSMITH_TRACING` | Set to `true` to enable LangSmith tracing (default: `false`)                     |
+| `LANGCHAIN_PROJECT` | LangSmith project name for organizing traces                                     |
+| `LANGCHAIN_API_KEY` | API key from [smith.langchain.com](https://smith.langchain.com/settings/apikeys) |
+
+## Local Models
+
+Databao agent works great with local LLMs — your data never leaves your machine.
+
+### Ollama
+
+1. Install [Ollama](https://ollama.com/download) for your OS and make sure it’s running
+2. Use an `LLMConfig` with `name` of the form `"ollama:<model_name>"`:
+
+   ```python
+   llm_config = LLMConfig(name="ollama:gpt-oss:20b", temperature=0)
+   ```
+
+   The model will be downloaded automatically if it doesn't exist. Or run `ollama pull <model_name>` to download manually.
+
+### OpenAI-compatible servers
+
+You can use any OpenAI-compatible server by setting `api_base_url` in the `LLMConfig`.
+
+For an example, see `examples/configs/qwen3-8b-oai.yaml`.
+
+**Compatible servers:**
+* [LM Studio](https://lmstudio.ai/): macOS-friendly, supports OpenAI Responses API
+* [Ollama](https://ollama.com/): `OLLAMA_HOST=127.0.0.1:8080 ollama serve`
+* [llama.cpp](https://github.com/ggerganov/llama.cpp): `llama-server`
+* [vLLM](https://github.com/vllm-project/vllm)
+
+## Alternatives
+
+How does Databao agent compare to other agentic data tools?
+
+| Tool        | Open source | Local LLMs             | SQL + DataFrames | Multiple sources   | Interactive output |
+|-------------|-------------|------------------------|------------------|--------------------|--------------------|
+| **Databao** | ✅           | ✅ Native Ollama        | ✅ Both           | ✅ Multiple sources | ✅ Tables + charts  |
+| PandasAI    | ✅           | ✅ Ollama/LM Studio     | ✅ Both           | ❌ One source       | ❌ Static           |
+| Chat2DB     | ✅           | ✅ Custom LLM, SQL only | ❌ One DB         | ✅ Dashboards       |
+| Vanna       | ✅           | ✅ Ollama               | SQL only         | ❌ One DB           | ✅ Plotly           |
+
+## Development
+
+### Installation (using uv)
+
+Clone this repo and run:
+
+```bash
+# Install dependencies
+uv sync
+
+# Optionally include example extras (notebooks, dotenv)
+uv sync --extra examples
+```
+
+We recommend using the same version of uv as GitHub Actions:
+
+```bash
+uv self update 0.9.5
+```
+
+### Makefile targets
+
+```bash
+# Lint and static checks (pre-commit on all files)
+make check
+
+# Run tests (loads .env if present)
+make test
+```
+
+### Direct commands
+
+```bash
+uv run pytest -v
+uv run pre-commit run --all-files
+```
+
+### Tests
+
+The test suite uses pytest. Some tests require API keys and are marked with `@pytest.mark.apikey`.
+
+```bash
+# Run all tests
+uv run pytest -v
+
+# Run only tests that do NOT require API keys
+uv run pytest -v -m "not apikey"
+```
+
+## Contributing
+
+We love contributions! Here’s how you can help:
+
+- ⭐ **Star this repo** — it helps others find us!
+- 🐛 **Found a bug?** [Open an issue](https://github.com/JetBrains/databao-agent/issues)
+- 💡 **Have an idea?** We’re all ears — create a feature request
+- 👍 **Upvote issues** you care about — helps us prioritize
+- 🔧 **Submit a PR**
+- 📝 **Improve docs** — typos, examples, tutorials — everything helps!
+
+New to open source? No worries! We’re friendly and happy to help you get started.
+
+## License
+
+Apache 2.0 — use it however you want. See the [LICENSE](LICENSE.md) file for details.
+
+---
+
+<p align="center">
+ <b>Like Databao? </b> Give us a ⭐! It will help to distribute the technology.
+</p>
+
+<p align="center">
+ <a href="https://databao.app">Website</a> •
+ <a href="https://discord.gg/hEUqCcWdVh">Discord</a>
+</p>