Skip to content

v0.5.0

Choose a tag to compare

View all tags
@chrisjsewell chrisjsewell released this 25 Jan 11:37
v0.5.0
f9c2f33
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

What's Changed

♻️ REFACTOR: package API/CLI/documentation (#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.

Full Changelog: v0.4.3...v0.5.0

Assets 2
Loading