shoebot / jupyter-shoebot

Jupyter kernel for running Shoebot scripts

jupyter-shoebot

Jupyter kernel for running Shoebot scripts

Installation

First, you need to have Jupyter installed, as well as the development version of Shoebot. Using virtualenvwrapper for this is heavily recommended.

# create the virtualenv
mkvirtualenv jupytershoebot
# install jupyter dependencies
pip install jupyter jupyter-pip
# clone the Shoebot repository, enter it and install
git clone https://github.com/shoebot/shoebot
cd shoebot
python setup.py install

After ensuring both packages are available, install the extension.

# leave the shoebot/ dir
cd ..
# clone the jupyter-shoebot repository, enter it and install
git clone https://github.com/shoebot/jupyter-shoebot
cd jupyter-shoebot
python setup.py install

And finally, while still on the jupyter-shoebot/ directory, run

jupyter kernelspec install shoebot_kernel --sys-prefix

Usage

After running Jupyter with jupyter notebook, go to the Kernel menu, select Change kernel and select Shoebot.

Acknowledgements

This plugin's workings and install script are based on cairo-jupyter's, and its structure was heavily inspired by the Jupyter bash kernel.

jupyter-shoebot's Issues

Change cairocffi imports for cairo

Some of the notebooks use import cairocffi as cairo they can just use import cairo

Can binder open with example ?

If we can, we should follow processings example and launch into an example

https://processing.org/

Register the package on pip

Add notebook screenshot to README

to make it clear what the extension does

Add postBuild file so this works on mybinder.org

Allison Parrish has been teaching using Flat + a helper library she made called Bezmerizing
https://github.com/aparrish/bezmerizing/blob/master/demo.ipynb

She can lauch a Binder that installs the environment: https://mybinder.org/v2/gh/aparrish/material-of-language/master
[Updated the link, this is the right repo]

That would be amazing if we could do that with shoebot, for teaching...

Use Jupyter widgets to implement live vars

See here for reference

Notebooks only work if placed on the repository root

Which means the install instructions don't really work :(

Figure out why the install command does not install the kernel properly.

Setup doesn't work

I think the default setup that jupyter-pip suggests doesn't work (jupyter-cairo is also broken).

pip doesn't provide a stable api, so I guess it's not too surprising the pip.main doesn't work... have a vague memory of looking at it and thinking 🤔 in jupyter-cairo.

Doesn't work in binder

(Possibly locally too).
Running the cells resulted in no output.

This needs some CI, so we know that it still works.

It could probably do with being linked from shoebot proper (have to admit I forgot that this is a thing, and it would have been handy for test).

Apply syntax highlighting and Python indenting to code snippets

jupyter kernelspec install shoebot_kernel --sys-prefix did not work for me

Following the docs at https://docs.shoebot.net/advanced.html#running-in-jupyter

jupyter kernelspec install shoebot_kernel --sys-prefix

[Errno 13] Permission denied: '/usr/share/jupyter'
Perhaps you want to install with `sudo` or `--user`?

then with sudo

Traceback (most recent call last):
  File "/home/villares/.local/bin/jupyter", line 5, in <module>
    from jupyter_core.command import main
ModuleNotFoundError: No module named 'jupyter_core'

I'm running on a conda environment

Add Shoebot icon

See the R kernel to see how they do the icon

Stdout isn't shown in the output console

print() doesn't show output below.

This should be handled inside kernel.py, but I'm not sure how to access the Bot's stdout from inside the kernel.

Add clearer tracebacks

Right now we have

Traceback (most recent call last):
  File "shoebot_kernel/kernel.py", line 36, in do_execute
    bot.run(code, break_on_error=True)
  File "/home/rlafuente/repos/python-libs/shoebot/shoebot/grammar/grammar.py", line 240, in run
    self._run_frame(executor, limit=frame_limiter, iteration=iteration)
  File "/home/rlafuente/repos/python-libs/shoebot/shoebot/grammar/grammar.py", line 148, in _run_frame
    executor.run()
  File "/home/rlafuente/repos/python-libs/shoebot/shoebot/grammar/livecode.py", line 115, in run
    self.do_exec(self.known_good, self.ns)
  File "/home/rlafuente/repos/python-libs/shoebot/shoebot/grammar/livecode.py", line 82, in do_exec
    exec source in ns
  File "<string>", line 8, in <module>
NameError: name 'red' is not defined

Only the last 2 lines are relevant, and we're also missing context to make it clear which line is problematic.

Fill out stubs in the kernel headers

Right now it's using the default values from the example kernel in the Jupyter docs.