Refactor.

Author: toddbirchard

.env.example

@@ -0,0 +1,7 @@
+FLASK_APP=wsgi.py
+FLASK_ENV=development
+SECRET_KEY=randomstringofcharacters
+LESS_BIN=/usr/local/bin/lessc
+ASSETS_DEBUG=False
+LESS_RUN_IN_DEBUG=False
+COMPRESSOR_DEBUG=True

README.md

@@ -41,6 +41,20 @@ $ pipenv update
 $ flask run
 ```
 
+## Usage
+
+Replace the values in **.env.example** with your values and rename this file to **.env**:
+
+* `FLASK_APP`: Entry point of your application (should be `wsgi.py`).
+* `FLASK_ENV`: The environment to run your app in (either `development` or `production`).
+* `SECRET_KEY`: Randomly generated string of characters used to encrypt your app's data.
+* `LESS_BIN`: Path to your local LESS installation via `which lessc` (optional for static assets).
+* `ASSETS_DEBUG`: Debug asset creation and bundling in `development` (optional).
+* `LESS_RUN_IN_DEBUG`: Debug LESS while in `development` (optional).
+* `COMPRESSOR_DEBUG`: Debug asset compression while in `development` (optional).
+
+
+*Remember never to commit secrets saved in .env files to Github.*
 
 -----
 

config.py

@@ -10,16 +10,16 @@ class Config:
     """Flask configuration variables."""
 
     # General Config
-    SECRET_KEY = environ.get('SECRET_KEY')
     FLASK_APP = environ.get('FLASK_APP')
     FLASK_ENV = environ.get('FLASK_ENV')
+    SECRET_KEY = environ.get('SECRET_KEY')
 
     # Assets
     LESS_BIN = environ.get('LESS_BIN')
     ASSETS_DEBUG = environ.get('ASSETS_DEBUG')
     LESS_RUN_IN_DEBUG = environ.get('LESS_RUN_IN_DEBUG')
 
     # Static Assets
-    STATIC_FOLDER = environ.get('STATIC_FOLDER')
-    TEMPLATES_FOLDER = environ.get('TEMPLATES_FOLDER')
+    STATIC_FOLDER = 'static'
+    TEMPLATES_FOLDER = 'templates'
     COMPRESSOR_DEBUG = environ.get('COMPRESSOR_DEBUG')

application/__init__.py renamed to plotlydash_flask_tutorial/__init__.py

@@ -12,10 +12,12 @@ def compile_static_assets(assets):
     """
     assets.auto_build = True
     assets.debug = False
-    less_bundle = Bundle('less/*.less',
-                         filters='less,cssmin',
-                         output='dist/css/styles.css',
-                         extra={'rel': 'stylesheet/less'})
+    less_bundle = Bundle(
+        'less/*.less',
+        filters='less,cssmin',
+        output='dist/css/styles.css',
+        extra={'rel': 'stylesheet/less'}
+    )
     assets.register('less_all', less_bundle)
     if app.config['FLASK_ENV'] == 'development':
         less_bundle.build()

application/assets.py renamed to plotlydash_flask_tutorial/assets.py

@@ -10,13 +10,14 @@
 
 def create_dashboard(server):
     """Create a Plotly Dash dashboard."""
-    dash_app = dash.Dash(server=server,
-                         routes_pathname_prefix='/dashapp/',
-                         external_stylesheets=[
-                             '/static/dist/css/styles.css',
-                             'https://fonts.googleapis.com/css?family=Lato'
-                             ]
-                         )
+    dash_app = dash.Dash(
+        server=server,
+        routes_pathname_prefix='/dashapp/',
+        external_stylesheets=[
+            '/static/dist/css/styles.css',
+            'https://fonts.googleapis.com/css?family=Lato'
+        ]
+    )
 
     # Prepare a DataFrame
     df = pd.read_csv('data/311-calls.csv', parse_dates=['created'])

application/plotlydash/dashboard.py renamed to plotlydash_flask_tutorial/plotlydash/dashboard.py

@@ -1,4 +1,4 @@
-"""Core Flask app routes."""
+"""Routes for parent Flask app."""
 from flask import render_template
 from flask import current_app as app