Metadata-Version: 2.1
Name: vinbterm
Version: 0.1.5
Summary: A tool for viewing, editing and executing Jupyter Notebooks in the terminal
Home-page: https://github.com/jimbozhang/nbterm
Author: David Brochart, Junbo Zhang
Author-email: dr.jimbozhang@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: prompt-toolkit >=3.0.16
Requires-Dist: typer >=0.4.0
Requires-Dist: pygments
Requires-Dist: rich
Requires-Dist: kernel-driver >=0.0.6
Requires-Dist: ipykernel
Provides-Extra: test
Requires-Dist: mypy ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: black ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'

[![Build Status](https://github.com/davidbrochart/nbterm/workflows/CI/badge.svg)](https://github.com/davidbrochart/nbterm/actions)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# vinbterm

vinbterm is [nbterm](https://github.com/davidbrochart/nbterm) with some keybinding modifications, and setting edit mode as default.

The command is remained as `nbterm`, instead of "vinbterm".

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

## Install

```
pip install vinbterm
```


## 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.

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

In command mode:

- `k` or `up`: select cell above.
- `j` or `down`: select cell below.
- `ctrl-k` or `ctrl-up`: move cell above.
- `ctrl-j` or `ctrl-down`: move cell below.
- `a`: insert cell above.
- `b`: insert cell below.
- `d`: cut the cell.
- `y`: copy the cell.
- `ctrl-p`: paste cell above.
- `p`: paste cell below.
- `c`: set as code cell.
- `r`: set as raw cell.
- `m`: set as Markdown cell.
- `l`: clear cell outputs.
- `ctrl-e`: run cell.
- `enter` or `ctrl-r`: run cell and select below.
- `ctrl-w` or `ctrl-s`: save.
- `ctrl-q`: exit.
- `ctrl-h`: show help.
