Ipylivebash - Run shell script in Jupyter with live output

Last update: Aug 27, 2022

Related tags

Overview

ipylivebash

ipylivebash is a library to run shell script in Jupyter with live output.

Example

%%livebash --save log.txt --save-timestamp

find .

Run find . and show the output in the Jupyter notebook and also save to log-${current_timestamp}.txt

%%livebash --ask-confirm --notify
set -e
deploy_script

Before running the deploy_script show a panel to ask for confirmation. Once it is finished, show a notification.

Features

Run shell script in Jupyter with live output
The output in the notebook cell is not saved in the notebook by default
Support to save the output to a file. If the file already exists, it will pick another name automatically.
Support to show a confirmation UI before executing the script
Support to send a notification when the script finishes.

Usage

usage: livebash [-h] [--save OUTPUT_FILE] [--save-timestamp]
                [--line-limit LINE_LIMIT] [--height HEIGHT] [--ask-confirm]
                [--notify] [--keep-cell-output]

optional arguments:
  -h, --help
  --save OUTPUT_FILE    Save output to a file
  --save-timestamp      Add timestamp to the output file name
  --line-limit LINE_LIMIT
                        Restrict the no. of lines to be shown
  --height HEIGHT       Set the height of the output cell
  --ask-confirm         Ask for confirmation before execution
  --notify              Send a notification when the script finished
  --keep-cell-output    Keep the cell output

Options

--save OUTPUT_FILE

Save the output to a file.

If the file name already exists, it will add a suffix to avoid overriding the original file.

--save-timestamp

Add timestamp to the output file name.

--line-limit LINE_LIMIT

If the no. of line output exceed the limit, it may be truncated. It will show the last 5 lines only.

--height HEIGHT

Set the height of the output cell

--ask-confirm

Ask for confirmation before execution

--notify

Send a notification when the script finished

--keep-cell-output

Keep the cell output such that it could be saved together with the notebook. It can't be used with other options like --line-limit.

Installation

You can install using pip:

pip install ipylivebash

If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable the nbextension:

jupyter nbextension enable --py [--sys-prefix|--user|--system] ipylivebash

Development Installation

Create a dev environment:

conda create -n ipylivebash-dev -c conda-forge nodejs yarn python jupyterlab
conda activate ipylivebash-dev

Install the python. This will also build the TS package.

pip install -e ".[test, examples]"

When developing your extensions, you need to manually enable your extensions with the notebook / lab frontend. For lab, this is done by the command:

jupyter labextension develop --overwrite .
yarn run build

For classic notebook, you need to run:

jupyter nbextension install --sys-prefix --symlink --overwrite --py ipylivebash
jupyter nbextension enable --sys-prefix --py ipylivebash

Note that the --symlink flag doesn't work on Windows, so you will here have to run the install command every time that you rebuild your extension. For certain installations you might also need another flag instead of --sys-prefix, but we won't cover the meaning of those flags here.

How to see your changes

Typescript:

If you use JupyterLab to develop then you can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the widget.

# Watch the source directory in one terminal, automatically rebuilding when needed
yarn run watch
# Run JupyterLab in another terminal
jupyter lab

After a change wait for the build to finish and then refresh your browser and the changes should take effect.

Python:

If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.

You might also like...

Output Analyzer for you terminal commands

Comments

Problem in kubectl outputs

HI,

first of all: thanks for this extesion, it helps a lot.

But there seems to be an issue if the output comes too fast or something. It might be the debouncing? The output is only printed after I terminate the line or a new pod is created.

%%livebash
kubectl get pods -w

It works if I use the following code:

import subprocess
import shlex
def run_command(command):
    process = subprocess.Popen(shlex.split(command), stdout=subprocess.PIPE)
    while True:
        output = process.stdout.readline()
        if output == '' and process.poll() is not None:
            break
        if output:
            print(output.strip().decode("utf-8") )
    rc = process.poll()
    return rc

run_command("kubectl get pods -w")

opened by smerschjohann 2

Ipylivebash - Run shell script in Jupyter with live output

Related tags

Overview

ipylivebash

Options

Installation

Development Installation

How to see your changes

Typescript:

Python:

You might also like...

Output Analyzer for you terminal commands

Python Processing Tool for Vasp Ipnut/Output

Runs a command in P4wnP1 and displays the output on OLED screen (SH1106)

Tablicate - Python library for easy table creation and output to terminal

Format click help output nicely with rich.

xonsh is a Python-powered, cross-platform, Unix-gazing shell

adds flavor of interactive filtering to the traditional pipe concept of UNIX shell

xonsh is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.

Fetch is use to get information about anything on the shell using Wikipedia.

Comments

Problem in kubectl outputs

Releases(release/0.1.2)

release/0.1.2(Jan 27, 2022)

release/0.1.1(Jan 8, 2022)

release/0.1.0(Jan 2, 2022)

Owner

Ben Lau

texel - Command line interface for reading spreadsheets inside terminal

commandline version of wordle game and my auto solver.

A CLI Application to detect plagiarism in Source Code Files.

This a simple tool to query the awesome ippsec.rocks website from your terminal

A simple automation script that logs into your kra account and files your taxes with one command

This CLI give the possibility to do a queries in Star Wars API and returns a JSON in a terminal.

Free and Open-Source Command Line tool for Text Replacement

Limit your docker image size with a simple CLI command. Perfect to be used inside your CI process.

GanTTY - Project planning from the terminal

A clone of the popular online game Wordle

sync-my-tasks is a CLI tool that copies tasks between apps.

Lets you view, edit and execute Jupyter Notebooks in the terminal.

GDBIGtools: A command line tools for GDBIG varaints browser

A Telegram Bot Written In Python To Upload Medias To telegra.ph

A CLI application that downloads your AC submissions from OJ's like Atcoder,Codeforces,CodeChef and distil it into beautiful Submission HeatMap.

Dart Version Manager CLI implemented with Python and Typer.

pyNPS - A cli Linux and Windows Nopaystation client made with python 3 and wget

A simple terminal-based localhost chat application written in python

CmdTube is a Python CLI library for searching, downloading, and watching YouTube tutorials