Metadata-Version: 2.4
Name: querychat
Version: 0.6.0
Summary: Chat with your data using natural language
Project-URL: Homepage, https://github.com/posit-dev/querychat
Project-URL: Repository, https://github.com/posit-dev/querychat
Project-URL: Issues, https://github.com/posit-dev/querychat/issues
Project-URL: Source, https://github.com/posit-dev/querychat/tree/main/pkg-py
Author-email: Joe Cheng <joe@posit.co>, Garrick Aden-Buie <garrick@posit.co>, Carson Sievert <carson@posit.co>, Dan Chen <daniel.chen@posit.co>, Barret Schloerke <barret@posit.co>
Maintainer-email: Garrick Aden-Buie <garrick@posit.co>
License: # MIT License
        
        Copyright (c) 2026 Posit Software, PBC
        
        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.md
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.10
Requires-Dist: chatlas>=0.13.2
Requires-Dist: chevron
Requires-Dist: duckdb
Requires-Dist: great-tables>=0.16.0
Requires-Dist: htmltools
Requires-Dist: narwhals>=2.2.0
Requires-Dist: shiny>=1.6.1
Requires-Dist: shinychat>=0.3.1
Requires-Dist: sqlalchemy>=2.0.0
Provides-Extra: dash
Requires-Dist: dash-ag-grid>=31.0; extra == 'dash'
Requires-Dist: dash-bootstrap-components>=2.0; extra == 'dash'
Requires-Dist: dash[async]>=3.1; extra == 'dash'
Requires-Dist: pandas; extra == 'dash'
Provides-Extra: gradio
Requires-Dist: gradio>=6.0; extra == 'gradio'
Provides-Extra: ibis
Requires-Dist: ibis-framework>=9.0.0; extra == 'ibis'
Requires-Dist: pandas; extra == 'ibis'
Provides-Extra: pandas
Requires-Dist: pandas; extra == 'pandas'
Provides-Extra: polars
Requires-Dist: polars; extra == 'polars'
Requires-Dist: pyarrow; extra == 'polars'
Provides-Extra: streamlit
Requires-Dist: streamlit>=1.30; extra == 'streamlit'
Provides-Extra: viz
Requires-Dist: altair>=6.0; extra == 'viz'
Requires-Dist: ggsql>=0.3.1; extra == 'viz'
Requires-Dist: shinywidgets>=0.8.0; extra == 'viz'
Requires-Dist: vl-convert-python>=1.9.0; extra == 'viz'
Description-Content-Type: text/markdown

# querychat <a href="https://posit-dev.github.io/querychat/py/"><img src="https://posit-dev.github.io/querychat/images/querychat.png" align="right" height="138" alt="querychat website" /></a>

<p>
<!-- badges start -->
<a href="https://pypi.org/project/querychat/"><img alt="PyPI" src="https://img.shields.io/pypi/v/querychat?logo=python&logoColor=white&color=orange"></a>
<a href="https://choosealicense.com/licenses/mit/"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License"></a>
<a href="https://pypi.org/project/querychat"><img src="https://img.shields.io/pypi/pyversions/querychat.svg" alt="versions"></a>
<a href="https://github.com/posit-dev/querychat"><img src="https://github.com/posit-dev/querychat/actions/workflows/test.yml/badge.svg?branch=main" alt="Python Tests"></a>
<!-- badges end -->
</p>


QueryChat facilitates safe and reliable natural language exploration of tabular data, powered by SQL and large language models (LLMs). For analysts, it offers an intuitive web application where they can quickly ask questions of their data and receive verifiable data-driven answers. For software developers, QueryChat provides a comprehensive Python API to access core functionality -- including chat UI, generated SQL statements, resulting data, and more. This capability enables the seamless integration of natural language querying into bespoke data applications.

## Installation

Install the latest stable release [from PyPI](https://pypi.org/project/querychat/):

```bash
pip install querychat
```

### Web Framework Extras

querychat supports Gradio, Dash, and Streamlit. Install with the extras you need:

```bash
pip install "querychat[gradio]"
pip install "querychat[dash]"
pip install "querychat[streamlit]"
```

Or install directly from GitHub:

```bash
pip install "querychat[gradio] @ git+https://github.com/posit-dev/querychat"
```

## Quick start

The main entry point is the [`QueryChat` class](https://posit-dev.github.io/querychat/py/reference/QueryChat.html). It requires a [data source](https://posit-dev.github.io/querychat/py/data-sources.html) (e.g., pandas, polars, etc) and a name for the data.

```python
from querychat import QueryChat
from querychat.data import titanic

qc = QueryChat(titanic(), "titanic")
app = qc.app()
# app.run()
```

<p align="center">
  <img src="docs/images/quickstart.png" alt="QueryChat interface showing natural language queries" width="85%">
</p>

## Custom apps

Build your own custom web apps with natural language querying capabilities, such as [this one](https://github.com/posit-conf-2025/llm/blob/main/_solutions/25_querychat/25_querychat_02-end-app.R) which provides a bespoke interface for exploring Airbnb listings:

<p align="center">
  <img src="docs/images/airbnb.png" alt="A custom app for exploring Airbnb listings, powered by QueryChat." width="85%">
</p>

## Learn more

See the [website](https://posit-dev.github.io/querychat/py) to learn more.
