Skip to content

Commit f9c2f33

Browse files
authored
🚀 RELEASE: v0.5.0 (#81)
1 parent 065dcaf commit f9c2f33

File tree

2 files changed

+26
-1
lines changed

2 files changed

+26
-1
lines changed

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,30 @@
11
# CHANGELOG
22

3+
## 0.5.0 - 2021-01-25
4+
5+
♻️ REFACTOR: package API/CLI/documentation ([#74](https://github.com/executablebooks/jupyter-cache/pull/74))
6+
7+
This release includes major re-writes to key parts of the package,
8+
to improve the user interface, and add additional functionality for reading and executing notebooks.
9+
10+
Key changes:
11+
12+
1. `stage`/`staging` is now rephrased to `notebook`, plus the addition of `project`, i.e. you add notebooks to a project, then execute them.
13+
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>).
14+
Before, the read functions were passed directly to the API methods.
15+
3. The executor can be specified with `jbcache execute --executor`, and a parallel notebook executor has been added.
16+
4. Improved execution status indicator in `jbcache project list` and other CLI improvements.
17+
5. Re-write of documentation, including better front page, with quick start guide and better logo.
18+
19+
Dependencies have also been restructured, such that the CLI dependencies (`click`, `tabulate`) are now required,
20+
whereas `nbdime` is now optional (since it is only used for optional notebook diffing).
21+
22+
‼️ Breaking:
23+
24+
The name of the SQL table `nbstage` has been changed to `nbproject`, and `read_data`/`exec_data` fields have been added to the `nbproject`.
25+
This means that reading will fail for caches creted using older versions of the package.
26+
However, the version of `jupyter-cache`, used to create the cache, is now recorded, allowing for the possibility of future automated migrations.
27+
328
## 0.4.3 - 2021-07-29
429

530
⬆️ Allow SQLAlchemy v1.4

jupyter_cache/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# NOTE: never import anything here, in order to maintain CLI speed
2-
__version__ = "0.4.3"
2+
__version__ = "0.5.0"
33

44

55
def get_cache(path, cache_cls=None):

0 commit comments

Comments
 (0)