python

Puddle Python frontend

This the Python front end for the Puddle system.

Installation

You'll need Python 3.6 for this project.

We use pipenv to manage dependencies. I'm also a fan of pipsi to install Python scripts. You can install them both in a way that doesn't mess with your Python installation.

Once you have Python 3.6 and pipenv, do the following to setup the project:

# clone and enter the repo
git clone git@github.com:uwmisl/puddle.git
cd puddle/src/python

# use pipenv to install requirements into a virtualenv
# --dev gets the development dependencies too
pipenv install --dev

# jump in the virtual environment
pipenv shell

# run all the tests
pytest

pipenv shell starts a shell in the virtual environment. You can use pipenv run ... instead to run individual commands without being in the pipenv shell.

Running Examples

To run an example program, make sure you install the development dependencies which include the puddle package itself. Then do the following:

PUDDLE_VIZ=1 python examples/simple.py

The environment PUDDLE_VIZ controls whether the visualization server runs. It's off by default.