Doodle-Dashboard: Simple dashboards for all!
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.
WARNING: This project is under heavy development and will not have a reliable API until a stable version is released.
Requirements
Getting started
-
Install package:
pip install doodle-dashboard
-
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:
$ doodle-dashboard start \ https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/master/examples/rss/weather/dashboard.yml
Starting multiple dashboards:
$ doodle-dashboard 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
-
Clone the repository:
$ git clone https://github.com/SketchingDev/Doodle-Dashboard.git $ cd doodle-dashboard
-
Create a development environment
tox is used to create our project's virtual environment:
$ pip3 install tox # Creates virtual environments listed in tox.ini $ tox # Activates the virtual environment in your shell $ source .tox/py37/bin/activate
Alternatively you can install the dependencies outside of a virtual environment:
$ make dev $ export PYTHONPATH=`pwd`
-
Test that the environment is setup:
$ python doodledashboard/cli.py
Refer to the documentation for more detailed instructions.