From 2d7082abbd1eb243b951da5738cbb3f519ef3924 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9=20Santanch=C3=A8?= Date: Mon, 18 Mar 2019 09:48:25 -0300 Subject: [PATCH] Documenting the REST basics --- basics/rest-server/README.md | 37 ++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 basics/rest-server/README.md diff --git a/basics/rest-server/README.md b/basics/rest-server/README.md new file mode 100644 index 0000000..662b24f --- /dev/null +++ b/basics/rest-server/README.md @@ -0,0 +1,37 @@ +# Jupyter Kernel Gateway Example + +This example uses as server the Jupyter Kernel Gateway: https://test-jupyterkernelgateway.readthedocs.io/en/latest/index.html + +## Linux + +### Install + +Install the Jupyter Kernel Gateway +~~~~ +pip3 install jupyter_kernel_gateway +~~~~ + +### Run + +Go to the server directory inside the Git project: +~~~~ +cd ~/git/case-notebook/notebook/server +~~~~ + +To start the server run in the terminal (POST version): +~~~~ + ~/.local/bin/jupyter kernelgateway --KernelGatewayApp.api='kernel_gateway.notebook_http' --KernelGatewayApp.seed_uri='~/git/case-notebook/basics/rest-server/rest-server-post-convert-angle.ipynb' --KernelGatewayApp.allow_origin='*' --KernelGatewayApp.allow_methods='POST, GET, OPTIONS' --KernelGatewayApp.allow_headers='Content-Type' +~~~~ + +## Windows +~~~~ +jupyter kernelgateway --KernelGatewayApp.api='kernel_gateway.notebook_http' --KernelGatewayApp.seed_uri='/Users//git/case-notebook/basics/rest-server/rest-server-post-convert-angle.ipynb' --KernelGatewayApp.allow_origin='*' --KernelGatewayApp.allow_methods='POST, GET, OPTIONS' --KernelGatewayApp.allow_headers='Content-Type' +~~~~ + +* `--KernelGatewayApp.allow_origin='*'` -> accepts all origins (better restrict in the future) +* `--KernelGatewayApp.allow_methods='POST, GET, OPTIONS'` -> accepted types of request +* `--KernelGatewayApp.allow_headers='Content-Type'` -> things that can appear in the header + +Details at: + +* Jupyter Kernel Gateway configuration: https://test-jupyterkernelgateway.readthedocs.io/en/latest/config-options.html