shoebot / jupyter-shoebot

Jupyter kernel for running Shoebot scripts

Shoebot

Shoebot is a creative coding environment designed for making vector graphics and animations with Python. It's geared towards playful graphic exploration, creating SVG images for pen plotters, and is a great tool for automated/headless image generation.

Shoebot takes a Python script describing a drawing process, and outputs a graphic in vector (SVG, PDF, PostScript) and bitmap formats (PNG). Animations can be easily created and output to video files (mp4). Scripts can describe their own GUIs for controlling variables interactively. Shoebot can also be run from the commandline and used as a Python module inside other Python scripts.

Shoebot is a port/rewrite of Nodebox 1, which is derived from DrawBot. The playful coding philosophy of Shoes also inspired its development. Thus, "Shoebot".

• How to install
• Getting started

Documentation

The Shoebot Manual can be found at docs.shoebot.net.

Getting help

Installation is the trickiest aspect of Shoebot. If you run into trouble following the install steps, create a new issue and paste the output of the following commands:

python3 setup.py diagnose
python3 setup.py test

This will help us diagnose common issues more quickly.

Links

• Website
• Documentation
• Source code
• Issue tracker

License

Copyright © 2007-2021 The Shoebot authors (Stuart Axon, Dave Crossland, Francesco Fantoni, Ricardo Lafuente, Sebastian Oliva)

Originally developed by Ricardo Lafuente with the support of the Piet Zwart Institute, Rotterdam.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

jupyter-shoebot's Issues

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.

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.

Apply syntax highlighting and Python indenting to code snippets

Register the package on pip

Use Jupyter widgets to implement live vars

See here for reference

Change cairocffi imports for cairo

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

Add notebook screenshot to README

to make it clear what the extension does

Add Shoebot icon

See the R kernel to see how they do the icon

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...

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).

Can binder open with example ?

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

https://processing.org/

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.

Fill out stubs in the kernel headers

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

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