https://github.com/kracekumar/jut

Render Jupyter notebook in the terminal
https://github.com/kracekumar/jut

cli jupyter-notebook python python-rich

Last synced: about 2 months ago
JSON representation

Render Jupyter notebook in the terminal

• Host: GitHub
• URL: https://github.com/kracekumar/jut
• Owner: kracekumar
• Created: 2021-03-18T16:59:23.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-07-23T20:55:06.000Z (almost 2 years ago)
• Last Synced: 2024-05-03T13:24:55.888Z (about 2 months ago)
• Topics: cli, jupyter-notebook, python, python-rich
• Language: Python
• Homepage:
• Size: 1.73 MB
• Stars: 174
• Watchers: 6
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Lists

• awesome-jupyter - jut - CLI to nicely display notebooks in the terminal. (Rendering/Publishing/Conversion)
• awesome-stars - kracekumar/jut - Render Jupyter notebook in the terminal (Python)

README

        
`jut - JUpyter notebook Terminal viewer`.

The command line tool view the IPython/Jupyter notebook in the terminal.

### Install

`pip install jut`

### Usage

``` shell

$jut --help

Usage: cli.py [OPTIONS] PATH

Options:

  -he, --head INTEGER RANGE  Display first n cells. Default is 10

  -t, --tail INTEGER RANGE   Display last n cells

  -p, --single-page          Should the result be in a single page?

  -f, --full-display         Should all the contents in the file displayed?

  --force-colors             Force colored output even if stdout is not a

                             terminal

  -s, --start INTEGER RANGE  Display the cells starting from the cell number

  -e, --end INTEGER RANGE    Display the cells till the cell number

  --exclude-output-cells     Exclude the notebook output cells from the output

  --no-cell-border           Don't display the result in a cell with border

  --help                     Show this message and exit.

```

### ASCIICinema Demo (First version)

[![asciicast](https://asciinema.org/a/400349.svg)](https://asciinema.org/a/400349)

Note: Command line arguments may be different, use `jut --help` to get upto date command line options

### Display first five cells

![jut-head-example](https://raw.githubusercontent.com/kracekumar/jut/main/images/jut-head.png)

### Display last five cells

![jut-tail-example](https://raw.githubusercontent.com/kracekumar/jut/main/images/jut-tail.png)

### Download the file and display first five cells

![jut-download-url](https://raw.githubusercontent.com/kracekumar/jut/main/images/jut-download.png)

### Usage

``` shell

$jut debug/file.ipynb

...

$jut https://raw.githubusercontent.com/fastai/fastbook/master/06_multicat.ipynb --tail 10

...

```