Getting Started

ScreenFlow is a light UI engine built on top of Pygame. It is primarily designed for building configuration interface for IoT devices like RaspberryPi.

ScreenFlow is based on Screen

There is no screen flow without screen obviously, so an application built with ScreenFlow requires to create and connect together a serie of screens. The application switch from one screen to another by sliding horizontally, keeping the navigation state into an internal stack.

A Screen aims to be dedicated to a single task, for exemple :

• Input text
• Allow user to select option
• View a list or a grid of items
• And so on ...

That is why lot of basic Screen implementation are already available as in.

Installation

Screenflow is available on PyPi repository and can then be installed through pip :

pip install screenflow

First screenflow

Simple hello world with screenflow looks like this :

from screenflow import ScreenFlow
from screenflow.screens import MessageScreen

screenflow = ScreenFlow()
message = MessageScreen('intro', 'Hello screenflow !')

@screenflow.intro.on_touch()
def on_message_touch():
    screenflow.quit()

screenflow.add_screen(message)
screenflow.run(message)