/inkerboard

E-Ink dashboard generation application

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

inkerboard

This is the inkerboard application.

Minimum Requirements

  • Python 3.5+

Optional Requirements

  • pytest (for running the test suite)
  • Sphinx (for generating documentation)

Basic Setup

Install for the current user:

$ python -m pip install . --user

Run the application:

$ python -m inkerboard --help

Run the test suite:

$ pytest test/

Build documentation:

$ sphinx-build -b html doc doc/_build/html