From f9c2f333169afb78db26ec6aedf892a0770aca72 Mon Sep 17 00:00:00 2001 From: Chris Sewell Date: Tue, 25 Jan 2022 12:36:42 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=80=20RELEASE:=20v0.5.0=20(#81)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 25 +++++++++++++++++++++++++ jupyter_cache/__init__.py | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c35ee5f..e98ff03 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,30 @@ # CHANGELOG +## 0.5.0 - 2021-01-25 + +♻️ REFACTOR: package API/CLI/documentation ([#74](https://github.com/executablebooks/jupyter-cache/pull/74)) + +This release includes major re-writes to key parts of the package, +to improve the user interface, and add additional functionality for reading and executing notebooks. + +Key changes: + +1. `stage`/`staging` is now rephrased to `notebook`, plus the addition of `project`, i.e. you add notebooks to a project, then execute them. +2. notebook `read_data` is specified per notebook in the project, allowing for multiple types of file to be read/executed via the CLI (e.g. text-based notebooks via ). + Before, the read functions were passed directly to the API methods. +3. The executor can be specified with `jbcache execute --executor`, and a parallel notebook executor has been added. +4. Improved execution status indicator in `jbcache project list` and other CLI improvements. +5. Re-write of documentation, including better front page, with quick start guide and better logo. + +Dependencies have also been restructured, such that the CLI dependencies (`click`, `tabulate`) are now required, +whereas `nbdime` is now optional (since it is only used for optional notebook diffing). + +‼️ Breaking: + +The name of the SQL table `nbstage` has been changed to `nbproject`, and `read_data`/`exec_data` fields have been added to the `nbproject`. +This means that reading will fail for caches creted using older versions of the package. +However, the version of `jupyter-cache`, used to create the cache, is now recorded, allowing for the possibility of future automated migrations. + ## 0.4.3 - 2021-07-29 ⬆️ Allow SQLAlchemy v1.4 diff --git a/jupyter_cache/__init__.py b/jupyter_cache/__init__.py index 189d48a..9d29081 100644 --- a/jupyter_cache/__init__.py +++ b/jupyter_cache/__init__.py @@ -1,5 +1,5 @@ # NOTE: never import anything here, in order to maintain CLI speed -__version__ = "0.4.3" +__version__ = "0.5.0" def get_cache(path, cache_cls=None):