Skip to content

Commit 0c278e7

Browse files
cpsievertCopilot
andauthored
feat(pkg-py): First pass at new website (#119)
* feat(pkg-py): First pass at new website * includes folder not used anymore * Update pkg-py/docs/build.qmd Co-authored-by: Copilot <[email protected]> * Update pkg-py/docs/build.qmd Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 2a521cb commit 0c278e7

32 files changed

+1353
-577
lines changed

pkg-py/docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
*.quarto_ipynb
55
objects.txt
66
objects.json
7+
changelog.md
78

89
# Ignore quartodoc artifacts, these are built in CI
910
_sidebar-python.yml

pkg-py/docs/CHANGELOG.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [UNRELEASED]
9+
10+
### Changes
11+
12+
* The entire functional API (i.e., `init()`, `sidebar()`, `server()`, etc) has been hard deprecated in favor of a simpler OOP-based API. Namely, the new `QueryChat()` class is now the main entry point (instead of `init()`) and has methods to replace old functions (e.g., `.sidebar()`, `.server()`, etc). (#101)
13+
14+
### New features
15+
16+
* New `QueryChat.app()` method enables quicker/easier chatting with a dataset. (#104)
17+
18+
* 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. (#104)
19+
20+
* The current SQL query and title can now be programmatically set through the `.sql()` and `.title()` methods of `QueryChat()`. (#98, #101)
21+
22+
* Added a `.generate_greeting()` method to help you create a greeting message for your querychat bot. (#87)
23+
24+
* Added `querychat_reset_dashboard()` tool for easily resetting the dashboard filters when asked by the user. (#81)
25+
26+
### Improvements
27+
28+
* Added rich tool UI support using shinychat development version and chatlas >= 0.11.1. (#67)
29+
30+
* querychat's system prompt and tool descriptions were rewritten for clarity and future extensibility. (#90)
31+
32+
## [0.2.2] - 2025-09-04
33+
34+
* Fixed another issue with data sources that aren't already narwhals DataFrames (#83)
35+
36+
## [0.2.1] - 2025-09-04
37+
38+
* Fixed an issue with the query tool when used with SQLAlchemy data sources. (@npelikan #79)
39+
40+
## [0.2.0] - 2025-09-02
41+
42+
* `querychat.init()` now accepts a `client` argument, replacing the previous `create_chat_callback` argument. (#60)
43+
44+
The `client` can be:
45+
46+
* a `chatlas.Chat` object,
47+
* a function that returns a `chatlas.Chat` object,
48+
* or a provider-model string, e.g. `"openai/gpt-4.1"`, to be passed to `chatlas.ChatAuto()`.
49+
50+
If `client` is not provided, querychat will use the `QUERYCHAT_CLIENT` environment variable, which should be a provider-model string. If the envvar is not set, querychat uses OpenAI with the default model from `chatlas.ChatOpenAI()`.
51+
52+
* `querychat.ui()` now adds a `.querychat` class to the chat container and `querychat.sidebar()` adds a `.querychat-sidebar` class to the sidebar, allowing for easier customization via CSS. (#68)
53+
54+
## [0.1.0] - 2025-05-24
55+
56+
This first release of the `querychat` package.

pkg-py/docs/_brand.yml

Lines changed: 0 additions & 48 deletions
This file was deleted.

pkg-py/docs/_quarto.yml

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
project:
22
type: website
33
output-dir: ../../docs/py
4+
pre-render:
5+
cp ../CHANGELOG.md CHANGELOG.md
46

57
website:
68
title: "querychat"
79
site-url: https://posit-dev.github.io/querychat/py
8-
description: Chat with your data in Shiny apps
10+
description: Explore data using natural language
11+
page-navigation: true
912

1013
bread-crumbs: true
1114
open-graph: true
@@ -21,43 +24,41 @@ website:
2124
[![](https://posit.co/wp-content/uploads/2024/06/Posit-Logos-2024_horiz-full-color.svg){fig-alt="Posit" width=65px}](https://posit.co)
2225
2326
navbar:
24-
left:
25-
- text: Get Started
26-
href: index.qmd
27-
- text: "Examples"
28-
href: examples/index.qmd
27+
background: "#193D56"
28+
search: true
29+
title: '<span class="ms-3 fs-3 lead" style="vertical-align:middle;">QueryChat</span>'
30+
#title: '<img src="/images/hex.png" height="40px" alt="querychat website"/><span class="ms-3 fs-3 lead header text-white" style="vertical-align:middle;">QueryChat</span>'
31+
32+
right:
2933
- text: API Reference
3034
href: reference/index.qmd
31-
32-
tools:
35+
- text: Changelog
36+
href: /changelog.html
3337
- icon: github
34-
menu:
35-
- text: Source code
36-
href: https://github.com/posit-dev/querychat/tree/main/pkg-py
37-
- text: Report a bug
38-
href: https://github.com/posit-dev/querychat/issues/new
39-
38+
href: https://github.com/posit-dev/querychat
39+
aria-label: GitHub repository
4040

4141
sidebar:
42-
- id: examples
43-
title: "Examples"
44-
style: docked
45-
type: light
46-
background: light
47-
foreground: dark
42+
- id: get-started
43+
title: Get Started
44+
style: floating
45+
align: left
4846
contents:
49-
- href: examples/index.qmd
50-
- section: "DataFrames"
51-
contents:
52-
- href: examples/pandas.qmd
53-
- section: "Databases"
54-
contents:
55-
- href: examples/sqlite.qmd
47+
- index.qmd
48+
- section: "Overview"
49+
contents:
50+
- models.qmd
51+
- data-sources.qmd
52+
- context.qmd
53+
- build.qmd
54+
- greet.qmd
55+
- tools.qmd
56+
5657

5758
format:
5859
html:
59-
theme: [brand]
60-
highlight-style: github
60+
theme:
61+
- styles.scss
6162
toc: true
6263

6364
lightbox: auto
@@ -71,18 +72,38 @@ quartodoc:
7172
sidebar: reference/_sidebar.yml
7273
css: reference/_styles-quartodoc.css
7374
sections:
74-
- title: Get Started
75-
desc: The basic building blocks of Querychat
75+
- title: The Querychat class
76+
desc: The starting point for any QueryChat session
7677
contents:
77-
- init
78-
- sidebar
79-
- server
78+
- name: QueryChat
79+
include_inherited: true
80+
- name: express.QueryChat
81+
include_inherited: true
8082

81-
- title: Customize
82-
desc: Dive deeper into customizing Querychat
83+
- title: Reactive values
84+
desc: Session-specific reactive values representing the current query
85+
contents:
86+
- types.ServerValues
87+
88+
- title: Data Sources
89+
desc: The underlying logic for managing data sources
90+
contents:
91+
- name: types.DataSource
92+
signature_name: short
93+
- name: types.DataFrameSource
94+
signature_name: short
95+
- name: types.SQLAlchemySource
96+
signature_name: short
97+
98+
- title: Tools
99+
desc: The underlying tools provided to the LLM
83100
contents:
84-
- ui
85-
- system_prompt
101+
- name: tools.tool_query
102+
signature_name: short
103+
- name: tools.tool_update_dashboard
104+
signature_name: short
105+
- name: tools.tool_reset_dashboard
106+
signature_name: short
86107

87108
filters:
88109
- "interlinks"

0 commit comments

Comments
 (0)