Merge pull request #15 from Kevin-Mok/dev

Get tracks from user and all info except audio features

.gitignore

@@ -3,3 +3,6 @@ db.sqlite3
 *.bak
 .idea/
 .vscode/*
+
+spotify-keys.sh
+Pipfile

MVPs.txt

@@ -1 +0,0 @@
-- login to Spotify using API and console.log number of songs in library

sample-track-obj.json

@@ -0,0 +1,250 @@
+{
+   'added_at':'2018-05-18T19:16:36Z',
+   'track':{
+      'album':{
+         'album_type':'single',
+         'artists':[
+            {
+               'external_urls':{
+                  'spotify':'https://open.spotify.com/artist/64KEffDW9EtZ1y2vBYgq8T'
+               },
+               'href':'https://api.spotify.com/v1/artists/64KEffDW9EtZ1y2vBYgq8T',
+               'id':'64KEffDW9EtZ1y2vBYgq8T',
+               'name':'Marshmello',
+               'type':'artist',
+               'uri':'spotify:artist:64KEffDW9EtZ1y2vBYgq8T'
+            },
+            {
+               'external_urls':{
+                  'spotify':'https://open.spotify.com/artist/5gCRApTajqwbnHHPbr2Fpi'
+               },
+               'href':'https://api.spotify.com/v1/artists/5gCRApTajqwbnHHPbr2Fpi',
+               'id':'5gCRApTajqwbnHHPbr2Fpi',
+               'name':'Juicy J',
+               'type':'artist',
+               'uri':'spotify:artist:5gCRApTajqwbnHHPbr2Fpi'
+            },
+            {
+               'external_urls':{
+                  'spotify':'https://open.spotify.com/artist/4IWBUUAFIplrNtaOHcJPRM'
+               },
+               'href':'https://api.spotify.com/v1/artists/4IWBUUAFIplrNtaOHcJPRM',
+               'id':'4IWBUUAFIplrNtaOHcJPRM',
+               'name':'James Arthur',
+               'type':'artist',
+               'uri':'spotify:artist:4IWBUUAFIplrNtaOHcJPRM'
+            }
+         ],
+         'available_markets':[
+            'AD',
+            'AR',
+            'AT',
+            'AU',
+            'BE',
+            'BG',
+            'BO',
+            'BR',
+            'CA',
+            'CH',
+            'CL',
+            'CO',
+            'CR',
+            'CY',
+            'CZ',
+            'DE',
+            'DK',
+            'DO',
+            'EC',
+            'EE',
+            'ES',
+            'FI',
+            'FR',
+            'GB',
+            'GR',
+            'GT',
+            'HK',
+            'HN',
+            'HU',
+            'ID',
+            'IE',
+            'IL',
+            'IS',
+            'IT',
+            'JP',
+            'LI',
+            'LT',
+            'LU',
+            'LV',
+            'MC',
+            'MT',
+            'MX',
+            'MY',
+            'NI',
+            'NL',
+            'NO',
+            'NZ',
+            'PA',
+            'PE',
+            'PH',
+            'PL',
+            'PT',
+            'PY',
+            'RO',
+            'SE',
+            'SG',
+            'SK',
+            'SV',
+            'TH',
+            'TR',
+            'TW',
+            'US',
+            'UY',
+            'VN',
+            'ZA'
+         ],
+         'external_urls':{
+            'spotify':'https://open.spotify.com/album/6TvqOieExu0IJb9Q1gOoCz'
+         },
+         'href':'https://api.spotify.com/v1/albums/6TvqOieExu0IJb9Q1gOoCz',
+         'id':'6TvqOieExu0IJb9Q1gOoCz',
+         'images':[
+            {
+               'height':640,
+               'url':'https://i.scdn.co/image/b3556956b8e4881c85228ada91aa953e5c0458ef',
+               'width':640
+            },
+            {
+               'height':300,
+               'url':'https://i.scdn.co/image/d76072f5ca739466bd27f42f3356fa1a38c6a92d',
+               'width':300
+            },
+            {
+               'height':64,
+               'url':'https://i.scdn.co/image/bfd092dfa503566d9c9a3042f213fe02bed8a5cc',
+               'width':64
+            }
+         ],
+         'name':'You Can Cry',
+         'release_date':'2018-05-04',
+         'release_date_precision':'day',
+         'type':'album',
+         'uri':'spotify:album:6TvqOieExu0IJb9Q1gOoCz'
+      },
+      'artists':[
+         {
+            'external_urls':{
+               'spotify':'https://open.spotify.com/artist/64KEffDW9EtZ1y2vBYgq8T'
+            },
+            'href':'https://api.spotify.com/v1/artists/64KEffDW9EtZ1y2vBYgq8T',
+            'id':'64KEffDW9EtZ1y2vBYgq8T',
+            'name':'Marshmello',
+            'type':'artist',
+            'uri':'spotify:artist:64KEffDW9EtZ1y2vBYgq8T'
+         },
+         {
+            'external_urls':{
+               'spotify':'https://open.spotify.com/artist/5gCRApTajqwbnHHPbr2Fpi'
+            },
+            'href':'https://api.spotify.com/v1/artists/5gCRApTajqwbnHHPbr2Fpi',
+            'id':'5gCRApTajqwbnHHPbr2Fpi',
+            'name':'Juicy J',
+            'type':'artist',
+            'uri':'spotify:artist:5gCRApTajqwbnHHPbr2Fpi'
+         },
+         {
+            'external_urls':{
+               'spotify':'https://open.spotify.com/artist/4IWBUUAFIplrNtaOHcJPRM'
+            },
+            'href':'https://api.spotify.com/v1/artists/4IWBUUAFIplrNtaOHcJPRM',
+            'id':'4IWBUUAFIplrNtaOHcJPRM',
+            'name':'James Arthur',
+            'type':'artist',
+            'uri':'spotify:artist:4IWBUUAFIplrNtaOHcJPRM'
+         }
+      ],
+      'available_markets':[
+         'AD',
+         'AR',
+         'AT',
+         'AU',
+         'BE',
+         'BG',
+         'BO',
+         'BR',
+         'CA',
+         'CH',
+         'CL',
+         'CO',
+         'CR',
+         'CY',
+         'CZ',
+         'DE',
+         'DK',
+         'DO',
+         'EC',
+         'EE',
+         'ES',
+         'FI',
+         'FR',
+         'GB',
+         'GR',
+         'GT',
+         'HK',
+         'HN',
+         'HU',
+         'ID',
+         'IE',
+         'IL',
+         'IS',
+         'IT',
+         'JP',
+         'LI',
+         'LT',
+         'LU',
+         'LV',
+         'MC',
+         'MT',
+         'MX',
+         'MY',
+         'NI',
+         'NL',
+         'NO',
+         'NZ',
+         'PA',
+         'PE',
+         'PH',
+         'PL',
+         'PT',
+         'PY',
+         'RO',
+         'SE',
+         'SG',
+         'SK',
+         'SV',
+         'TH',
+         'TR',
+         'TW',
+         'US',
+         'UY',
+         'VN',
+         'ZA'
+      ],
+      'disc_number':1,
+      'duration_ms':194533,
+      'explicit':False,
+      'external_ids':{
+         'isrc':'USQX91800946'
+      },
+      'external_urls':{
+         'spotify':'https://open.spotify.com/track/3ZbJMlEL4Kcme0ONRO7Slx'
+      },
+      'href':'https://api.spotify.com/v1/tracks/3ZbJMlEL4Kcme0ONRO7Slx',
+      'id':'3ZbJMlEL4Kcme0ONRO7Slx',
+      'name':'You Can Cry',
+      'popularity':81,
+      'preview_url':'https://p.scdn.co/mp3-preview/6c31f3dee18a1e7c452ce9b6948a6e04aa7629d6?cid=aefd4e45060d4f9ba5bea0f6e6d36359',
+      'track_number':1,
+      'type':'track',
+      'uri':'spotify:track:3ZbJMlEL4Kcme0ONRO7Slx'
+   }
+}

spotifyvis/views.py

@@ -5,9 +5,14 @@ import random
 import requests
 import os
 import urllib
+import json
+import pprint
 from datetime import datetime
 
 TIME_FORMAT = '%Y-%m-%d-%H-%M-%S'
+library_stats = {"audio_features":{}, "genres":{}, "year_released":{}, "artists":{}, "num_songs":0, "popularity":[], "total_runtime":0}
+
+#  generate_random_string {{{ # 
 
 def generate_random_string(length):
     """Generates a random string of a certain length
@@ -26,6 +31,9 @@ def generate_random_string(length):
     
     return rand_str
 
+#  }}} generate_random_string # 
+
+#  token_expired {{{ # 
 
 def token_expired(token_obtained_at, valid_for):
     """Returns True if token expired, False if otherwise
@@ -37,11 +45,17 @@ def token_expired(token_obtained_at, valid_for):
     time_elapsed = (datetime.today() - token_obtained_at).total_seconds()
     return time_elapsed >= valid_for
 
+#  }}} token_expired # 
+
+#  index {{{ # 
 
 # Create your views here.
 def index(request):
     return render(request, 'spotifyvis/index.html')
 
+#  }}}  index # 
+
+#  login {{{ # 
 
 def login(request):
 
@@ -62,6 +76,10 @@ def login(request):
     authorize_url = "https://accounts.spotify.com/authorize/?{}".format(params)
     return redirect(authorize_url)
 
+#  }}} login # 
+
+#  callback {{{ # 
+
 def callback(request):
     # Attempt to retrieve the authorization code from the query string
     try:
@@ -84,13 +102,15 @@ def callback(request):
     request.session['access_token'] = response['access_token']
     request.session['refresh_token'] = response['refresh_token']
     request.session['valid_for'] = response['expires_in']
-    print(response)
+    #  print(response)
 
     return redirect('user_data')
 
+#  }}} callback # 
 
-def user_data(request):
+#  user_data {{{ # 
 
+def user_data(request):
     token_obtained_at = datetime.strptime(request.session['token_obtained_at'], TIME_FORMAT)
     valid_for = int(request.session['valid_for'])
 
@@ -116,4 +136,122 @@ def user_data(request):
         'user_name': user_data_response['display_name'],
         'id': user_data_response['id'],
     }
-    return render(request, 'spotifyvis/user_data.html', context)
+
+    tracks_to_query = 5
+    parse_library(headers, tracks_to_query)
+    return render(request, 'spotifyvis/user_data.html', context)
+
+#  }}} user_data  # 
+
+#  parse_library {{{ # 
+
+def parse_library(headers, tracks):
+    """Scans user's library for certain number of tracks to update library_stats with.
+
+    :headers: For API call.
+    :tracks: Number of tracks to get from user's library.
+    :returns: None
+
+    """
+    #  TODO: implement importing entire library with 0 as tracks param
+    # number of tracks to get with each call
+    limit = 5
+    # keeps track of point to get songs from
+    offset = 0
+    payload = {'limit': str(limit)}
+    for i in range(0, tracks, limit):
+        payload['offset'] = str(offset)
+        saved_tracks_response = requests.get('https://api.spotify.com/v1/me/tracks', headers=headers, params=payload).json()
+        for track_dict in saved_tracks_response['items']:
+            get_track_info(track_dict['track'])
+            #  get_genre(headers, track_dict['track']['album']['id'])
+            for artist_dict in track_dict['track']['artists']:
+                increase_artist_count(headers, artist_dict['name'], artist_dict['id'])
+        # calculates num_songs with offset + songs retrieved
+        library_stats['num_songs'] = offset + len(saved_tracks_response['items'])
+        offset += limit
+    calculate_genres_from_artists(headers)
+    pprint.pprint(library_stats)
+
+#  }}} parse_library # 
+
+#  increase_nested_key {{{ # 
+
+def increase_nested_key(top_key, nested_key, amount=1):
+    """Increases count for the value of library_stats[top_key][nested_key]. Checks if nested_key exists already and takes
+    appropriate action.
+
+    :top_key: First key of library_stats.
+    :nested_key: Key in top_key's dict for which we want to increase value of.
+    :returns: None
+
+    """
+    if nested_key not in library_stats[top_key]:
+        library_stats[top_key][nested_key] = amount
+    else:
+        library_stats[top_key][nested_key] += amount
+
+#  }}} increase_nested_key # 
+
+#  increase_artist_count {{{ # 
+
+def increase_artist_count(headers, artist_name, artist_id):
+    """Increases count for artist in library_stats and stores the artist_id. 
+
+    :headers: For making the API call.
+    :artist_name: Artist to increase count for.
+    :artist_id: The Spotify ID for the artist.
+    :returns: None
+
+    """
+    if artist_name not in library_stats['artists']:
+        library_stats['artists'][artist_name] = {}
+        library_stats['artists'][artist_name]['count'] = 1
+        library_stats['artists'][artist_name]['id'] = artist_id
+    else:
+        library_stats['artists'][artist_name]['count'] += 1
+
+#  }}} increase_artist_count # 
+
+#  get_track_info {{{ # 
+
+def get_track_info(track_dict):
+    """Get all the info from the track_dict directly returned by the API call in parse_library.
+
+    :track_dict: Dict returned from the API call containing the track info.
+    :returns: None
+
+    """
+    #  popularity
+    library_stats['popularity'].append(track_dict['popularity'])
+
+    # year
+    year_released = track_dict['album']['release_date'].split('-')[0]
+    increase_nested_key('year_released', year_released)
+    
+    # artist
+    #  artist_names = [artist['name'] for artist in track_dict['artists']]
+    #  for artist_name in artist_names:
+        #  increase_nested_key('artists', artist_name)
+
+    # runtime
+    library_stats['total_runtime'] += float(track_dict['duration_ms']) / 60
+
+#  }}} get_track_info # 
+
+#  calculate_genres_from_artists {{{ # 
+
+def calculate_genres_from_artists(headers):
+    """Tallies up genre counts based on artists in library_stats.
+
+    :headers: For making the API call.
+    :returns: None
+
+    """
+    for artist_entry in library_stats['artists'].values():
+        artist_response = requests.get('https://api.spotify.com/v1/artists/' + artist_entry['id'], headers=headers).json()
+        # increase each genre count by artist count
+        for genre in artist_response['genres']:
+            increase_nested_key('genres', genre, artist_entry['count'])
+
+#  }}} calculate_genres_from_artists #