An overly simple dashboard framework
Project description
dashbored
A simple dashboard framework created out of boredom. It provides a simple, tabular interface using a Python module that implements the defined specification.
Usage
Creating a dashbored module
The dashbored specification expects the following attributes.
- fetch (required) - A function that takes no arguments and returns a list of mappings of field names to values.
- FORMAT (optional, suggested) - This is a Python format mini-language string using columns from the data source as keywords.
- FREQUENCY (optional, suggested) - The frequency to fetch updated data using the
fetch
function
For convenience, it's also suggested to create an entry_point within the dashbored
group although it's not required as noted below.
Command line interface
If a dashbored module provides the suggested defaults, then running one should be as easy as:
python3 -m dashbored <spec>
where specification is either a fully qualified module name or an entrypoint name within the dashbored
group.
Library interface
To be used as a library, simply provide the above mentioned arguments in the same positional order to the create
functon in the dashbored
module.
import dashbored
def myfetch():
...
dashbored.create("{field_a} {field_b}", myfetch, 1)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dashbored-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c4fb71305c22ae88b3f9f92b823f50d7340d2837374e143f63463bf4c3840823 |
|
MD5 | a2ba1e981dcc741cfc2158cd5a4a7ede |
|
BLAKE2b-256 | 838882607bea6497f737921e772a9ac1805235d49fbb1b5894f0665a0aba7c68 |