Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joaocarabetta/waze-dash

Useful wue of waze data
https://github.com/joaocarabetta/waze-dash

Last synced: 7 days ago
JSON representation

Useful wue of waze data

Awesome Lists containing this project

README 

        
# 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 useful._



[Dash](https://plot.ly/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.



This project is intended for bootstrapping initial Dash applications using at least 

reasonable (if not best) practice. It should not be thought of as a library that can

be added as a dependency. You shouldn't assume that its internal structure 

and interfaces will be stable, as they will likely change.



## Installation



After cloning/downloading the repository, simply install Slapdash as a package

into your target virtualenv:



    cd 

    pip install -e .



## Usage



1. In `index.py`, select the main layout you want from `layouts.py`.

1. Create your pages in different files in `pages`, by defining a `layout` and

   callbacks each page needs .

1. Add your pages to the `urls` attribute in `router.py`.

1. Add desired pages to `NAV_ITEMS` (if using a navbar) in `settings.py`.

1. Add additional CSS to `assets/custom.css` (for example). 

1. Modify any additional settings in `settings.py` as desired.



## Running Your App



You can launch the app using the `run_flask.py` script, which uses Flask's

development server (and which shouldn't be used in production). The script takes

a couple of arguments optional parameters, which you can discover with the

`--help` flag.



    $ python run_flask.py --debug



You can run your app using a WSGI server (such as Gunicorn) with the `wsgi.py`

entry point like so:



    $ gunicorn slapdash.wsgi



Or if you'd rather not install the Slapdash package, relative to the root directory: 



    $ gunicorn src.slapdash.wsgi

    

    

## Boilerplate Overview



* `index.py` Entry point into the app. Imports other modules in the correct order

  and initialise the router with URL routes.

* `app.py` Creates both the Flask and Dash instances used for the app.

* `callbacks.py` callbacks go here.

* `layouts.py` Possible values for the `layout` attribute of the Dash instance

  are defined here.

* `pages.py` Custom pages to link to routes go here.

* `wsgi.py` Contains `application` attribute suitable for pointing WSGI servers at.

* `settings.py` Configurable settings for the application. 

* `exceptions.py` Exceptions used by the app are defined here.

* `components.py` Convenient Python pseudo-components defined here, such as `Row` and

  `Col` for an easy experience creating Bootstrap rows and columns.

* `utils.py` Utility things defined here.

* `assets` Location for static assets that will be exposed to the web server. 



## Included Libraries



Slapdash includes a few libraries for getting fully functional applications off

the ground faster. These include:



* [Bootstrap v4](https://getbootstrap.com) Just the CSS, primarily for its grid layout.

* [Font Awesome](http://fontawesome.io) Because everyone wants pretty icons.



## Useful References



1. [The Dash User Guide](https://plot.ly/dash)

   

2. [Plotly Python client figure reference](https://plot.ly/python/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](https://community.plot.ly/c/dash)



4. [Dash Show and Tell Community Thread](https://community.plot.ly/t/show-and-tell-community-thread-tada)



4. [The Dash GitHub Repository](https://github.com/plotly/dash)