diff --git a/pkg-py/docs/.gitignore b/pkg-py/docs/.gitignore index 6fb1e2c8..7f51a5ba 100644 --- a/pkg-py/docs/.gitignore +++ b/pkg-py/docs/.gitignore @@ -4,7 +4,7 @@ *.quarto_ipynb objects.txt objects.json -changelog.md +CHANGELOG.md # Ignore quartodoc artifacts, these are built in CI _sidebar-python.yml diff --git a/pkg-py/docs/CHANGELOG.md b/pkg-py/docs/CHANGELOG.md deleted file mode 100644 index 6600542b..00000000 --- a/pkg-py/docs/CHANGELOG.md +++ /dev/null @@ -1,58 +0,0 @@ -# Changelog - -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] - -### Changes - -* 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) - -### New features - -* New `QueryChat.app()` method enables quicker/easier chatting with a dataset. (#104) - -* 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) - -* The current SQL query and title can now be programmatically set through the `.sql()` and `.title()` methods of `QueryChat()`. (#98, #101) - -* New `querychat.data` module provides sample datasets (`titanic()` and `tips()`) to make it easier to get started without external dependencies. (#118) - -* Added a `.generate_greeting()` method to help you create a greeting message for your querychat bot. (#87) - -* Added `querychat_reset_dashboard()` tool for easily resetting the dashboard filters when asked by the user. (#81) - -### Improvements - -* Added rich tool UI support using shinychat development version and chatlas >= 0.11.1. (#67) - -* querychat's system prompt and tool descriptions were rewritten for clarity and future extensibility. (#90) - -## [0.2.2] - 2025-09-04 - -* Fixed another issue with data sources that aren't already narwhals DataFrames (#83) - -## [0.2.1] - 2025-09-04 - -* Fixed an issue with the query tool when used with SQLAlchemy data sources. (@npelikan #79) - -## [0.2.0] - 2025-09-02 - -* `querychat.init()` now accepts a `client` argument, replacing the previous `create_chat_callback` argument. (#60) - - The `client` can be: - - * a `chatlas.Chat` object, - * a function that returns a `chatlas.Chat` object, - * or a provider-model string, e.g. `"openai/gpt-4.1"`, to be passed to `chatlas.ChatAuto()`. - - 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()`. - -* `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) - -## [0.1.0] - 2025-05-24 - -This first release of the `querychat` package. diff --git a/pkg-py/docs/_quarto.yml b/pkg-py/docs/_quarto.yml index d65d8205..84aa019d 100644 --- a/pkg-py/docs/_quarto.yml +++ b/pkg-py/docs/_quarto.yml @@ -33,7 +33,7 @@ website: - text: API Reference href: reference/index.qmd - text: Changelog - href: /changelog.html + href: /CHANGELOG.html - icon: github href: https://github.com/posit-dev/querychat aria-label: GitHub repository