Skip to main content

Extensible dashboard designed to display data from multiple sources.

Project description

Latest version PyPI - Python Version Build status Documentation status Test coverage Language grade: Python

Doodle-Dashboard is used to create dashboards for displaying information from multiple sources; such as Tweets from your favourite Twitterers, notifications from Slack or breaking news from an RSS feed.

docs/images/raspberry-pi.png

WARNING: This project is under heavy development and will not have a reliable API until a stable version is released.

Requirements

Getting started

  1. Install package:

    pip install doodle-dashboard
    
  2. Start a dashboard:

A dashboard is a YAML file that declares the display to use and the notification to display on it. Dashboard files can be hosted locally or remotely.

Starting a single dashboard:

doodledashboard start \
  https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/master/examples/rss/weather/dashboard.yml

Starting multiple dashboards:

doodledashboard start \
  https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/master/examples/rss/weather/dashboard.yml \
  https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/master/examples/rss/build-radiator/dashboard.yml

Development

These steps assume that you’re using virtualenv.

  1. Clone the repository:

    $ git clone https://github.com/SketchingDev/Doodle-Dashboard.git
    $ cd doodle-dashboard
    
  2. Prepare project dependencies:

    $ make dev
    $ export PYTHONPATH=`pwd`
    
  3. See usage help:

    $ python doodledashboard/cli.py
    

Refer to the documentation for more detailed instructions.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for doodle-dashboard, version 0.0.21
Filename, size File type Python version Upload date Hashes
Filename, size doodle-dashboard-0.0.21.tar.gz (22.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page