The source code for SnipPy, the tool created for the Small-Step Live Programming By Example paper.

This is a meta-repository containing the instructions, build scripts, and necessary submodules to build a version of SnipPy ready to run in your browser! (For the local version see here).

1. Modules
2. Setup
3. Building
4. Running
5. TODOs

This repository is meant for simplifying the process of building SnipPy, and is really just the following two repositories:

This repository contains the server that will eventually serve the editor, combined with the Enumerative Synthesizer that powers SnipPy. It is an implementation of bottom-up enumerative synthesis with observational equivalence.

This repository is a fork of Microsoft's VS Code Repository modified to include Projection Boxes with SnipPy support.

This is a wrapper for VS Code's Monaco Editor that allows us to run the editor in the browser.

To get these submodules, you can run the following git command:

git submodule update --init --remote

After that, please make sure that the vscode and synthesizer exist.

The build scripts provided in this repo assume that certain applications are installed and exist on the PATH.

For building/running VS Code and the Projection Boxes, you need:

1. NodeJS 12
2. Yarn
3. Python 3
4. The numpy Python library
5. The Pillow Python library

For building/running the synthesizer/server, you need:

1. Scala
2. Maven
3. wget [Optional: See below for alternative]

tldr; You can build both modules by running

./build.sh

To build VS Code, we first need to get the necessary node modules, compile the source to the javascript files that monaco-editor needs, and finally link it so that monaco-editor uses our build instead of downloading the package from the Node package repository:`

cd vscode;
yarn;
yarn run gulp editor-distro;
cd out-monaco-editor-core;
yarn link;
cd ../../;

We can then build the editor that can be loaded in the browser:

cd monaco-editor;
link monaco-editor-core;
yarn;
yarn release;
cd release;
yarn link;
cd ../../;

SnipPy uses Pyodide to run Python directly in the browser. Before building the server, we need to download it and unzip it in the right directory to be served statically by the browser:

cd synthesizer/src/main/resources/static/pyodide;
wget https://github.com/KasraF/pyodide/releases/download/monaco/pyodide_with_pillow.zip;
unzip pyodide_with_pillow.zip;
rm pyodide_with_pillow.zip;
cd ../../../../../../;

If you don't have wget, you can download that link however you like and unzip it in that directory. At the end, make sure that all files in that zip file are directly in resources/static/pyodide and not in a subdirectory.`

Finally, to build the synthesizer and wrap it in an executable Jar file, we can just run:

cd synthesizer;
yarn link monaco-editor;
mvn clean install;
cd ../;

This repo also includes a build.sh script that does both for you. :)

tldr; You can run SnipPy by running

./run.sh

And opening http://localhost:8080/ in your favorite (non-Safari) browser.

You can run SnipPy just by running the Jar file synthesizer/target/snippy-server-0.1-SNAPSHOT.jar. This will start up the server in port 8080.

To change the port on which the server runs, you can set the SERVER_PORT environment variable.`

To make this more convenient, you can instead set the SERVER_PORT variable in the ./run.sh script and use that instead. :)

After running the Jar file, you can open SnipPy in your favorite browser by going to https://localhost:8080/ (or the port you set it to). But please note that SnipPy does not work in Safari, because the Python interpreter crashes and the editor never fully loads. Any other browser should work.

1. Cleanup the build process. Currently, vscode builds much more than it needs, and the compilation takes a long time.
2. Add instructions for Windows