Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naereen/fix-iocaml-notebook-exports-to-pdf
Small :snake: Python script to fix a :camel: IOCaml notebook to have a clean export to PDF (include output values AND types) :wrench: :notebook:
https://github.com/naereen/fix-iocaml-notebook-exports-to-pdf
agregation iocaml jupyter-nbconvert jupyter-notebook mit-license ocaml ocaml-notebook
Last synced: about 7 hours ago
JSON representation
Small :snake: Python script to fix a :camel: IOCaml notebook to have a clean export to PDF (include output values AND types) :wrench: :notebook:
- Host: GitHub
- URL: https://github.com/naereen/fix-iocaml-notebook-exports-to-pdf
- Owner: Naereen
- License: mit
- Created: 2017-09-07T15:25:41.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-09-08T07:53:57.000Z (over 7 years ago)
- Last Synced: 2024-12-11T15:26:32.613Z (21 days ago)
- Topics: agregation, iocaml, jupyter-nbconvert, jupyter-notebook, mit-license, ocaml, ocaml-notebook
- Language: Jupyter Notebook
- Homepage: https://Naereen.GitHub.io/fix-iocaml-notebook-exports-to-pdf/
- Size: 143 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# How to convert to PDF IOCaml notebooks
## Explanation :sunglasses:
- I use the [unofficial IOCaml kernel](https://github.com/andrewray/iocaml/wiki/) for my teaching activities, to use the awesome [Jupyter notebooks](https://jupyter.org/) with the [OCaml language](https://ocaml.org/),
- I like to write solutions to my practical sessions in a notebook, so it can be nicely viewed online.
## Issue :boom: !
- But by default the PDF generation was not perfect: the `stdout` output was kept fine, but the type annotations were removed from the output of the PDF. See for instance, [this HTML notebook](http://perso.crans.org/besson/publis/notebooks/agreg/Sudoku.html) and [this PDF notebook](http://perso.crans.org/besson/publis/notebooks/agreg/Sudoku.pdf) to see what was missing.
- And without the type annotations, the solution is not complete and not understandable.
## Solution :rocket: !
- I wrote [this small Python script](fix-iocaml-notebook-exports-to-pdf.py) to pre-process a `.ipynb` notebook file *before* calling `jupyter-nbconvert --to pdf`, and keep the type annotations.
- Now, instead of using this Bash alias to do `j2pdf My_OCaml_notebook.ipynb`:
```bash
alias j2pdf='jupyter-nbconvert --to pdf'
```
- [I use this Bash function the same way](https://bitbucket.org/lbesson/bin/src/master/.bash_aliases#.bash_aliases-214):
```bash
function j2pdf() {
for old in "$@"; do
new="${old%.ipynb}__fix-iocaml-notebook-exports-to-pdf.ipynb"
[ -f "$new" ] && mv -vf "$new" /tmp/
fix-iocaml-notebook-exports-to-pdf.py "$old" "$new"
if [ $? = 0 ]; then
jupyter-nbconvert --to pdf "$new"
[ -f "${old%.ipynb}.pdf" ] && mv -vf "${old%.ipynb}.pdf" /tmp/
mv -vf "${new%.ipynb}.pdf" "${old%.ipynb}.pdf"
mv -vf "$new" /tmp/
else
jupyter-nbconvert --to pdf "$old"
fi
done
}
```
- It tries to fix the notebook, and convert either the new one to PDF or the old one.
> Note: [I also use this Bash function](https://bitbucket.org/lbesson/bin/src/master/.bash_aliases#.bash_aliases-214):
>
> ```bash
> function j2html() {
> for old in "$@"; do
> jupyter-nbconvert --to html "$old"
> done
> }
> ```
----
## Test
With [this Makefile](Makefile), run the tests with:
```bash
make -B test
```
- It runs the script on two example notebooks, one using the IOCaml kernel, one using another kernel (Python 3),
- It converts them to PDF and to HTML, and open the results,
- You should check manually that the PDF of the [`test_input_ocaml.ipynb`](test_input_ocaml.ipynb) notebook has both `stdout` output and type annotations.
----
## :scroll: License ? [](https://github.com/Naereen/fix-iocaml-notebook-exports-to-pdf/blob/master/LICENSE)
[MIT Licensed](https://lbesson.mit-license.org/) (file [LICENSE](LICENSE)).
© [Lilian Besson](https://GitHub.com/Naereen), 2017.
[](https://GitHub.com/Naereen/fix-iocaml-notebook-exports-to-pdf/graphs/commit-activity)
[](https://GitHub.com/Naereen/ama)
[](https://GitHub.com/Naereen/fix-iocaml-notebook-exports-to-pdf/)
[](https://GitHub.com/Naereen/)
[](http://ForTheBadge.com)
[](https://GitHub.com/)