Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@adamj9431
adamj9431 authored Dec 2, 2017
1 parent 8551e3c commit 1c451b0
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# notebook_xterm
[![PyPI version](https://badge.fury.io/py/notebook-xterm.svg)](https://badge.fury.io/py/notebook-xterm)

A fully-functional terminal emulator in an IPython/Jupyter notebook. This is useful for notebook environments that don't provide shell access. Uses [xterm.js](https://xtermjs.org) for a VT100-compliant Javascript terminal front-end component. Instead of an actual WebSocket, notebook_xterm uses the Javascript Jupyter cell execute function `Jupyter.notebook.kernel.execute()` as a channel to communicate between the Python runtime on the server (`TerminalServer`) and JavaScript runtime in the browser (`TerminalClient`).

![jupyter-nb-terminal-emulator-demo](https://user-images.githubusercontent.com/1238730/32994956-04cb26da-cd3c-11e7-9f7c-527de15f654c.gif)
Expand Down

0 comments on commit 1c451b0

Please sign in to comment.