Flask + Dashboard = Flash. A project dashboard that works.
The configuration, either saved in config.json
at the project root or as the
$FLASH_CONFIG
environment variable, should look like:
{ "project_name": <name of the project>, "services": [ { "name": "tracker", "api_token": <your API token>, "project_id": <your project ID> } ] }
project_name
- the project's name to display in the footer (defaults to"unnamed"
)services
- an array of service configurations (see flash_services for details and configuration options)style
- the stylesheet to use (defaults to"default"
, which is currently the only option...)
The easiest way to install Flash for development is:
- Install the dependencies:
pip3 install -r requirements.txt
- Install the package in development mode:
python3 setup.py develop
- To run it locally, save a configuration as either
config.json
or$FLASH_CONFIG
then run:python3 scripts/launch.py
- To run the tests, use
python setup.py test
or runpy.test
; the latter allows you to add flags such as--runslow
(to include the integration tests) or--pytest-pylint
(to lint the package before testing).
The templates are written using the Jinja2 template language.