querychat 0.1.0__py3-none-any.whl

querychat-0.1.0.dist-info/METADATA

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: querychat
+Version: 0.1.0
+Summary: Chat with your data using natural language
+Project-URL: Homepage, 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/python-package
+Author-email: Posit <info@posit.co>
+License: # MIT License
+        
+        Copyright (c) 2025 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
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Requires-Dist: chatlas
+Requires-Dist: duckdb
+Requires-Dist: htmltools
+Requires-Dist: narwhals
+Requires-Dist: pandas
+Requires-Dist: shiny
+Requires-Dist: shinywidgets
+Description-Content-Type: text/markdown
+
+# querychat for Python
+
+Chat with your Shiny Python apps using natural language.
+
+Imagine typing questions like these directly into your Shiny dashboard, and seeing the results in realtime:
+
+* "Show only data from 2008 with highway MPG greater than 30."
+* "What's the average city MPG for SUVs vs compact cars?"
+* "Sort the data by highway fuel efficiency descending."
+
+## Installation
+
+```bash
+pip install "querychat @ git+https://github.com/posit-dev/querychat#subdirectory=python-package"
+```
+
+## How to use
+
+First, you'll need access to an LLM that supports tools/function calling. querychat uses [chatlas](https://github.com/posit-dev/chatlas) to interface with various providers.
+
+Here's a minimal example (see [examples/app.py](examples/app.py) for an unabridged version):
+
+```python
+from pathlib import Path
+
+from seaborn import load_dataset
+from shiny import App, render, ui
+
+import querychat
+
+titanic = load_dataset("titanic")
+
+# 1. Configure querychat
+querychat_config = querychat.init(titanic, "titanic")
+
+# Create UI
+app_ui = ui.page_sidebar(
+    # 2. Place the chat component in the sidebar
+    querychat.sidebar("chat"),
+    # Main panel with data viewer
+    ui.output_data_frame("data_table"),
+    title="querychat with Python",
+    fillable=True,
+)
+
+
+# Define server logic
+def server(input, output, session):
+    # 3. Initialize querychat server with the config from step 1
+    chat = querychat.server("chat", querychat_config)
+
+    # 4. Display the filtered dataframe
+    @render.data_frame
+    def data_table():
+        # Access filtered data via chat.df() reactive
+        return chat["df"]()
+
+
+# Create Shiny app
+app = App(app_ui, server)
+```
+
+## Features
+
+querychat uses LLMs to generate SQL queries from natural language, offering:
+
+- **Reliability**: LLMs are excellent at writing SQL but bad at direct calculation
+- **Transparency**: SQL is always displayed to the user
+- **Reproducibility**: Generated SQL can be copied and reused elsewhere
+
+## Customization
+
+### Configure with your own data
+
+```python
+querychat_config = querychat.init(
+    df=my_dataframe,
+    table_name="my_data",  # Optional: defaults to "data"
+    greeting="Welcome! Ask me anything about the data.",
+    data_description="""
+    This dataset contains information about...
+    - column1: Description of column 1
+    - column2: Description of column 2
+    """,
+    extra_instructions="Please use British English spelling conventions."
+)
+```
+
+### Use a different LLM provider
+
+You can change the LLM provider or model by providing a callback function that takes a `system_prompt` argument and returns a `chatlas.Chat` object. (The parameter must be called  `system_prompt` as it is passed by keyword.)
+
+```python
+import chatlas
+
+def my_chat_func(system_prompt: str) -> chatlas.Chat:
+    return chatlas.ChatAnthropic(
+        model="claude-3-5-sonnet-latest",
+        system_prompt=system_prompt
+    )
+
+querychat_config = querychat.init(
+    df=my_dataframe,
+    create_chat_callback=my_chat_func
+)
+```
+
+## How it works
+
+querychat works by:
+
+1. Converting your pandas DataFrame to a DuckDB table
+2. Creating a system prompt with your data schema
+3. Setting up tools that let the LLM execute SQL queries
+4. Processing natural language to SQL queries
+5. Returning filtered data to your Shiny app
+
+See the `examples/` directory for more complete examples.

querychat-0.1.0.dist-info/RECORD

@@ -0,0 +1,4 @@
+querychat-0.1.0.dist-info/METADATA,sha256=jsh46OYtxbQbkLvCakocorDlJFFDqe3FqAGfd69mrvk,5549
+querychat-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+querychat-0.1.0.dist-info/licenses/LICENSE,sha256=hZ84bObCqILwvQp6hoBRpXZvgYDJaoVEsODFJaSlVQQ,1078
+querychat-0.1.0.dist-info/RECORD,,

querychat-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

querychat-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2025 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.