Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naereen/jupyter-nbconvert-ocaml
WARNING it might not work with recent versions of Jupyter, traitlets etc. Use at your own risk, this was not updated since 2017. :wrench: Custom Jupyter :notebook: NBConvert Exporter for the OCaml language :camel:
https://github.com/naereen/jupyter-nbconvert-ocaml
jupyter-nbconvert jupyter-notebook jupyter-ocaml ocaml ocaml-jupyter
Last synced: 24 days ago
JSON representation
WARNING it might not work with recent versions of Jupyter, traitlets etc. Use at your own risk, this was not updated since 2017. :wrench: Custom Jupyter :notebook: NBConvert Exporter for the OCaml language :camel:
- Host: GitHub
- URL: https://github.com/naereen/jupyter-nbconvert-ocaml
- Owner: Naereen
- License: mit
- Created: 2017-10-06T12:34:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T12:48:11.000Z (over 4 years ago)
- Last Synced: 2024-12-27T08:24:53.262Z (29 days ago)
- Topics: jupyter-nbconvert, jupyter-notebook, jupyter-ocaml, ocaml, ocaml-jupyter
- Language: Jupyter Notebook
- Homepage: https://naereen.github.io/Jupyter-NBConvert-OCaml/
- Size: 25.4 KB
- Stars: 7
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Custom `Exporter` for OCaml and the Jupyter NBConvert
Installing this Python project allow to convert [Jupyter notebooks](https://www.jupyter.org/) written with the [OCaml Jupyter kernel](https://github.com/akabe/ocaml-jupyter/) directly to well-written `.ml` OCaml scripts. It solves [this issue](https://github.com/akabe/ocaml-jupyter/issues/58#issuecomment-334730337).
## a) Test, and install locally
Clone this repository, test everything locally if you want, and then install it globally with:
```bash
$ python setup.py install # for default Python
$ python3 setup.py install # for Python3 if needed
```
> Note: `sudo` right might be necessary:
```bash
$ sudo python3 setup.py install
```
## b) Install directly from GitHub
This package can also be installed directly from GitHub with [`pip`](http://pip.pypa.io/):
```bash
sudo pip install git+https://github.com/Naereen/Jupyter-NBConvert-OCaml
```
Check that you use pip2 or pip3 whether you installed Jupyter for Python 2 or Python 3. (You can of course install `Jupyter-NBConvert-OCaml` for both if you prefer!)
## Use it
```bash
$ jupyter nbconvert --to ocaml A_Jupyter_notebook_with_OCaml_kernel.ipynb
$ ls A_Jupyter_notebook_with_OCaml_kernel.ml
...
$ ocaml A_Jupyter_notebook_with_OCaml_kernel.ml # it works and comments are kept
...
```
To test it locally (in this folder), use [this Makefile](Makefile):
```bash
$ make convert_demo_ocaml_local
$ head -n7 demo_notebook_ocaml.ml
(*
This OCaml script was exported from a Jupyter notebook
using an open-source software (under the MIT License) written by @Naereen
from https://github.com/Naereen/Jupyter-NBConvert-OCaml
This software is still in development, please notify me of a bug at
https://github.com/Naereen/Jupyter-NBConvert-OCaml/issues/new if you find one
*)
...
```
## Example
- See [this small notebook](demo_notebook_ocaml.ipynb), with lots of comments,
- [This first OCaml file](demo_notebook_script.ml) is the result of `jupyter-nbconvert --to script`, the default conversion, which removes all comments,
- [And this second OCaml file](demo_notebook_ocaml.ml) is the result of `jupyter-nbconvert --to ocaml`, our home-made conversion, which removes keep all comments and adds a small header.
## References
> See the [documentation](http://nbconvert.readthedocs.io/en/latest/external_exporters.html#writing-a-custom-exporter) [I (Lilian Besson, @Naereen)](https://GitHub.com/Naereen) used to write this small exporter.
----
## :scroll: License ? [](https://github.com/Naereen/Jupyter-NBConvert-OCaml/blob/master/LICENSE)
[MIT Licensed](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)).
© [Lilian Besson](https://GitHub.com/Naereen), 2017-2018.
[](https://GitHub.com/Naereen/Jupyter-NBConvert-OCaml/graphs/commit-activity)
[](https://GitHub.com/Naereen/ama)
[](https://GitHub.com/Naereen/Jupyter-NBConvert-OCaml/)
[](https://GitHub.com/Naereen/)
[](http://ForTheBadge.com)
[](https://GitHub.com/)