Today’s Paper — server docs

Today’s Paper is the server that renders a per-device “screen” — a calendar, a weather forecast, a school lunch menu, comics — to an image and serves it to a battery-powered e-paper photo frame. This is the documentation for that server, todays_paper_web.

Most of these pages are about designing screens: the config format, the Jinja/XML templating pipeline, and the full reference for every widget (view) and data source available to a template. There’s also a short section on installing and running the server itself, and an auto-generated reference of the Python API for anyone extending it with a new widget or data source.

Getting started

• Installing and running the server
  • Local development
  • Docker
  • Configuration
  • Rendering a screen without the server

Designing screens

• Designing screens
• Examples
  • Hello World
  • Date
  • Weather
• Widget reference
• Data sources

Extending the server

• Python API reference
  • Adding a widget
  • Adding a data source