diff --git a/pkg-py/CHANGELOG.md b/pkg-py/CHANGELOG.md
index 4137ed6f..16ec6da7 100644
--- a/pkg-py/CHANGELOG.md
+++ b/pkg-py/CHANGELOG.md
@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [UNRELEASED]
+
+### New features
+
+* New `QueryChat.app()` method enables quicker/easier chatting with a dataset. (#xx)
+* Enabled bookmarking by default in both `.app()` and `.server()` methods. In latter case, you'll need to also specify the `bookmark_store` (either in `shiny.App()` or `shiny.express.app_opts()`) for it to take effect. (#xx)
+
+
## [UNRELEASED]
### Changes
diff --git a/pkg-py/src/querychat/_icons.py b/pkg-py/src/querychat/_icons.py
new file mode 100644
index 00000000..f207cff9
--- /dev/null
+++ b/pkg-py/src/querychat/_icons.py
@@ -0,0 +1,19 @@
+from typing import Literal
+
+from shiny import ui
+
+ICON_NAMES = Literal["funnel-fill", "terminal-fill", "table"]
+
+
+def bs_icon(name: ICON_NAMES) -> ui.HTML:
+ """Get Bootstrap icon SVG by name."""
+ if name not in BS_ICONS:
+ raise ValueError(f"Unknown Bootstrap icon: {name}")
+ return ui.HTML(BS_ICONS[name])
+
+
+BS_ICONS = {
+ "funnel-fill": '',
+ "terminal-fill": '',
+ "table": '',
+}
diff --git a/pkg-py/src/querychat/_querychat.py b/pkg-py/src/querychat/_querychat.py
index 0b8debb2..3896b893 100644
--- a/pkg-py/src/querychat/_querychat.py
+++ b/pkg-py/src/querychat/_querychat.py
@@ -4,9 +4,11 @@
import warnings
from typing import TYPE_CHECKING, Literal, Optional, overload
-from shiny import Inputs, Outputs, Session, module, ui
+from shiny import App, Inputs, Outputs, Session, module, reactive, render, req, ui
from shiny.session import get_current_session
+from shinychat import output_markdown_stream
+from ._icons import bs_icon
from ._querychat_impl import (
ServerResult,
init_impl,
@@ -131,6 +133,99 @@ def __init__(
self._server_initialized: bool = False
self._values: ServerResult | None = None
+ def app(
+ self, *, bookmark_store: Literal["url", "server", "disable"] = "url"
+ ) -> App:
+ """
+ Quickly chat with a dataset.
+
+ Creates a Shiny app with a chat sidebar and data table view -- providing a
+ quick-and-easy way to start chatting with your data.
+
+ Parameters
+ ----------
+ bookmark_store
+ The bookmarking store to use for the Shiny app. Options are:
+ - `"url"`: Store bookmarks in the URL (default).
+ - `"server"`: Store bookmarks on the server.
+ - `"disable"`: Disable bookmarking.
+
+ Returns
+ -------
+ :
+ A Shiny App object that can be run with `app.run()` or served with `shiny run`.
+
+ """
+ enable_bookmarking = bookmark_store != "disable"
+ table_name = self.data_source.table_name
+
+ def app_ui(request):
+ return ui.page_sidebar(
+ self.sidebar(),
+ ui.card(
+ ui.card_header(
+ ui.div(
+ ui.div(
+ bs_icon("terminal-fill"),
+ ui.output_text("query_title", inline=True),
+ class_="d-flex align-items-center gap-2",
+ ),
+ ui.output_ui("ui_reset", inline=True),
+ class_="hstack gap-3",
+ ),
+ ),
+ ui.output_ui("sql_output"),
+ fill=False,
+ style="max-height: 33%;",
+ ),
+ ui.card(
+ ui.card_header(bs_icon("table"), " Data"),
+ ui.output_data_frame("dt"),
+ ),
+ title=ui.span("querychat with ", ui.code(table_name)),
+ class_="bslib-page-dashboard",
+ fillable=True,
+ )
+
+ def app_server(input: Inputs, output: Outputs, session: Session):
+ self._server(enable_bookmarking=enable_bookmarking)
+
+ @render.text
+ def query_title():
+ return self.title() or "SQL Query"
+
+ @render.ui
+ def ui_reset():
+ req(self.sql())
+ return ui.input_action_button(
+ "reset_query",
+ "Reset Query",
+ class_="btn btn-outline-danger btn-sm lh-1 ms-auto",
+ )
+
+ @reactive.effect
+ @reactive.event(input.reset_query)
+ def _():
+ self.sql("")
+ self.title(None)
+
+ @render.data_frame
+ def dt():
+ return self.df()
+
+ @render.ui
+ def sql_output():
+ sql = self.sql() or f"SELECT * FROM {table_name}"
+ sql_code = f"```sql\n{sql}\n```"
+ return output_markdown_stream(
+ "sql_code",
+ content=sql_code,
+ auto_scroll=False,
+ width="100%",
+ )
+
+ return App(app_ui, app_server, bookmark_store=bookmark_store)
+
def sidebar(
self,
*,
@@ -186,7 +281,7 @@ def _ui_wrapper(**ui_kwargs):
return _ui_wrapper(self._id, **kwargs)
- def _server(self):
+ def _server(self, *, enable_bookmarking: bool = True) -> None:
"""
Initialize the server module.
@@ -195,17 +290,7 @@ def _server(self):
This is a private method since it is called automatically in Express mode.
"""
- # No-op if already initialized
- if self._server_initialized:
- warnings.warn(
- f"QueryChat server logic for instance '{self._id}' has already "
- "been initialized. Subsequent calls to .server() are no-ops.",
- UserWarning,
- stacklevel=2,
- )
- return
-
- # Needs be called within an active Shiny session
+ # Needs to be called within an active Shiny session
session = get_current_session()
if session is None:
raise RuntimeError(
@@ -231,6 +316,7 @@ def mod_server_wrapper(
system_prompt=self.system_prompt,
greeting=self.greeting,
client=self.client,
+ enable_bookmarking=enable_bookmarking,
)
# Call the server module
diff --git a/pkg-py/src/querychat/_querychat_impl.py b/pkg-py/src/querychat/_querychat_impl.py
index 690e12c7..6b2bb103 100644
--- a/pkg-py/src/querychat/_querychat_impl.py
+++ b/pkg-py/src/querychat/_querychat_impl.py
@@ -20,6 +20,7 @@
import chatlas
import pandas as pd
from narwhals.stable.v1.typing import IntoFrame
+ from shiny.bookmark import BookmarkState, RestoreState
ReactiveString = reactive.Value[str]
@@ -178,10 +179,12 @@ def server_impl(
system_prompt: str,
greeting: Optional[str],
client: chatlas.Chat,
+ enable_bookmarking: bool = False,
) -> ServerResult:
# Reactive values to store state
current_title = ReactiveStringOrNone(None)
current_query = ReactiveString("")
+ has_greeted = reactive.value[bool](False) # noqa: FBT003
@reactive.calc
def filtered_df():
@@ -239,6 +242,9 @@ def _():
@reactive.effect
async def greet_on_startup():
+ if has_greeted():
+ return
+
if greeting:
await chat_ui.append_message(greeting)
elif greeting is None:
@@ -248,6 +254,30 @@ async def greet_on_startup():
)
await chat_ui.append_message_stream(stream)
+ has_greeted.set(True)
+
+ if enable_bookmarking:
+ chat_ui.enable_bookmarking(client)
+
+ def _on_bookmark(x: BookmarkState) -> None:
+ vals = x.values # noqa: PD011
+ vals["querychat_current_query"] = current_query.get()
+ vals["querychat_current_title"] = current_title.get()
+ vals["querychat_has_greeted"] = has_greeted.get()
+
+ session.bookmark.on_bookmark(_on_bookmark)
+
+ def _on_restore(x: RestoreState) -> None:
+ vals = x.values # noqa: PD011
+ if "querychat_current_query" in vals:
+ current_query.set(vals["querychat_current_query"])
+ if "querychat_current_title" in vals:
+ current_title.set(vals["querychat_current_title"])
+ if "querychat_has_greeted" in vals:
+ has_greeted.set(vals["querychat_has_greeted"])
+
+ session.bookmark.on_restore(_on_restore)
+
return ServerResult(
df=filtered_df,
current_query=current_query,
diff --git a/pkg-py/src/querychat/tools.py b/pkg-py/src/querychat/tools.py
index 42aa58c9..e11dcf07 100644
--- a/pkg-py/src/querychat/tools.py
+++ b/pkg-py/src/querychat/tools.py
@@ -5,9 +5,9 @@
import chevron
from chatlas import ContentToolResult, Tool
-from htmltools import HTML
from shinychat.types import ToolResultDisplay
+from ._icons import bs_icon
from ._utils import df_to_html
if TYPE_CHECKING:
@@ -66,9 +66,7 @@ def update_dashboard(query: str, title: str) -> ContentToolResult:
title=title,
show_request=False,
open=True,
- icon=HTML(
- '',
- ),
+ icon=bs_icon("funnel-fill"),
),
},
)
@@ -142,9 +140,7 @@ def reset_dashboard() -> ContentToolResult:
title=None,
show_request=False,
open=False,
- icon=HTML(
- '',
- ),
+ icon=bs_icon("terminal-fill"),
),
},
)
@@ -213,9 +209,7 @@ def query(query: str, _intent: str = "") -> ContentToolResult:
markdown=markdown,
show_request=False,
open=True,
- icon=HTML(
- '',
- ),
+ icon=bs_icon("table"),
),
},
)
diff --git a/pyproject.toml b/pyproject.toml
index c90b99d6..90406847 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -21,7 +21,7 @@ maintainers = [
dependencies = [
"duckdb",
"pandas",
- "shiny",
+ "shiny @ git+https://github.com/posit-dev/py-shiny.git@fix/bookmark-missing-input-error",
"shinywidgets",
"htmltools",
"chatlas>=0.12.0",