harisyammnv / slapdash

Boilerplate for bootstrapping scalable multi-page Dash applications

Slapdash

Boilerplate for bootstrapping multi-page Dash applications

Note: This is a work in progress, but it's probably at a point where it's more useful than not.

Dash is a Python framework for building analytical web applications. Slapdash provides a template for quickly building out a multi-page Dash application. It includes pre-built layouts based on Bootstrap, which can be extended or swapped out for layouts constructed using your own CSS.

Also included is dash_skeleton.py, a template for bootstrapping smaller single-file applications.

Usage

1. In slapdash.py, select the main layout you want from layouts.py.
2. Create your callbacks in callbacks.py.
3. Create your pages in pages.py.
4. Add your pages to the urls attribute in router.py.
5. Add desired pages to NAV_ITEMS (if using a navbar) in settings.py.
6. Add additional CSS to static/custom.css.
7. Modify any additional settings in settings.py as desired. (The only other one you will likely definitely need to change is TITLE).
8. Run the app either with python run_flask.py (--debug) or by targeting a WSGI server at wsgi.py.

Note that this project is intended for bootstrapping initial Dash applications, as opposed to being a library that you import. You probably shouldn't assume that its internal structure and interfaces will be stable, as they will likely change.

Boilerplate Overview

• slapdash.py Entry point into the app. Imports other modules in correct order.
• server.py Creates both the Flask server and Dash app instances used for the app.
• wsgi.py Contains application attribute suitable for pointing WSGI servers at.
• settings.py Configurable settings for the application.
• router.py Contains the application routes in url and initialises the router callback.
• exceptions.py Exceptions used by the app are defined here.
• layouts.py Possible values for the layout attribute of the Dash instance are defined here.
• components.py Convenience pseudo-components defined here, such as Row and Col for an easy experience creating Bootstrap rows and columns..
• utils.py Utility things defined here.
• callbacks.py Custom callbacks go here.
• pages.py Custom pages go here.
• static Location for static assets that will be exposed to the web server.

Included Libraries

Slapdash includes a few plugins for getting fully functional applications off the ground faster. These currently include:

• Bootstrap v4 Just the CSS, primarily for its grid layout.
• Font Awesome Because everyone wants pretty icons.

dash_skeleton.py

For simple applications that with a single view, the full Slapdash codebase is probably overkill. dash_skeleton.py is a Dash single-file Dash template that you can pull down and start hacking on with minimal overhead.

Useful References

1. The Dash User Guide

2. Plotly Python client figure reference Documents the contents of plotly.graph_objs, which contains the different types of charts available, as well the Layout class, for customising the appearance of charts.

3. The Dash Community Forum

4. Dash Show and Tell Community Thread

5. The Dash GitHub Repository