Doodle-Dashboard’s documentation!¶
Create little dashboards that display useful information from multiple sources, like Tweets from your favourite Twitterers, weather reports for your local area or breaking news.
Installation¶
Before continuing make sure you have Python 3.4+ installed!
Doodle-Dashboard can then be installed using pip:
$ pip install doodle-dashboard
Done!
From source
The code is hosted at Github.
Checkout the latest master version with:
$ git clone git@github.com:SketchingDev/Doodle-Dashboard.git
$ cd Doodle-Dashboard
Install the dependencies with pip:
$ pip install -r requirements.txt
Build and install the distribution:
$ python setup.py build
$ python setup.py install
Getting Started¶
Install package:
pip install doodle-dashboard
Start a dashboard:
A dashboard is a YAML file that declares what notifications to show and to what display. Dashboard files can be hosted locally or remotely.
Starting a single dashboard:
doodledashboard start \
https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/examples/rss/weather/dashboard.yml
Starting multiple dashboards:
doodledashboard start \
https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/examples/rss/weather/dashboard.yml \
https://raw.githubusercontent.com/SketchingDev/Doodle-Dashboard/examples/rss/build-radiator/dashboard.yml
How notifications work¶
Development¶
These steps assume that you’re using virtualenv.
Clone the repository:
$ git clone https://github.com/SketchingDev/Doodle-Dashboard.git $ cd doodle-dashboard
Prepare project dependencies:
$ make dev $ export PYTHONPATH=`pwd`
See usage help:
$ python doodledashboard/cli.py
ImportError: No module named¶
If you keep getting the ImportError when building the project check that you haven’t already installed the application via pip, otherwise you might be pulling in the doodle dashboard classes from your local pip packages.
Remove the library with:
$ sudo rm -rf /Library/Python/3.6/site-packages/doodledashboard/
