search

jupyter-server / kernel_gateway

Jupyter Kernel Gateway
http://jupyter-kernel-gateway.readthedocs.org/en/latest/
Other
501 stars 131 forks source link

Update docs to be more informative on startup as per issue https://gi… #356

Closed cottrell closed 3 years ago

cottrell commented 3 years ago

…thub.com/jupyter/kernel_gateway/issues/351

See https://github.com/jupyter/kernel_gateway/issues/351.

I built the docs but didn't seem to create a diff so I'm assuming there is some doc build in the github pipelines.

cottrell commented 3 years ago

Yes, what is the test for the websocket mode? I can add that in.

kevin-bates commented 3 years ago

Thank you David.

The startup output is a bit quieter...

jupyter kernelgateway --KernelGatewayApp.api=kernel_gateway.jupyter_websocket --port=10100
[KernelGatewayApp] Jupyter Kernel Gateway at http://127.0.0.1:10100

(and this option --KernelGatewayApp.api=kernel_gateway.jupyter_websocket is the default, but listed for completeness.)

You could hit the same swagger endpoint. I also like fetching the set of kernelspecs as a litmus test:

curl http://127.0.0.1:10100/api/kernelspecs

The output is a bunch of JSON that looks much better if piped through jq ( ... | jq).

cottrell commented 3 years ago

Updated again.