dash-tools 0.5

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.

Deploy your app to Heroku in under a minute!

About

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

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

Want to deploy your app to the web? We've got you covered. With Heroku support, deploying your project will take under a minute.

Installation

Ready to use dash-tools? Installation is easy with pip:

pip install dash-tools

Find dash-tools on PyPi

Usage 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 "MyWonderfulApp" using 'minimal' theme
dash-tools --init MyWonderfulApp minimal

To list out available templates, use the --templates command:

# Display available templates
dash-tools --templates

>>> dash-tools: templates: List of available templates:
>>>   default
>>>   minimal
>>>   heroku

To create a project and deploy to Heroku, it is quite simple. You can even create a project using the heroku template to speed things up:

# Create the heroku template app
dash-tools --init MyGreatHerokuApp heroku
cd MyGreatHerokuApp/

# Using the following command will start the deploy process
# dash-tools --deploy-heroku <heroku-app-name>
# Follow the instructions in the console to log into heroku
# Both the Heroku CLI and Git are needed - see Commands section below
dash-tools --deploy-heroku my-great-heroku-app

# And that's really it! A new heroku app and git remote will be created
# Automatic deployment? Yes please.

Templates

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

• default - the default multi-page template. 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.
• heroku - Build for deployment with Heroku. Includes necessary deploy files. Built on the minimal template.

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

Commands

Project Commands

• --deploy-heroku Args: REQUIRED (project name) : Deploys the project to Heroku using the Heroku CLI (Must Install Seperately) and Git. Invoke from the project root directory.
• --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.
• --templates, -t : List available templates.

Other

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

Development

Creating Templates

1. Templates are found here: dash_tools/templating/templates/<Template Name>. When a user uses CLI to choose a template with the name <Template Name> the template will be copied to their system.

2. Adding a new template to the templates directory requires adding the new template to the Enum list in templating.Templates Enum. Template name must match Enum value, eg.

   class Templates(Enum):
      DEFAULT = 'default'
      MINIMAL = 'minimal'
      NEWTEMPLATE = 'newtemplate'
   

3. Any file names or files containing the strings {appName} or {createTime} will be formatted with the given app name and creation time. Eg. README.md.template: # Created on {createTime} will copy to the user's filesystem as README.md: # Creaded on 2022-03-30 22:06:07

4. All template files must end in .template

License

MIT License. See LICENSE.txt file.