nbk

0.1.31 • Public • Published

nodebook Build Status

Nodebook - Multi-Language REPL with Web UI + CLI code runner

What is it?

Nodebook is an in-browser REPL supporting many programming languages. Code's on the left, Console's on the right. Click "Run" or press Ctrl+Enter or Cmd+Enter to run your code. Code is automatically persisted on the file system.

You can also use Nodebook directly on the command line, running your notebooks upon change.

nodebook

A notebook is a folder containing an {index|main}.{js,py,c,cpp,...} file. The homepage lists all of the available notebooks.

home

Supported environments

  • C11 (.c)
  • C++14 (.cpp)
  • C# (.cs)
  • Clojure (.clj)
  • Elixir (.ex)
  • Fsharp (.fs)
  • Go (.go)
  • Haskell (.hs)
  • Java (.java)
  • NodeJS (.js)
  • Lua (.lua)
  • OCaml (.ml)
  • PHP (.php)
  • Python 3 (.py)
  • R (.r, .R)
  • Ruby (.rb)
  • Rust (.rs) — Uses cargo run if Cargo.toml is present, and rustc otherwise
  • Swift (.swift)
  • TypeScript (.ts)

If --docker is set on the command line, each of these environments will run inside a specific docker container.

Otherwise, the development environments on your local machine will be used.

Install and run as package (npm)

# Install 
$ npm i -g --production nbk
 
# Run with Web UI 
$ nbk path/to/notebooks
# Or 
$ nbk --notebooks path/to/notebooks
 
# Run on CLI 
$ nbkcli path/to/notebooks
# Or 
$ nbkcli --notebooks path/to/notebooks

Install and run from source

# Install 
$ git clone https://github.com/netgusto/nodebook
cd nodebook
$ npm install --production
 
# Run 
$ node . --notebooks path/to/notebooks

Usage

Create a Notebook (Web UI)

Click on the + Notebook button on the Home page, then select the language of the notebook to be created.

Once on the notebook edition page, you can rename the notebook by clicking on it's name.

Notebooks are created in the directory specified by the parameter --notebooks.

Create a Notebook manually (WebUI, CLI)

In the directory where you want your notebooks to be stored, simply create a folder containing a file named {index|main}.{js,py,c,cpp,...}.

The notebook's name will be the name of the folder. The notebook language is determined automatically.

Command line options

  • --notebooks: path to notebook folders; required
  • --docker: Execute code in disposable docker containers instead of local system; defaults to false

Web UI only:

  • --bindaddress: IP address the http server should bind to; defaults to 127.0.0.1
  • --port: Port used by the application; defaults to 8000

Notebook environment

If your notebook dir contains a .env file, the corresponding environment will be set up during notebook execution.

Exemple .env:

HELLO=World!

More information about the expected file format here: https://github.com/motdotla/dotenv#rules

⚠️ A bit of warning ⚠️

Do not run the Web UI on a port open to public traffic! Doing so would allow remote code execution on your machine.

By default, the server binds to 127.0.0.1, which allows connection from the localhost only. You can override the bind address using --bindaddress, but do it only if you know what you're doing.

Develop

To iterate on the code:

$ npm install
$ PARAMS="--notebooks path/to/notebooks" npm run dev

To build:

$ npm run build

To test:

$ npm test

Readme

Keywords

none

Package Sidebar

Install

npm i nbk

Weekly Downloads

8

Version

0.1.31

License

ISC

Unpacked Size

2.41 MB

Total Files

170

Last publish

Collaborators

  • netgusto