Skip to content

Commit

Permalink
🚀 RELEASE: v0.5.0 (#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell authored Jan 25, 2022
1 parent 065dcaf commit f9c2f33
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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 <https://jupytext.readthedocs.io>).
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
Expand Down
2 changes: 1 addition & 1 deletion jupyter_cache/__init__.py
Original file line number Diff line number Diff line change
@@ -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):
Expand Down

0 comments on commit f9c2f33

Please sign in to comment.