refactor functions, add comments

spots.py

@@ -12,6 +12,7 @@ from secrets import CLIENT_ID, CLIENT_SECRET
 
 import logging
 
+
 logging.basicConfig(level=logging.DEBUG)
 console = logging.StreamHandler()
 console.setLevel(logging.INFO)
@@ -22,9 +23,6 @@ annoying.disabled=True
 
 
 def main():
-    """
-    make the static site
-    """
 
     if len(sys.argv) > 1:
         username = sys.argv[1]
@@ -32,7 +30,21 @@ def main():
         logging.info("Whoops, need your username!")
         logging.info("usage: python spots.py [username]")
         sys.exit()
+    
+    ml = make_master_list(username)
+
+    # Step 1: dump to master list json
+    ml.export_ids_list_to_file()
+
+    # Step 2: edit the master list json file directly...
 
+    ## Step 3: create the static site
+    ## (this will make master list details json file)
+    #logging.debug('calling MasterList.static_site()')
+    #ml.static_site('site')
+
+
+def make_master_list(username):
     # Spotify API permission scope
     scope = "playlist-read-private"
     
@@ -53,14 +65,7 @@ def main():
     ml = SpotifyMasterList(token,username)
     logging.debug("done creating spotify master list")
 
-    ## Step 1: dump to json
-    #ml.export_ids_list_to_file()
-
-    # Step 2: edit the json file directly...
-
-    # Step 3: create the static site
-    logging.debug('calling MasterList.static_site()')
-    ml.static_site('site')
+    return ml
 
 
 if __name__=="__main__":

spots_objects.py

@@ -11,10 +11,20 @@ import spotipy.util as util
 
 from jinja2 import Environment, PackageLoader, select_autoescape
 
+# Keywords for use in the HTML template
+# (key is Jinja variable name,
+#  value is Jinja variable value)
+# 
 kwargkward = dict(
         BASEURL = '/spots/'
 )
 
+# Static variables
+IDS_JSON_FILE = 'master_list.json'
+DETAILS_JSON_FILE = 'master_list_details.json'
+OUTPUT_DIR = 'output'
+ASSETS_DIR = 'assets'
+
 class SpotifyMasterList(object):
     """
     This object represents a file
@@ -44,10 +54,11 @@ class SpotifyMasterList(object):
         # this stores the details of each playlist
         self.playlists = []
 
-        self.IDS_JSON_FILE = 'master_list.json'
-        self.DETAILS_JSON_FILE = 'master_list_details.json'
-        self.OUTPUT_DIR = 'output'
-        self.ASSETS_DIR = 'assets'
+        # static vars
+        self.IDS_JSON_FILE = IDS_JSON_FILE
+        self.DETAILS_JSON_FILE = DETAILS_JSON_FILE
+        self.OUTPUT_DIR = OUTPUT_DIR
+        self.ASSETS_DIR = ASSETS_DIR
 
 
 
@@ -426,15 +437,20 @@ class SpotifyMasterList(object):
             logging.debug('found json file %s, importing'%(json_file))
             # Details are stored in the details json file
             try:
+                # try to open the details json file
                 with open(json_file,'w') as f:
                     self.playlists = json.load(f)
                 logging.debug('successfully loaded json file %s'%(json_file))
             except io.UnsupportedOperation:
+                # error loading details json file,
+                # so make a new one
                 logging.debug('could not load json file %s'%(json_file))
                 subprocess.call(['rm',json_file])
                 logging.debug('empty json file %s, calling export playlist details'%(json_file))
                 self.export_playlist_details()
         else:
+            # no details json file,
+            # so make a new one
             logging.debug('no json file %s, calling export playlist details'%(json_file))
             self.export_playlist_details()