added docstrings, general cleanup

toddbirchard · toddbirchard · commit 9323d9b6d089 · 2019-05-13T18:07:41.000-04:00
diff --git a/application/__init__.py b/application/__init__.py
@@ -4,7 +4,8 @@
 
 def create_app():
     """Construct the core application."""
-    app = Flask(__name__, instance_relative_config=False)
+    app = Flask(__name__,
+                instance_relative_config=False)
     app.config.from_object('config.Config')
 
     with app.app_context():
diff --git a/application/dash_application/dash_example.py b/application/dash_application/dash_example.py
@@ -1,12 +1,11 @@
+"""Create a Dash app within a Flask app."""
 import glob
-from pathlib import Path, PurePath
+from pathlib import Path
 from dash import Dash
 import dash_table
-import dash_core_components as dcc
 import dash_html_components as html
 import pandas as pd
-
-p = Path('.')
+from .layout import html_layout
 
 
 def Add_Dash(server):
@@ -22,27 +21,7 @@ def Add_Dash(server):
                     routes_pathname_prefix='/dashapp/')
 
     # Override the underlying HTML template
-    dash_app.index_string = '''<!DOCTYPE html>
-        <html>
-            <head>
-                {%metas%}
-                <title>{%title%}</title>
-                {%favicon%}
-                {%css%}
-            </head>
-            <body>
-                <nav>
-                  <a href="/"><i class="fas fa-home"></i> Home</a>
-                  <a href="/dashapp/"><i class="fas fa-chart-line"></i> Embdedded Plotly Dash</a>
-                </nav>
-                {%app_entry%}
-                <footer>
-                    {%config%}
-                    {%scripts%}
-                    {%renderer%}
-                </footer>
-            </body>
-        </html>'''
+    dash_app.index_string = html_layout
 
     # Create Dash Layout comprised of Data Tables
     dash_app.layout = html.Div(
@@ -55,10 +34,10 @@ def Add_Dash(server):
 
 def get_datasets():
     """Return previews of all CSVs saved in /data directory."""
+    p = Path('.')
     data_filepath = list(p.glob('data/*.csv'))
     arr = ['This is an example Plot.ly Dash App.']
     for index, csv in enumerate(data_filepath):
-        print(PurePath(csv))
         df = pd.read_csv(data_filepath[index]).head(10)
         table_preview = dash_table.DataTable(
             id='table_' + str(index),
diff --git a/application/dash_application/layout.py b/application/dash_application/layout.py
@@ -0,0 +1,21 @@
+html_layout = '''<!DOCTYPE html>
+                    <html>
+                        <head>
+                            {%metas%}
+                            <title>{%title%}</title>
+                            {%favicon%}
+                            {%css%}
+                        </head>
+                        <body>
+                            <nav>
+                              <a href="/"><i class="fas fa-home"></i> Home</a>
+                              <a href="/dashapp/"><i class="fas fa-chart-line"></i> Embdedded Plotly Dash</a>
+                            </nav>
+                            {%app_entry%}
+                            <footer>
+                                {%config%}
+                                {%scripts%}
+                                {%renderer%}
+                            </footer>
+                        </body>
+                    </html>'''
diff --git a/application/routes.py b/application/routes.py
@@ -30,4 +30,4 @@ def home():
     return render_template('index.html',
                            title='Plotly Flask Tutorial.',
                            template='home-template',
-                           body="This is an example homepage, served with Flask.")
+                           body="This is an example homepage served with Flask.")
diff --git a/application/static/dist/css/styles.css b/application/static/dist/css/styles.css
diff --git a/config.py b/config.py
@@ -1,3 +1,4 @@
+"""App config."""
 import os
 
 
diff --git a/wsgi.py b/wsgi.py
@@ -1,3 +1,4 @@
+"""Application entry point."""
 from application import create_app
 
 app = create_app()

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""App config."""`
`1`	`2`	`import os`
`2`	`3`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+"""Application entry point."""`
`1`	`2`	`from application import create_app`
`2`	`3`
`3`	`4`	`app = create_app()`