Skip to content

Changelog#

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

For pre-1.0 releases, see 0.0.35 Changelog

[Unreleased]#

[2.0.0] - 2023-11-06#

Changed#

  • Upgraded pydantic to 2.4.2 up from 1.X.

[1.1.5] - 2023-11-06#

Fixed#

  • Try to reduce error spam when file subscribe replies return inconsistent state events

[1.1.4] - 2023-10-23#

Added#

  • Programmatically adjust Space, Project, and Notebook/File visibility (e.g. private, open, public)

[1.1.3] - 2023-10-23#

Added#

  • Programmatically share access to Spaces, Projects, and Notebooks/Files by email and access level. E.g. await api_client.share_file(file_id, email, 'viewer')

Changed#

  • Removed RuntimeError in RTUClient catastrophic failure, top level applications (e.g. PA, Origamist) should define that behavior

[1.1.2] - 2023-10-12#

Added#

  • Environ variable NOTEABLE_RTU_URL to override RTU websocket, primarily for when apps are running in-cluster with Gate and need to use the http vs websocket service DNS

Changed#

  • Move the code logic for discovering recent version id and downloading seed Notebook from APIClient to RTUClient

[1.1.1] - 2023-10-04#

Changed#

  • rtu_client_type renamed to client_creator_type, now used both in RTU auth subscribe and when creating Files/Projects
  • RTUClient crashes if trying to instantiate with no file version id, which can happen after a Notebook has been changed from non-RTU mechanism

[1.1.0] - 2023-09-28#

Added#

  • CLI for downloading Notebooks and tailing a Notebook to see all RTU messages
  • Modeling for RTU messages that were missing
  • variable_explorer_request on Kernels channel
  • append_output_event on Files channel
  • v0_create_widget_model_event on Files channel
  • Configuration options for APIClient and e2e tests from env variables. Use NOTEABLE_TOKEN and NOTEABLE_API_URL with APIClient
  • APIClient.get_file_versions to list all versions of a file, including version id, version number, and presigned url to download content for that version
  • Updated docs for Origami 1.x syntax

Changed#

  • Raise a Runtime Error if trying to send a cell execute request when no Kernel is running
  • This is technically handled fine within Noteable and the execute is queued until Kernel starts, but is an easy foot-gun for end users

[1.0.0] - 2023-09-08#

[1.0.0-alpha.5] - 2023-08-16#

Added#

  • Optional output-for-LLM field in KernelOutput model
  • integrated_ai* message models for the kernels channel

Fixed#

  • Create RTUClient.kernel_pod_name with the right suffix

[1.0.0-alpha.4] - 2023-08-08#

Added#

  • rtu_client.update_cell_content that takes cell id and a diff-match-patch patch str

Changed#

  • Temporary guard against invalid rtu_client_type names when initiating APIClient

[1.0.0-alpha.3] - 2023-08-01#

Added#

  • origami.models.notebook.make_sql_cell convenience function, returns a CodeCell with appropriate metadata
  • rtu_client.change_cell_type to switch between code, markdown, and sql cells

Changed#

  • rtu_client.queue_execution will always return a dict of {Future: cell_id}, even on single cell execution. Also guards against executing empty code cells

[1.0.0-alpha.2] - 2023-07-26#

Changed#

  • api_client.rtu_client method renamed to api_client.connect_realtime, can accept File model in addition to str / UUID

[1.0.0-alpha.1] - 2023-07-25#

Added#

  • APIClient and RTUClient for HTTP and Websocket connections to Noteables API respectively
  • Discriminated-union Pydantic modeling for RTU and Delta payloads
  • End-to-end tests to run against a Noteable deployment