The ipylivebash library is a shell script runner that enhances Jupyter's capabilities, transforming it into an valuable tool within the context of DevOps.
Features:
- Live Magic: Added "%%livebash" live magic command to run shell script in Jupyter.
- Execution Confirmation UI: Avoid accidental execution
- Notification: Send a notification when the script finishes
- Background Process Management: Show and kill background process
- Logging: Log output to a file with/without timestamp information
- Python API: For running script easily
Execution Confirmation
%%livebash --save log.txt --save-timestamp
find .
Run find .
and show the output in the Jupyter notebook, and also save it 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, inform the user with a browser notification.
usage: livebash [-h] [-ps] [--save OUTPUT_FILE] [--save-timestamp]
[--line-limit LINE_LIMIT] [--height HEIGHT] [--ask-confirm]
[--notify]
options:
-h, --help
-ps, --print-sessions
--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 (no. of line)
--ask-confirm Ask for confirmation before execution
--notify Send a notification when the script finished
--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
You can install using pip
:
pip install ipylivebash
Remarks: 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
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.
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.
If you make a change to the python code then you will need to restart the notebook kernel to have it take effect.