dash-tools 0.2

Plotly Dash Template Generator and Tools

dash-tools - An Open-Source Plotly Dash CLI Toolchain

Create a templated multi-page Plotly Dash app with CLI in less than 7 seconds!

About

dash-tools is an open-source toolchain for Plotly Dash Framework. With a user-friendly command line interface, creating Dash applications will never be quicker.

With user and developer-friendly templates, generating a new app only takes senconds. In fact, it will take longer to install this tool than it will to use it!

Installation

dash-tools is available through pip.

pip install dash-tools

Examples

Below are common usage examples. See Commands section for more details.

# Create a new Dash app called MyDashApp
dash-tools --init MyDashApp

Templates are also available using the optional template argument after --init:

# Create a new Dash app called MyDashApp using 'minimal' theme
dash-tools --init MyDashApp minimal

Templates

Listed below are available project template templates. Please see the above example on how to use templates.

• default - the default multi-page theme. Includes examples of ClientsideCallbacks, multi-page routing, external stylesheets, header, footer, and 404 page.
• minimal - for the minimalists. Not much here but the bare bones.

If you would like to develop templates, please read the Creating Templates section below.

Commands

Project Build Commands

• --init, -i Args: REQUIRED (project name) OPTIONAL (template) : Creates a Plotly Dash app with the given name in the current working directory. Optional args specified can be used for templates.
• --use_stack Args: (heroku) : Add stack to current project. Currently only supports Heroku. CURRENTLY UNDER DEVELOPMENT.

Debug and Run

• --run, -r: Run the current project in non-debug mode. CURRENTLY UNDER DEVELOPMENT.
• --dev, -d: Run the current project in debug/dev mode. CURRENTLY UNDER DEVELOPMENT.

Other

• --help, -h: Display CLI helpful hints
• --version: Display current version.

Development

Creating Templates

Templates go in the dash_tools/templating/templates directory. The entire directory structure will be copied to the users source directory if they choose the correct Templates Enum.

Adding a new template to the templates directory also requires adding the new template to the Enum list in buildTemplate:Templates Enum. Template name must match Enum value!

Any file name or file containing the strings {appName} or {createTime} will be formatted with the given app name and creation time.

License

MIT License. See LICENSE.txt file.