blob: 7ea0d3c607912dee1b0f33e56ede01be2e830ec8 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
JARVIS
======
JARVIS is a dashboard framework designed to run on the Raspberry Pi.
It features live-updating widgets using
[server-sent events](https://en.wikipedia.org/wiki/Server-sent_events) and can be
easily extended to fit your needs.
Screenshots
-----------
Dependencies
------------
JARVIS requires Python 3.6+ to run.
Install requirements:
pip install -r requirements.txt
For development it's recommended to use [virtualenv](https://virtualenv.pypa.io).
Configuration
-------------
All configuration of widgets is done in a single Python source file. The
configuration is specified by setting the `JARVIS_SETTINGS` environment
variable.
A sample config (`jarvis/config.py.sample`) is provided. This file can be used as a
starting point for your own configuration.
Copy `jarvis/config.py.sample` to `jarvis/config.py` and edit it to suit your needs.
Usage
-----
After installing dependencies and creating a config file, the app can be started
by running:
JARVIS_SETTINGS=config.py make run
To start the app in debug mode, use:
JARVIS_SETTINGS=config.py make debug
Run a job standalone and pretty-print output (useful for debugging):
JARVIS_SETTINGS=config.py make run-job
Create Google API credentials (required for calendar and gmail widget):
JARVIS_SETTINGS=config.py make google-api-auth
Create a new widget:
make widget
Create a new dashboard:
make dashboard
Widgets
-------
See [WIDGETS.md](docs/WIDGETS.md) for documentation on available widgets.
Deployment
----------
See [INSTALL.md](docs/INSTALL.md) for a basic deployment guide.
License
-------
Licensed under the MIT license. See the [LICENSE](LICENSE) file if you've never
seen it before.
|
