boterview v1.3.0

What's Changed

• Add CLI functionality to print the package version by @mihaiconstantin in #35
• Add documentation via VitePress by @mihaiconstantin in #36
• Add GitHub workflow to deploy documentation to Github Pages by @mihaiconstantin in #38
• Fix documentation CI workflow by @mihaiconstantin in #39
• Miscellaneous documentation changes by @mihaiconstantin in #40
• Miscellaneous documentation design changes by @mihaiconstantin in #41
• Add support for markdown parsing and styling in the UI by @mihaiconstantin in #43
• Miscellaneous refactoring by @mihaiconstantin in #44
• Release 1.3.0 by @mihaiconstantin in #45

Changelog

Added

• Add --version option to boterview CLI command to display the current version of the package.
• Add documentation.yaml GitHub workflow file for deploying the boterview documentation to GitHub Pages on push to the main branch.
• Add preliminary documentation via VitePress. The documentation setup is complete, only the content needs working on.

Changed

• Changed markdown parsing for the UI pages content to rely on remark-gfm for better support of GitHub Flavored Markdown (GFM) features (e.g., tables, task or lists). Now, it is also possible to combine markdown and HTML in the UI content.

Full Changelog: v1.2.0...v1.3.0

boterview v1.2.0

What's Changed

• Miscellaneous refactoring by @mihaiconstantin in #29
• Allow the timeout (i.e., and /page redirection) to be optional by @mihaiconstantin in #31
• Various frontend refactoring by @mihaiconstantin in #32
• Release 1.2.0 by @mihaiconstantin in #33

Changelong

Added

• Add functionality to disable the timeout (i.e., and automatic page reload from the stop page to the welcome page). If the user specifies a timeout of 0, or a negative value, the timeout will be disabled. This can be useful for studies that require participants to perform additional tasks after the interview. Closes #30.
• Add default index route / for when the server is started in headless model. This route outputs a JSON response indicating that the server is running in headless mode.

Changed

• Update useVerifyParticipantCode hook to explicit mark any previous consent as invalid upon participant code verification. This change ensures that the participant is required to re-consent if they provide a new code.
• Remove superfluous period in default footer text.
• Update boterview preview command in README.md reflect that the default to scaffolded condition is now named "Condition 1".

Full Changelog: v1.1.0...v1.2.0

boterview v1.1.0

What's Changed

• Allow application to be served from any URL by @mihaiconstantin in #19
• Ensure cookie names are correctly parsed by @mihaiconstantin in #20
• Miscellaneous frontend changes by @mihaiconstantin in #21
• Disable chainlit automatic scroll to message by @mihaiconstantin in #22
• Build-related changes by @mihaiconstantin in #23
• Ensure the interview remains robust in the face of chat page reloading by @mihaiconstantin in #26
• Update default values for the configuration template by @mihaiconstantin in #27
• Release 1.1.0 by @mihaiconstantin in #28

Changelog

Added

• Add functionality to reconstruct the message history and repopulate the chat interface based on the conversations stored in the database. This feature makes the interview more robust to interruptions (e.g., page reloads). Fixes #24.

Changed

• Update default paths in template to /interface for UI content files, and /interview for interview files.
• Update pyproject.toml to exclude CNAME from source distribution build.
• Disable automatic scrolling to message in the chat window. This behavior was added after a recent update to chainlit (i.e., see this issue).
• Various improvements to the frontend application.

Fixed

• Fix participants getting reassigned to a new condition each time the chat page was reloaded. Closes #24.
• Fix issue with cookie names not being parsed correctly in Safari due to extra whitespace. Closes #18.
• Fix issue with hardcoded localhost URL. Now, the application can be served from any domain. The recommended way is to serve the static files from the same domain as the backend. However, one can also serve the static files from a different domain, in which case a reverse proxy should be used to prevent any CORS issues. In development, the vite server for the frontend is configured to proxy requests to the backend (i.e., the backend URL is provided to the frontend server via the .env.development file located at /frontend/app/.env.development). Closes #17.

