Skip to content

Commit b3ee56c

Browse files
committed
obligatory readme
1 parent 264f49b commit b3ee56c

2 files changed

Lines changed: 41 additions & 0 deletions

File tree

wasm/notebook/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# RustPython Notebook
2+
3+
The RustPython Notebook is a **toy** notebook inspired by the now inactive Iodide project ([https://alpha.iodide.io/](https://alpha.iodide.io/)).
4+
5+
Here is how it looks like:
6+
7+
![notebook](./screenshot.png)
8+
9+
You can use the notebook to experiment with using Python and Javascript in the browser together.
10+
11+
The main use case is for scientific communication where you can have:
12+
- text or thesis in markdown,
13+
- math with Tex,
14+
- a model or analysis written in python,
15+
- a user interface and interactive visualization with JS.
16+
17+
The Notebook loads python in your browser (so you don't have to install it) then let yous play with those languages.
18+
19+
Using Javascript in the browser can play to JS strength but it is also a workaround since RustPython doesn't fully implement DOM/WebAPI functionality.
20+
21+
To read more about the reasoning behind certain features, check the blog on [https://rustpython.github.io/blog](https://rustpython.github.io/blog)
22+
23+
## Sample notebooks
24+
25+
Sample notebooks are under `snippets`
26+
27+
- `snippets/python-markdown-math.txt`: python, markdown and math
28+
- `snippets/python-js.txt`, adds javascript
29+
- `snippets/python-js-css-md/` adds styling with css in separate, more organized files.
30+
31+
## How to use
32+
33+
- Run locally with `npm run dev`
34+
- Build with `npm run dist`
35+
36+
## Wish list / TO DO
37+
38+
- Better javascript support
39+
- Collaborative peer-to-peer editing with WebRTC. Think Google Doc or Etherpad editing but for code in the browser
40+
- `%%load` command for dynamically adding javascript libraries or css framework
41+
- Clean up and organize the code. Seriously rethink if we want to make it more than a toy.

wasm/notebook/screenshot.png

1.26 MB
Loading

0 commit comments

Comments
 (0)