Improve docs and other fixes (#151)

* Minor doc tweaks, and improve static substitution location

* Demo should use latest static substitution logic

* Refine static use and fix demo session app

* Add renderer script to directly rendered apps

* Make pipe demo run on a completely local basis

* Remove unwanted print statements

* Update dpd version

* Add in coveralls package to dev requirements

Author: delsim

demo/demo/bootstrap_app.py

@@ -72,9 +72,11 @@ def session_demo_alert_callback(n_clicks, session_state=None, **kwargs):
         raise NotImplementedError("Cannot handle a missing session state")
     csf = session_state.get('bootstrap_demo_state', None)
     if not csf:
-        csf = dict(clicks=0)
-        session_state['bootstrap_demo_state'] = csf
+        csf = dict(clicks=0, overall=0)
     else:
         csf['clicks'] = n_clicks
+        if n_clicks is not None and n_clicks > csf.get('overall_max',0):
+            csf['overall_max'] = n_clicks
+    session_state['bootstrap_demo_state'] = csf
     return "Button has been clicked %s times since the page was rendered" %n_clicks
 

demo/demo/plotly_apps.py

@@ -118,7 +118,7 @@ def callback_c(*args, **kwargs):
     return "Args are [%s] and kwargs are %s" %(",".join(args), str(kwargs))
 
 liveIn = DjangoDash("LiveInput",
-                    serve_locally=False,
+                    serve_locally=True,
                     add_bootstrap_links=True)
 
 liveIn.layout = html.Div([

dev_requirements.txt

@@ -1,10 +1,11 @@
+coveralls>=1.6.0
 channels>=2.0
 channels-redis
 daphne
 Django>=2.0,<2.3
 django-bootstrap4
 django-redis
-dpd-static-support
+dpd-static-support>=0.0.4
 grip
 pandas
 pylint

django_plotly_dash/dash_wrapper.py

@@ -453,7 +453,7 @@ def dispatch(self):
         'Perform dispatch, using request embedded within flask global state'
         import flask
         body = flask.request.get_json()
-        return self. dispatch_with_args(body, argMap=dict())
+        return self.dispatch_with_args(body, argMap=dict())
 
     #pylint: disable=too-many-locals
     def dispatch_with_args(self, body, argMap):

django_plotly_dash/middleware.py

@@ -25,7 +25,7 @@
 
 '''
 
-from .util import serve_locally
+from .util import serve_locally, static_path
 
 #pylint: disable=too-few-public-methods
 
@@ -46,7 +46,7 @@ def add_config(self, config):
     def add_scripts(self, scripts):
         'Add js content'
         if scripts:
-            self.scripts = scripts
+            self.scripts += scripts
 
 class ContentCollector:
     '''
@@ -103,9 +103,12 @@ def __call__(self, request):
 
 
 # Bootstrap4 substitutions, if available
+dpd_substitutions = []
 try:
-    from dpd_static_support.mappings import substitutions as dpd_ss_substitutions
-    substitutions += dpd_ss_substitutions
+    from dpd_static_support.mappings import substitutions as dpd_direct_substitutions
+    dpd_substitutions += dpd_direct_substitutions
+    from dpd_static_support.mappings import static_substitutions as dpd_ss_substitutions
+    dpd_substitutions += [(x, static_path(y)) for x, y in dpd_ss_substitutions]
 except Exception as e:
     pass
 
@@ -119,7 +122,7 @@ def __init__(self, get_response):
         substitutions = []
 
         if serve_locally():
-            substitutions += dpd_ss_substitutions
+            substitutions += dpd_substitutions
 
         self._encoding = "utf-8"
 

django_plotly_dash/templatetags/plotly_dash.py

@@ -97,10 +97,15 @@ def plotly_direct(context, name=None, slug=None, da=None):
 
     # Load embedded holder inserted by middleware
     eh = context.request.dpd_content_handler.embedded_holder
+
+    # Need to add in renderer launcher
+    renderer_launcher = '<script id="_dash-renderer" type="application/javascript">var renderer = new DashRenderer();</script>'
+
     app.set_embedded(eh)
     try:
         resp = view_func()
     finally:
+        eh.add_scripts(renderer_launcher)
         app.exit_embedded()
 
     return locals()

django_plotly_dash/util.py

@@ -27,7 +27,6 @@
 
 from django.conf import settings
 from django.core.cache import cache
-from django.contrib.staticfiles.templatetags.staticfiles import static
 
 def _get_settings():
     try:
@@ -107,7 +106,14 @@ def full_asset_path(module_name, asset_path):
     return path_contrib
 
 def static_asset_path(module_name, asset_path):
-    return static(full_asset_path(module_name, asset_path))
+    return static_path(full_asset_path(module_name, asset_path))
 
 def serve_locally():
     return _get_settings().get('serve_locally', settings.DEBUG)
+
+def static_path(relative_path):
+    try:
+        static_url = settings.STATIC_URL
+    except:
+        static_url = '/static/'
+    return "%s%s" %(static_url, relative_path)

django_plotly_dash/version.py

@@ -23,4 +23,4 @@
 
 '''
 
-__version__ = "0.9.10"
+__version__ = "0.9.11"

django_plotly_dash/views.py

@@ -30,7 +30,7 @@
 from django.shortcuts import redirect
 
 from .models import DashApp
-from .util import get_initial_arguments
+from .util import get_initial_arguments, static_path
 
 def routes(*args, **kwargs):
     'Return routes'
@@ -122,9 +122,9 @@ def component_suites(request, resource=None, component=None, extra_element="", *
 
     get_params = request.GET.urlencode()
     if get_params and False:
-        redone_url = "/static/dash/component/%s/%s%s?%s" %(component, extra_element, resource, get_params)
+        redone_url = static_path("dash/component/%s/%s%s?%s" %(component, extra_element, resource, get_params))
     else:
-        redone_url = "/static/dash/component/%s/%s%s" %(component, extra_element, resource)
+        redone_url = static_path("dash/component/%s/%s%s" %(component, extra_element, resource))
 
     return HttpResponseRedirect(redirect_to=redone_url)
 
@@ -133,9 +133,9 @@ def app_assets(request, **kwargs):
     get_params = request.GET.urlencode()
     extra_part = ""
     if get_params:
-        redone_url = "/static/dash/assets/%s?%s" %(extra_part, get_params)
+        redone_url = static_path("dash/assets/%s?%s" %(extra_part, get_params))
     else:
-        redone_url = "/static/dash/assets/%s" % extra_part
+        redone_url = static_path("dash/assets/%s" % extra_part)
 
     return HttpResponseRedirect(redirect_to=redone_url)
 

docs/configuration.rst

@@ -72,6 +72,8 @@ and also providing a list of components used
 
       # django-plotly-dash components
       'dpd_components',
+      # static support if serving local assets
+      'dpd_static_support',
 
       # Other components, as needed
       'dash_bootstrap_components',

docs/installation.rst

@@ -26,7 +26,8 @@ can be safely added now even if not used.
 
 If assets are being served locally through the use of the global ``serve_locally`` or on a per-app basis, then
 ``django_plotly_dash.middleware.ExternalRedirectionMiddleware`` should be added, along with the ``whitenoise`` package whose
-middleware should also be added as per the instructions for that package.
+middleware should also be added as per the instructions for that package. In addition, ``dpd_static_support`` should be
+added to the ``INSTALLED_APPS`` setting.
 
 The application's routes need to be registered within the routing structure by an appropriate ``include`` statement in
 a ``urls.py`` file::