Full Changelog: v1.0.3...v1.1.0

boterview v1.0.3

What's Changed

• Add markdown support for UI content by @mihaiconstantin in #14
• Update default application content by @mihaiconstantin in #15
• Release 1.0.3 by @mihaiconstantin in #16

Changelog

Added

• Add markdown support in PageContent component. When the UI content is not provided as HTML, the component will render the content as markdown paragraphs, with support for various formatting options. The processing is done using the react-markdown library.

Changed

• Update default UI content to feature markdown formatting for the introduction and consent pages.
• Update default system prompt to ensure the LLM does not copy the interview document to the chat.

Full Changelog: v1.0.2...v1.0.3

boterview v1.0.2

What's Changed

• Miscellaneous documentation changes by @mihaiconstantin in #13

Changelog

Changed

• Update badges in README.md.
• Update heading capitalization in CHANGELOG.md.

Full Changelog: v1.0.1...v1.0.2

boterview v1.0.1

What's Changed

• Miscellaneous documentation changes by @mihaiconstantin in #12

Changelog

Changed

• Update build artifacts to exclude unnecessary assets/ directory.
• Update logo path in README.md to use use the GitHub raw link.
• Remove the CC license images from the README.md file do to rendering issues on PyPI.

Full Changelog: v1.0.0...v1.0.1

boterview v1.0.0

What's Changed

• Add main application services by @mihaiconstantin in #1
• Update appplication content and configuration template by @mihaiconstantin in #2
• Add application frontend by @mihaiconstantin in #3
• Add chainlit frontend overrides by @mihaiconstantin in #4
• Add application backend by @mihaiconstantin in #5
• Add chat functionality via chainlit by @mihaiconstantin in #6
• Expand the boterview CLI commands by @mihaiconstantin in #7
• Update the build process to handle the frontend by @mihaiconstantin in #8
• Update README and CHANGELOG by @mihaiconstantin in #11

New Contributors

• @mihaiconstantin made their first contribution in #1

Changelog

Added

• Add service classes (i.e., Boterview, Study, Counter, Prompt, Condition, Interview, Guide, Introduction, Protocol, and Question) to manage study logic, participant assignment, and configuration.
• Add React frontend, including various components, pages, and hooks.
• Integrate chainlit lifecycle chat events (i.e., start, stop, message, and authentication) using an OpenAI async client.
• Add package CLI commands to:
  • generate a new study, application secret, and participation codes
  • parse study data to markdown
  • preview study conditions
  • run the study server
• Implement backend in FastAPI, including several API routes for participant authentication, consent, chat handling, and UI content retrieval.
• Add several database models for Participant, Conversation, and Configuration.
• Add several payload models for API request and response handling.
• Add helper functions for general utilities.
• Add helper functions for creating and decoding JWT tokens, as well as for parsing cookies to support secure authentication flows.
• Add helper functions to manage chainlit events, such as retrieving message history, sending stop messages, and determining when a conversation should end.
• Add helper functions for common database operations.
• Add context managers to ensure several objects are properly initialized when shared across the application.
• Add several services to manage core application logic, configuration, and study data.
• Add hatch build hook to prepare frontend assets for packaging.
• Add pyproject.toml build configuration to manage frontend assets and ensure proper packaging.
• Add chainlit configuration file with sensible defaults.
• Add chainlit styling overrides, theme, favicon, and translation files.
• Add option to intercept chainlit custom action events.

Changed

• Refactored core services (Study, Boterview, Configuration, etc.) into dedicated modules under services/ (previously under backend/).
• Improved error handling, updated documentation, and optimized configuration handling.

Fixed

• Ensure the template TOML generation uses POSIX path separators.

Security

• Implement JWT authentication and token handling.
• Add HTML sanitization for UI content provided by users via the study files.
• Implement route protections to prevent study participants from skipping verification and consent steps.

Full Changelog: https://github.com/mihaiconstantin/boterview/commits/v1.0.0