davidbrochart/nbterm

Jupyter Notebooks in the terminal.

Python

780

73 commits

updated Aug 10, 2023

See the code

README

Build Status Code style: black

nbterm

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

WARNING: jpterm is the successor of nbterm, which is not maintained anymore.

Install

Using pip:

pip install nbterm

Using conda:

mamba install nbterm -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:

$ nbterm my_notebook.ipynb

Run a notebook in batch mode:

$ nbterm --run my_notebook.ipynb

Key bindings

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

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

In command mode:

  • up: select cell above.
  • down: select cell below.
  • ctrl-up: move cell above.
  • ctrl-down: move cell below.
  • 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 raw cell.
  • m: set as Markdown cell.
  • l: clear cell outputs.
  • ctrl-e: run cell.
  • ctrl-r: run cell and select below.
  • ctrl-s: save.
  • ctrl-q: exit.
  • ctrl-h: show help.

davidbrochart/nbterm

Jupyter Notebooks in the terminal.

Python

780

73 commits

updated Aug 10, 2023

See the code

README

Build Status Code style: black

nbterm

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

WARNING: jpterm is the successor of nbterm, which is not maintained anymore.

Install

Using pip:

pip install nbterm

Using conda:

mamba install nbterm -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:

$ nbterm my_notebook.ipynb

Run a notebook in batch mode:

$ nbterm --run my_notebook.ipynb

Key bindings

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

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

In command mode:

  • up: select cell above.
  • down: select cell below.
  • ctrl-up: move cell above.
  • ctrl-down: move cell below.
  • 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 raw cell.
  • m: set as Markdown cell.
  • l: clear cell outputs.
  • ctrl-e: run cell.
  • ctrl-r: run cell and select below.
  • ctrl-s: save.
  • ctrl-q: exit.
  • ctrl-h: show help.

Project health

Overall

2.9/10

Maintained

0/10

Code review

1/10
OpenSSF Scorecard

PyPI

Latest release

0.0.13 · Aug 10, 2022

Releases this year

0

Significant stargazers

Sylvain Corlay

935 followers · starred Apr 2021

Johan Euphrosine

595 followers · starred Nov 2022

Wolf Vollprecht

703 followers · starred Apr 2021

Johan Mabille

270 followers · starred Apr 2021