state-of-things 0.0.3

State of Things python library to organize complex state machines

Introduction

State of Things is a python library to organize complex state machines.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the library locally from PyPI. To install for current user:

pip3 install state-of-things

To install system-wide (this may be required in some cases):

sudo pip3 install state-of-things

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install state-of-things

Documentation

API documentation for this library can be found on Read the Docs.

Development

To set up a development environment, clone the repository and install the development dependencies: .. code-block:: shell

git clone https://github.com/mindwidgets/state-of-things.git cd state-of-things pip install -r requirements-dev.txt

Then you can run the build (including tests) with: .. code-block:: shell

tox