Spiel

Spiel is a framework for building and presenting richly-styled presentations in your terminal using Python.

To see what Spiel can do without installing it, you can view the demonstration deck in a container:

$ docker run -it --rm ghcr.io/joshkarpel/spiel

Alternatively, install Spiel (pip install spiel) and run this command to view the demonstration deck:

$ spiel demo present

Sandboxed Execution via Containers

Spiel presentations are live Python code: they can do anything that Python can do. You may want to run untrusted presentations (or even your own presentations) inside a container (but remember, even containers are not perfectly safe!). We produce a container image that can be run by (for example) Docker.

Presentations without extra Python dependencies might just need to be bind-mounted into the container. For example, if your demo file is at $PWD/presentation/deck.py, you could do

$ docker run -it --rm --mount type=bind,source=$PWD/presentation,target=/presentation ghcr.io/joshkarpel/spiel spiel present /presentation/deck.py

If the presentation has extra dependencies (like other Python packages), we recommend building a new image that inherits our image (e.g., FROM ghcr.io/joshkarpel/spiel:vX.Y.Z). Spiel's image itself inherits from the Python base image.

Supported Systems

Spiel currently relies on underlying terminal mechanisms that are only available on POSIX systems (e.g., Linux and MacOS). If you're on Windows, you can use the Windows Subsystem for Linux to run Spiel.