Skip to content

Releases: paw-lu/nbpreview

v0.9.1

14 Aug 19:08
a027c24
Compare
Choose a tag to compare

Changes

👷 Continuous Integration

📚 Documentation

  • Update term-image package name in documentation (#572) @paw-lu

🔨 Refactoring

📦 Dependencies

v0.9.0

20 Apr 00:24
a7212ed
Compare
Choose a tag to compare

Overview

Two main user-facing changes:

README previews

The GitHub README is now full of generated SVGs that illustrate the different types of aspects of a notebook nbpreview can render.

Rich compatibility

Older versions of nbpreview were incompatible with newer versions of Rich. Usage has been updated to stay in sync with the newest version of the Rich API.

Changes

📚 Documentation

  • Move Requirements and Installation section to top of README (#569) @paw-lu
  • Remove Features section preamble (#568) @paw-lu
  • Make wording on nbpreview citation more consistent with other citations (#566) @paw-lu
  • fix security badge (#565) @paw-lu
  • Add SVG previews to README (#564) @paw-lu

📦 Dependencies

v0.8.3

31 Mar 13:37
a569062
Compare
Choose a tag to compare

Overview

Make nbpreview compatible with newer versions of Click. Typer has fixed its issues with newer versions of Click, so Typer has been updated, and Click is unpinned.

Changes

📦 Dependencies

v0.8.2

29 Mar 02:49
f3bb9b5
Compare
Choose a tag to compare

Overview

Patch release that pins Click to <8.1.0 to work around Typer incompatibility. If you are getting tracebacks with the message

ImportError: cannot import name 'get_terminal_size' from 'click.termui'

upgrade to 0.8.2 to fix this.

We expect to later remove this constraint after Typer is updated.

🪲 Fixes

👷 Continuous Integration

📚 Documentation

📦 Dependencies

v0.8.1

13 Mar 19:02
aedbdd3
Compare
Choose a tag to compare

Overview

Bugfix release.

Before nbpreview would raise an exception if HTML output contained an encoded image in text.

<img src="data:image/png;base64,iVBOR…/>

This release prevents nbpreview from raising an exception in this general case, and additionally ads support for decoding and rendering these types of links.

Lastly, nbformat has a new release that changed some internals that prevented nbpreview from detecting bad notebook files. nbformat's logic has updated to keep up with the changes and validate notebooks properly.

Changes

🚀 Features

🪲 Fixes

📦 Dependencies

v0.8.0

10 Mar 04:15
6bcd72c
Compare
Choose a tag to compare

Overview

The biggest change here is that term-img is now used to render --image-drawing=block drawings. For the user, this now means

  1. --image-drawing=block may be run on Windows now
  2. --image-drawing=block is faster now

If nbpreview thinks the terminal can support it, --image-drawing=block is now the default drawer.

Check out some previews of the new block drawings in the docs!

Changes

🚀 Features

🪲 Fixes

📚 Documentation

💄 Style

📦 Dependencies

v0.7.2

02 Mar 19:46
bd818d5
Compare
Choose a tag to compare

Overview

This release unifies documentation differences across PyPI, GitHub, and Read the Docs.

Additionally CI for macOS and Windows is updated to run on Python 3.10.

Changes

🪲 Fixes

👷 Continuous Integration

  • Update macOS and Windows CI to Python 3.10 (#473) @paw-lu

📚 Documentation

v0.7.1

02 Mar 05:14
c172728
Compare
Choose a tag to compare

Overview

Small release that focuses on making HTML content more helpful.

First, nbpreview will try not to render HTML content if a useful text version is already present. There were cases where nbpreview would try to parse and print the HTML output, where the output already had a perfectly good plaintext representation.

Second, there is now a minimum column width for rendered DataFrames. Before, nbpreview would try to fit all columns in the terminal, which would just result in many illegible squished columns. Now we prefer to at least see the first few and then let the remaining columns be cutoff.

Finally --plain / -p no longer affects how DataFrame are rendered. You can now still use plain stying with --plain, and still get rich renderings of DataFrame.

Changes

🚀 Features

  • Do not render HTML if a custom repr is present (#466) @paw-lu
  • Set minimum column width for DataFrame (#460) @paw-lu

📦 Dependencies

v0.7.0

26 Feb 19:14
dc4bfd7
Compare
Choose a tag to compare

Overview

This is a documentation focused release. The full docs are hosted at
https://nbpreview.readthedocs.io/en/latest/.

Thanks to Rich, the documentation is full of generated HTML examples of the terminal output. This should allow us to automate example updates as things change, instead of manually having to grab screenshots.

Changes

🚀 Features

🪲 Fixes

👷 Continuous Integration

📚 Documentation

📦 Dependencies

v0.6.0

09 Jan 19:16
a180dda
Compare
Choose a tag to compare

Oveview

This release focuses on making nbpreview look and work well across a large variety of machines, terminals, and themes. Many defaults, colors, and themes were changed to accommodate this goal.

In addition, the CLI experience was also improved. There are two major changes to highlight:

  1. nbpreview can now take in multiple files for the FILE argument. This is especially handy when combined with globbing:

    % nbpreview *.ipynb

    nbpreview will also render notebooks slightly different when it has multiple arguments passed to it—it will give the filename on top and draw a border around each file to distinguish different notebooks. See #348 for more details.

  2. nbpreview can now render notebooks from stdin. This is really useful if you get the notebook text from somewhere else—like the web.

    % curl https://raw.githubusercontent.com/paw-lu/nbpreview/main/tests/unit/assets/notebook.ipynb | nbp

    See #336 for more details.

See below for a more detailed description of each change!

Changes

🚀 Features

🪲 Fixes

  • Rename positive space option short alias from -p to -s (#370) @paw-lu
  • Fix color system not defaulting to auto (#354) @paw-lu

👷 Continuous Integration

📚 Documentation

🔨 Refactoring

  • Move parameter validation and transformation to parameter callbacks (#349) @paw-lu
  • Refactor CLI parameters code (#330) @paw-lu

📦 Dependencies