ocaml-jupyter/jupyter-kernel

Library for writing arbitrary jupyter kernels in OCaml.

Jupyter-Kernel

A library for writing Jupyter kernels in OCaml

Install a Kernel

jupyter kernelspec install dir/containing/kernel/ --user --replace --name=<name>

Documentation

https://ocaml-jupyter.github.io/jupyter-kernel/

Related work

This project is a library for writing Jupyter kernels in OCaml.

If you are looking for a Jupyter kernel for OCaml, try one of these:

• https://github.com/KKostya/simple_jucaml
• https://github.com/andrewray/iocaml
• https://github.com/akabe/ocaml-jupyter

License

BSD2

jupyter-kernel's Issues

see if we can share code with https://github.com/akabe/ocaml-jupyter

seems like they have a recent version of the protocol

API design

We need to discuss the design of this library, how it can be used for various kernels, what capabilities does it expose, etc.
cc @andrewray .

Should this be working currently?

Hi, sorry to ask this really dumb question, but if I run

$ jupyter kernelspec install /path/to/jupyter-kernel --user --replace --name=ocaml

jupyter says, Installed kernelspec ocaml in /Users/ahmed.fasih/Library/Jupyter/kernels/ocaml but ocaml isn’t listed as an available kernel when I do

$ jupyter kernelspec list

or when I start a jupyter notebook. No errors are reported. Should this work currently? Thank you!

kernel installation: doc + script

need some basic doc, and maybe a tiny ocaml script, to install a kernel description foo.json file in ~/.local/share/jupyter/kernels/.

missing functionalities before stable release

• history not in kernel
• need better handling of mime messages
• file extension for language
• mime type for language
• banner
• object info request
• proper treatment of optional fields in execute_request
• renaming ipython stuff to jupyter (or even remove prefix, we live in a pack)
• [ ] hide some modules (all useful if the lib is also used by frontends)
• streams/stdin handling

Related projects

Below is the equivalent toolset to iocaml.

• ocaml-jupyter-kernel an ocaml bytecode interpreter
• js_of_ocaml-jupyter-kernel ocaml bytecode interpreter compiled to javascript (needs some help from ocaml-jupyter-server to function properly)
• ocaml-jupyter-server webserver for jupyter kernels, built in ocaml. Should run all projects derived from jupyter-kernel without modification.

Note; both kernels above would use the API in #1.

release with deinit + private alias for kernel