4 ms·
I wouldn't squirrel my documentation away in an ipynb file. So even though I'd like to use notebooks as runbooks, Jupyter just isn't the right solution for that
by theossuary 3y ago
I wouldn't squirrel my documentation away in an ipynb file. So even though I'd like to use notebooks as runbooks, Jupyter just isn't the right solution for that. This could be a great tool for when you want to augment markdown documentation with runnable snippets. I really like this idea, it gives off literate programming[0] vibes.
[0]: http://literateprogramming.com/ http://literateprogramming.com/
- joncp 3y agoAnother is that it looks like runme is written in Go instead of python. It's a single executable I can drop onto any new machine instead of futzing around getting a particular python version installed before doing any work.
- admc 3y agoI'm on the Runme team, and one of the goals of the primary goals of runme is to use a shared markdown parsing engine so that there is consistent behavior between CLI/GH Action and the VS Code Notebook.
- admc 3y agoYou nailed it, thanks for calling that connection out. We were very much inspired by literate programming.
- enriquto 3y ago> I wouldn't squirrel my documentation away in an ipynb file. This! ipynb files are a nightmare to deal with. Fortunately, you can use jupyter without ever seeing a .ipynb file, by storing your notebooks in a different format (e.g. as programs or as markdown files). Bonus points: you'll hear fewer complains from your local graybeards if they can edit and run notebooks from their favorite text editor.