Merge pull request #104 from posit-dev/feat-assistant

feat: add the `assistant()` function to chat with the API

Author: rich-iannone

.github/workflows/ci-tests.yaml

@@ -29,7 +29,7 @@ jobs:
           pip install -e '.[dev]'
       - name: Install test dependencies
         run: |
-          pip install pytest pytest-cov pytest-snapshot pandas polars ibis-framework[duckdb,mysql,postgres,sqlite]>=9.5.0 chatlas
+          pip install pytest pytest-cov pytest-snapshot pandas polars ibis-framework[duckdb,mysql,postgres,sqlite]>=9.5.0 chatlas shiny
       - name: pytest unit tests
         run: |
           make test

docs/_quarto.yml

@@ -166,15 +166,17 @@ quartodoc:
         - name: Validate.warning
         - name: Validate.error
         - name: Validate.critical
-    - title: Inspect
+    - title: Inspection and Assistance
       desc: >
-        The *Inspect* group contains functions that are helpful for getting to grips on a new data
-        table. Use the `DataScan` class to get a quick overview of the data, `preview()` to see the
-        first and last few rows of a table, `col_summary_tbl()` for a column-level summary of a
-        table, `missing_vals_tbl()` to see where there are missing values in a table, and
-        `get_column_count()`/`get_row_count()` to get the number of columns and rows in a table.
-        Several datasets included in the package can be accessed via the `load_dataset()` function.
-        Finally, the `config()` utility lets us set global configuration parameters.
+        The *Inspection and Assistance* group contains functions that are helpful for getting to
+        grips on a new data table. Use the `DataScan` class to get a quick overview of the data,
+        `preview()` to see the first and last few rows of a table, `col_summary_tbl()` for a
+        column-level summary of a table, `missing_vals_tbl()` to see where there are missing values
+        in a table, and `get_column_count()`/`get_row_count()` to get the number of columns and rows
+        in a table. Several datasets included in the package can be accessed via the
+        `load_dataset()` function. Finally, the `config()` utility lets us set global configuration
+        parameters. Want to chat with an assistant? Use the `assistant()` function to get help with
+        Pointblank.
       contents:
         - name: DataScan
         - name: preview
@@ -184,3 +186,4 @@ quartodoc:
         - name: get_row_count
         - name: load_dataset
         - name: config
+        - name: assistant

pointblank/__init__.py

@@ -9,6 +9,7 @@
     __version__ = "0.0.0"
 
 # Import objects from the module
+from pointblank.assistant import assistant
 from pointblank.column import (
     col,
     contains,
@@ -35,6 +36,7 @@
 )
 
 __all__ = [
+    "assistant",
     "TF",
     "Validate",
     "Thresholds",

pointblank/_utils.py

@@ -521,11 +521,13 @@ def _get_api_text() -> str:
     inspect_exported = [
         "DataScan",
         "preview",
+        "col_summary_tbl",
         "missing_vals_tbl",
         "get_column_count",
         "get_row_count",
         "load_dataset",
         "config",
+        "assistant",
     ]
 
     validate_desc = """When peforming data validation, you'll need the `Validate` class to get the
@@ -551,12 +553,14 @@ def _get_api_text() -> str:
 report table (by printing the object or using `get_tabular_report()`), extract key metrics, or we
 can split the data based on the validation results (with `get_sundered_data()`)."""
 
-    inspect_desc = """The *Inspect* group contains functions that are helpful for getting to grips
-on a new data table. Use the `DataScan` class to get a quick overview of the data, `preview()` to
-see the first and last few rows of a table, `missing_vals_tbl()` to see where there are missing
-values in a table, and `get_column_count()`/`get_row_count()` to get the number of columns and rows
-in a table. Several datasets included in the package can be accessed via the `load_dataset()`
-function. Finally, the `config()` utility lets us set global configuration parameters."""
+    inspect_desc = """The *Inspection and Assistance* group contains functions that are helpful for
+getting to grips on a new data table. Use the `DataScan` class to get a quick overview of the data,
+`preview()` to see the first and last few rows of a table, `col_summary_tbl()` for a column-level
+summary of a table, `missing_vals_tbl()` to see where there are missing values in a table, and
+`get_column_count()`/`get_row_count()` to get the number of columns and rows in a table. Several
+datasets included in the package can be accessed via the `load_dataset()` function. Finally, the
+`config()` utility lets us set global configuration parameters. Want to chat with an assistant? Use
+the `assistant()` function to get help with Pointblank."""
 
     #
     # Add headings (`*_desc` text) and API details for each family of functions/methods