nbtermix 0.1.3

Fork of nbterm. Jupyter Notebooks in Your terminal.

 _______ ___. ___________                  .__
 \      \\_ |_\__    ___/__________  _____ |__|__  ___
 /   |   \| __ \|    |_/ __ \_  __ \/     \|  \  \/  /
/    |    \ \_\ \    |\  ___/|  | \/  Y Y  \  |>    <
\____|__  /___  /____| \___  >__|  |__|_|  /__/__/\_ \
        \/    \/           \/            \/         \/

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

Install

Using pip:

pip install nbtermix

Using conda:

mamba install nbtermix -c conda-forge

You will also need a kernel, e.g. ipykernel or xeus-python for Python, xeus-cling for C++.

Usage

Open an interactive notebook:

$ nbtermix my_notebook.ipynb

Run a notebook in batch mode:

$ nbtermix --run my_notebook.ipynb

Key bindings

There are two modes: edit mode, and command mode.

• e: enter the edit mode, allowing to type into the cell.
• esc: exit the edit mode and enter the command mode.

In edit mode:

• ctrl-e: run cell.
• ctrl-r: run cell and select below in edit mode.
• ctrl-t: open cell result in external editor.
• ctrl-w: open cell in external editor.
• ctrl-f: save tmp file from cell and execute it.
• ctrl-s: save.

In command mode:

• up or k: select cell above.
• down or j: select cell below.
• ctrl-f: scroll current cell to the top.
• ctrl-g: go to last cell.
• 1 g: go to first cell.
• ctrl-up: move cell above.
• ctrl-down: move cell below.
• right : scroll output right
• left : scroll output left
• c-j : scroll output down
• c-k : scroll output up
• ctrl-b : reset output scroll shift
• a: insert cell above.
• b: insert cell below.
• x: cut the cell.
• c: copy the cell.
• ctrl-v: paste cell above.
• v: paste cell below.
• o: set as code cell.
• r: set as Markdown cell.
• l: clear cell outputs.
• ctrl-l: clear all cell outputs.
• f: fold current cell input.
• /: Search
• n: Repeat last search.
• N: Search backwards.
• m,<any>: Set mark .
• ',<any>: Go to mark .
• ctrl+f: focus current cell.
• ctrl-e or enter: run cell.
• ctrl-r or alt-enter: run cell and select below.
• ctrl-s: save.
• ctrl-p: run all cells.
• ctrl-q: exit.
• ctrl-h: show help.

Kernels

For more kernels visit:

This nbtermix is tested on (install only if You know what You're doing):

c kernel

pip install jupyter-c-kernel
install_c_kernel

java kernel

wget https://github.com/SpencerPark/IJava/releases/download/v1.3.0/ijava-1.3.0.zip
unzip ijava-1.3.0.zip -d ijava
cd ijava
python install.py
apt-get isntall default-jdk

javascript kernel

apt-get install nodejs npm libczmq-dev
npm install -g --unsafe-perm npm
npm install -g --unsafe-perm ijavascript
ijsinstall --install=global

php kernel

apt-get install php composer php-zmq
wget https://litipk.github.io/Jupyter-PHP-Installer/dist/jupyter-php-installer.phar
chmod u+x jupyter-php-installer.phar
./jupyter-php-installer.phar install

sqlite kernel from sqlok

pip3 install sqli-kernel
sqlik_install

python3 kernel

out of the box

Testing environment

using Python 3.9 and iPyKernel==6.0.0

pip install ipykernel==6.0.0

$ jupyter --version:

jupyter core     : 4.7.1
ipython          : 7.25.0
ipykernel        : 6.0.0
jupyter client   : 6.1.12

Runtime Environment recommendations

Keep separated environment for the nbtermix

|= mkdir -p ~/pyenv
cd ~/pyenv
|= virtualenv -p /usr/bin/python3.9 nbtermix
|= source ~/pyenv/nbtermix/bin/activate

CHANGELOG

minor changes to v.0.1.3  by mtatton
+ fixed search function (keys /,n,N)
minor changes to v.0.1.2  by mtatton
+ changed visible cells display a bit
+ added ctrl + f for current cell focus
+ added raw text/plain display 
+ added raw text/html display 
minor changes to v.0.0.18 by mtatton
+ scrollable output using left and right
minor changes to v.0.0.17 by mtatton
minor changes to v.0.0.16 by mtatton
minor changes to v.0.0.15 by mtatton
+ added folding for terminal space saving
+ renamed to nbtermix
minor changes to v.0.0.14 by mtatton
minor changes to v.0.0.13 by mtatton
minor changes to v.0.0.12 by mtatton