Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gzuidhof/starboard-jupyter
Plugin to run Starboard cells in an external Jupyter kernel
https://github.com/gzuidhof/starboard-jupyter
literate-programming notebook python starboard-notebook
Last synced: 7 days ago
JSON representation
Plugin to run Starboard cells in an external Jupyter kernel
- Host: GitHub
- URL: https://github.com/gzuidhof/starboard-jupyter
- Owner: gzuidhof
- License: mit
- Created: 2021-04-08T12:49:20.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-06-11T00:04:38.000Z (over 3 years ago)
- Last Synced: 2024-10-30T03:40:03.578Z (4 months ago)
- Topics: literate-programming, notebook, python, starboard-notebook
- Language: TypeScript
- Homepage:
- Size: 1.2 MB
- Stars: 15
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# starboard-jupyter
Experiment for support of Starboard cells that are backed by a Jupyter kernel.
## Screenshot
## Setup
### 1. Install Jupyter Kernel Gateway
```
pip install jupyter_kernel_gateway
```
### 2. Start the Jupyter Kernel gateway:
```shell
# For some reason we need
KG_ALLOW_METHODS="*" \
jupyter kernelgateway \
--KernelGatewayApp.allow_origin="https://gz.starboard.host" \
--KernelGatewayApp.allow_headers="authorization,content-type,x-xsrftoken" \
--KernelGatewayApp.max_age=3600 \\
--JupyterWebsocketPersonality.list_kernels=True
# or for a specific localhost port
KG_ALLOW_METHODS="*" \
jupyter kernelgateway \
--KernelGatewayApp.allow_origin="http://localhost:9001" \
--KernelGatewayApp.allow_headers="authorization,content-type,x-xsrftoken" \
--KernelGatewayApp.max_age=3600 \
--JupyterWebsocketPersonality.list_kernels=True
```
*(change the origin to be the origin where you are hosting your notebook sandbox)*
> Note 1: right now auth with a token doesn't work for the websocket connection. The token simply doesn't get passed from the client, so for now there is no auth other than the origin check (and the fact that you can stay entirely within localhost). When that is fixed you should add `--KernelGatewayApp.auth_token="my-super-strong-secret-example"`
> Note 2: For some reason `--KernelGateWayApp.allow_methods="POST,GET,OPTIONS,DELETE"` does not work, so we use the `KG_ALLOW_METHODS` env variable.
> Note 3: It also works with a plain Jupyter Notebook or JupyterLab, but you will need to allow the origins and set the auth token with another method.
### 3. Initialize the plugin in your notebook
You can use [this notebook](https://starboard.gg/nb/nA3wm87) (or without Starboard's interface around it [here](https://gz.starboard.host/v1/embed/0.8.9/br0qtd223akg00eiaos0/nA3wm87/)) to try it out.
```javascript
// Or wherever you are hosting it, could be from some CDN.
import "http://localhost:8080/dist/starboard-jupyter.js";
registerJupyterPlugin({
serverSettings: {
baseUrl: "http://localhost:8888",
token: "my-super-strong-secret-example",
}
})
```
### 4. Create Jupyter cells
Who even needs Jupyter's interface anymore? ;)
## License
[MIT](./LICENSE)