tinyDisplay¶
A Python project (in progress) that implements widgets and screen management for small displays.
Get started¶
Documentation for new users (tutorials, step-by-step installation guides, etc)
How-to guides¶
Recipes for specific tasks
Reference¶
APIs, classes, methods, etc
Background¶
Underlying concepts, approaches, principles.
About the project¶
Some general notes about the project.
How-to guides¶
How to install tinyDisplay¶
tinyDisplay uses Poetry to manage installation and dependencies.
Clone the tinyDisplay repository, and in the repository directory run:
poetry install
How to run tests¶
tinyDisplay’s test suite can be found in tests. The test suite requires Pytest, which is installed by default.
Execute pytest to run all tests.
How to build the documentation¶
The documentation is all in the project’s docs directory. The Makefile includes a number of useful commands
that can be run in that directory.
Install documentation components locally in a virtualenv:
cd docs
make install
Build HTML:
make html
open _build/html/index.html
Or, run a documentation server:
make run
- the documentation will be served at http://localhost:8901
See also Documentation standards.
Background¶
tinyDisplay has evolved from functionality in pydPiper, an application to display metadata from music players such as Volumio, MoodeAudio, and Max2Play on small screens.
tinyDisplay uses the luma.core library as a display driver - any display supported by luma will work with tinyDisplay.