Refactored DelayedDash into DjangoDash class. Extended documentation scope

Author: Mark Gibbs

README.md

@@ -45,7 +45,7 @@ cd django-plotly-dash
 
 ## Usage
 
-To use existing dash applications, first register them using the `DelayedDash` class. This
+To use existing dash applications, first register them using the `DjangoDash` class. This
 replaces the `Dash` class of the `dash` package.
 
 Taking a very simple example inspired by the excellent [getting started](https://dash.plot.ly/) documentation:
@@ -55,9 +55,9 @@ import dash
 import dash_core_components as dcc
 import dash_html_components as html
 
-from django_plotly_dash import DelayedDash
+from django_plotly_dash import DjangoDash
 
-app = DelayedDash('SimpleExample')
+app = DjangoDash('SimpleExample')
 
 app.layout = html.Div([
     dcc.RadioItems(
@@ -90,7 +90,7 @@ def callback_size(dropdown_color, dropdown_size):
                                                   dropdown_color)
 ```
 
-Note that the `DelayedDash` constructor requires a name to be specified. This name is then used to identify the dash app in
+Note that the `DjangoDash` constructor requires a name to be specified. This name is then used to identify the dash app in
 templates:
 
 ```jinja2

demo/demo/plotly_apps.py

@@ -2,9 +2,9 @@
 import dash_core_components as dcc
 import dash_html_components as html
 
-from django_plotly_dash import DelayedDash
+from django_plotly_dash import DjangoDash
 
-app = DelayedDash('SimpleExample')
+app = DjangoDash('SimpleExample')
 
 app.layout = html.Div([
     dcc.RadioItems(
@@ -36,7 +36,7 @@ def callback_size(dropdown_color, dropdown_size):
     return "The chosen T-shirt is a %s %s one." %(dropdown_size,
                                                   dropdown_color)
 
-a2 = DelayedDash("Ex2")
+a2 = DjangoDash("Ex2")
 a2.layout = html.Div([
     dcc.RadioItems(id="dropdown-one",options=[{'label':i,'value':j} for i,j in [
     ("O2","Oxygen"),("N2","Nitrogen"),]

django_plotly_dash/__init__.py

@@ -2,5 +2,5 @@
 
 __version__ = "0.0.4"
 
-from .dash_wrapper import DelayedDash
+from .dash_wrapper import DjangoDash
 

django_plotly_dash/dash_wrapper.py

@@ -23,7 +23,7 @@ def add_usable_app(name, app):
 
 def get_stateless_by_name(name):
     '''
-    Locate a registered dash app by name, and return a DelayedDash instance encapsulating the app.
+    Locate a registered dash app by name, and return a DjangoDash instance encapsulating the app.
     '''
     name = slugify(name)
     # TODO wrap this in raising a 404 if not found
@@ -37,7 +37,7 @@ def append_css(self, stylesheet):
     def append_script(self, script):
         self.items.append(script)
 
-class DelayedDash:
+class DjangoDash:
     def __init__(self, name=None, **kwargs):
         if name is None:
             global uid_counter

docs/extended_callbacks.rst

@@ -0,0 +1,6 @@
+.. _extended_callbacks:
+
+Extended callback syntax
+========================
+
+The ``DjangoDash`` class allows callbacks to request extra arguments when registered.

docs/index.rst

@@ -17,6 +17,9 @@ Contents
    introduction
    installation
    simple_use
+   extended_callbacks
+   template_tags
+   models_and_state
 
 
 Indices and tables

docs/models_and_state.rst

@@ -0,0 +1,4 @@
+.. _models_and_state:
+
+Django models and application state
+================

docs/simple_use.rst

@@ -1,9 +1,9 @@
 .. _simple_use:
 
-Simple Usage
+Simple usage
 ============
 
-To use existing dash applications, first register them using the ``DelayedDash`` class. This
+To use existing dash applications, first register them using the ``DjangoDash`` class. This
 replaces the ``Dash`` class from the ``dash`` package.
 
 Taking a simple example inspired by the excellent `getting started <https://dash.plot.ly/getting-started-part-2>`_ guide::
@@ -12,9 +12,9 @@ Taking a simple example inspired by the excellent `getting started <https://dash
   import dash_core_components as dcc
   import dash_html_components as html
 
-  from django_plotly_dash import DelayedDash
+  from django_plotly_dash import DjangoDash
 
-  app = DelayedDash('SimpleExample')   # replaces dash.Dash
+  app = DjangoDash('SimpleExample')   # replaces dash.Dash
 
   app.layout = html.Div([
       dcc.RadioItems(
@@ -47,8 +47,8 @@ Taking a simple example inspired by the excellent `getting started <https://dash
       return "The chosen T-shirt is a %s %s one." %(dropdown_size,
                                                     dropdown_color)
 
-Note that the ``DelayedDash`` constructor requires a name to be specified. This name is then used to identify the dash app in
-templates:::
+Note that the ``DjangoDash`` constructor requires a name to be specified. This name is then used to identify the dash app
+in templates::
 
   {%load plotly_dash%}
 

docs/template_tags.rst

@@ -0,0 +1,5 @@
+.. _template_tags:
+
+Template tags
+=============
+