feat!(pkg-r): new QueryChat API (#109)

* feat(pkg-r): first pass at new QueryChat() API

* `air format` (GitHub Actions)

* `usethis::use_tidy_description()` (GitHub Actions)

* Address feedback

* Get check passing

* Add some DT/card polish to () and examples

* `air format` (GitHub Actions)

* Apply suggestions from code review

Co-authored-by: Garrick Aden-Buie <[email protected]>

* chore: rename file

* Apply suggestions from code review

Co-authored-by: Garrick Aden-Buie <[email protected]>

* chore: take renaming suggestions

* `devtools::document()` (GitHub Actions)

* fix: pass along ... correctly

* fix: don't cleanup automatically when QueryChat gets initialized outside of active session

* `devtools::document()` (GitHub Actions)

* fix: mention shiny::runExample()

* `air format` (GitHub Actions)

* `devtools::document()` (GitHub Actions)

* feat: Add querychat() and querychat_app() convenience functions

* fix: cleanup default value

* `devtools::document()` (GitHub Actions)

* feat: Add app_obj() method

* `devtools::document()` (GitHub Actions)

* fix: enforce session-specific server values by accessing through (); handle fallout and address feedback

* Address feedback

---------

Co-authored-by: cpsievert <[email protected]>
Co-authored-by: Garrick Aden-Buie <[email protected]>

Author: cpsievert

pkg-py/src/querychat/_querychat.py

@@ -67,7 +67,7 @@ def __init__(
         )
 
         # Fork and empty chat now so the per-session forks are fast
-        client = normalize_client(client)
+        client = as_querychat_client(client)
         self._client = copy.deepcopy(client)
         self._client.set_turns([])
         self._client.system_prompt = prompt
@@ -665,7 +665,7 @@ def normalize_data_source(
     return DataFrameSource(data_source, table_name)
 
 
-def normalize_client(client: str | chatlas.Chat | None) -> chatlas.Chat:
+def as_querychat_client(client: str | chatlas.Chat | None) -> chatlas.Chat:
     if client is None:
         client = os.getenv("QUERYCHAT_CLIENT", None)
 

pkg-r/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: querychat
 Title: Filter and Query Data Frames in 'shiny' Using an LLM Chat Interface
-Version: 0.0.1.9000
+Version: 0.1.0.9000
 Authors@R: c(
     person("Joe", "Cheng", , "[email protected]", role = c("aut", "cre")),
     person("Posit Software, PBC", role = c("cph", "fnd"))
@@ -23,17 +23,16 @@ Imports:
     lifecycle,
     promises,
     purrr,
+    R6,
     rlang,
     shiny,
     shinychat (>= 0.2.0.9000),
     utils,
-    whisker,
-    xtable
+    whisker
 Suggests:
     bsicons,
     DT,
     palmerpenguins,
-    R6,
     RSQLite,
     shinytest2,
     testthat (>= 3.0.0),

pkg-r/NAMESPACE

@@ -1,20 +1,23 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(as_querychat_data_source,DBIConnection)
+S3method(as_querychat_data_source,data.frame)
 S3method(cleanup_source,dbi_source)
 S3method(create_system_prompt,querychat_data_source)
 S3method(execute_query,dbi_source)
 S3method(get_db_type,data_frame_source)
 S3method(get_db_type,dbi_source)
 S3method(get_db_type,default)
 S3method(get_schema,dbi_source)
-S3method(querychat_data_source,DBIConnection)
-S3method(querychat_data_source,data.frame)
 S3method(test_query,dbi_source)
+export(QueryChat)
+export(as_querychat_data_source)
 export(cleanup_source)
 export(create_system_prompt)
 export(execute_query)
 export(get_db_type)
 export(get_schema)
+export(querychat)
 export(querychat_app)
 export(querychat_data_source)
 export(querychat_greeting)
@@ -23,4 +26,7 @@ export(querychat_server)
 export(querychat_sidebar)
 export(querychat_ui)
 export(test_query)
+importFrom(R6,R6Class)
+importFrom(bslib,sidebar)
 importFrom(lifecycle,deprecated)
+importFrom(rlang,"%||%")

pkg-r/NEWS.md

@@ -1,5 +1,8 @@
 # querychat (development version)
 
+* Nearly the entire functional API (i.e., `querychat_init()`, `querychat_sidebar()`, `querychat_server()`, etc) has been hard deprecated in favor of a simpler OOP-based API. Namely, the new `QueryChat$new()` class is now the main entry point (instead of `querychat_init()`) and has methods to replace old functions (e.g., `$sidebar()`, `$server()`, etc). (#109)
+    * In addition, `querychat_data_source()` was renamed to `as_querychat_data_source()`, and remains exported for a developer extension point, but users no longer have to explicitly create a data source. (#109)
+
 * Added `prompt_template` support for `querychat_system_prompt()`. (Thank you, @oacar! #37, #45)
 
 * `querychat_init()` now accepts a `client`, replacing the previous `create_chat_func` argument. (#60)