code comments added for instagram graph api python code

Author: jstolpe

instagram_graph_api/python/business_discovery.py

@@ -11,30 +11,30 @@ def getAccountInfo( params ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['fields'] = 'business_discovery.username(' + params['ig_username'] + '){username,website,name,ig_id,id,profile_picture_url,biography,follows_count,followers_count,media_count}'
-	endpointParams['access_token'] = params['access_token']
-
-	url = params['endpoint_base'] + params['instagram_account_id']
-
-	return makeApiCall( url, endpointParams, params['debug'] )
-
-params = getCreds()
-params['debug'] = 'no'
-response = getAccountInfo( params )
-
-print "\n---- ACCOUNT INFO -----\n"
-print "username:"
-print response['json_data']['business_discovery']['username']
-print "\nwebsite:"
-print response['json_data']['business_discovery']['website']
-print "\nnumber of posts:"
-print response['json_data']['business_discovery']['media_count']
-print "\nfollowers:"
-print response['json_data']['business_discovery']['followers_count']
-print "\nfollowing:"
-print response['json_data']['business_discovery']['follows_count']
-print "\nprofile picture url:"
-print response['json_data']['business_discovery']['profile_picture_url']
-print "\nbiography:"
-print response['json_data']['business_discovery']['biography']
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['fields'] = 'business_discovery.username(' + params['ig_username'] + '){username,website,name,ig_id,id,profile_picture_url,biography,follows_count,followers_count,media_count}' # string of fields to get back with the request for the account
+	endpointParams['access_token'] = params['access_token'] # access token
+
+	url = params['endpoint_base'] + params['instagram_account_id'] # endpoint url
+
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
+
+params = getCreds() # get creds
+params['debug'] = 'no' # set debug
+response = getAccountInfo( params ) # hit the api for some data!
+
+print "\n---- ACCOUNT INFO -----\n" # display latest post info
+print "username:" # label
+print response['json_data']['business_discovery']['username'] # display username
+print "\nwebsite:" # label
+print response['json_data']['business_discovery']['website'] # display users website
+print "\nnumber of posts:" # label
+print response['json_data']['business_discovery']['media_count'] # display number of posts user has made
+print "\nfollowers:" # label
+print response['json_data']['business_discovery']['followers_count'] # display number of followers the user has
+print "\nfollowing:" # label
+print response['json_data']['business_discovery']['follows_count'] # display number of people the user follows
+print "\nprofile picture url:" # label
+print response['json_data']['business_discovery']['profile_picture_url'] # display profile picutre url
+print "\nbiography:" # label
+print response['json_data']['business_discovery']['biography'] # display users about section

instagram_graph_api/python/debug_access_token.py

@@ -12,20 +12,20 @@ def debugAccessToken( params ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['input_token'] = params['access_token']
-	endpointParams['access_token'] = params['access_token']
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['input_token'] = params['access_token'] # input token is the access token
+	endpointParams['access_token'] = params['access_token'] # access token to get debug info on
 
-	url = params['graph_domain'] + '/debug_token'
+	url = params['graph_domain'] + '/debug_token' # endpoint url
 
-	return makeApiCall( url, endpointParams, params['debug'] )
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
 
-params = getCreds()
-params['debug'] = 'yes'
-response = debugAccessToken( params )
+params = getCreds() # get creds
+params['debug'] = 'yes' # set debug
+response = debugAccessToken( params ) # hit the api for some data!
 
-print "\nData Access Expires at: "
-print datetime.datetime.fromtimestamp( response['json_data']['data']['data_access_expires_at'] )
+print "\nData Access Expires at: " # label
+print datetime.datetime.fromtimestamp( response['json_data']['data']['data_access_expires_at'] ) # display out when the token expires
 
-print "\nToken Expires at: "
-print datetime.datetime.fromtimestamp( response['json_data']['data']['expires_at'] )
+print "\nToken Expires at: " # label
+print datetime.datetime.fromtimestamp( response['json_data']['data']['expires_at'] ) # display out when the token expires

instagram_graph_api/python/defines.py

@@ -2,39 +2,60 @@
 import json
 
 def getCreds() :
-	creds = dict()
-	creds['access_token'] = 'ACCESS-TOKEN'
-	creds['client_id'] = 'FB-APP-CLIENT-ID'
-	creds['client_secret'] = 'FB-APP-CLIENT-SECRET'
-	creds['graph_domain'] = 'https://graph.facebook.com/'
-	creds['graph_version'] = 'v6.0'
-	creds['endpoint_base'] = creds['graph_domain'] + creds['graph_version'] + '/'
-	creds['debug'] = 'no'
-	creds['page_id'] = 'FB-PAGE-ID'
-	creds['instagram_account_id'] = 'INSTAGRAM-BUSINESS-ACCOUNT-ID'
-	creds['ig_username'] = 'IG-USERNAME'
+	""" Get creds required for use in the applications
+	
+	Returns:
+		dictonary: credentials needed globally
+
+	"""
+
+	creds = dict() # dictionary to hold everything
+	creds['access_token'] = 'ACCESS-TOKEN' # access token for use with all api calls
+	creds['client_id'] = 'FB-APP-CLIENT-ID' # client id from facebook app IG Graph API Test
+	creds['client_secret'] = 'FB-APP-CLIENT-SECRET' # client secret from facebook app
+	creds['graph_domain'] = 'https://graph.facebook.com/' # base domain for api calls
+	creds['graph_version'] = 'v6.0' # version of the api we are hitting
+	creds['endpoint_base'] = creds['graph_domain'] + creds['graph_version'] + '/' # base endpoint with domain and version
+	creds['debug'] = 'no' # debug mode for api call
+	creds['page_id'] = 'FB-PAGE-ID' # users page id
+	creds['instagram_account_id'] = 'INSTAGRAM-BUSINESS-ACCOUNT-ID' # users instagram account id
+	creds['ig_username'] = 'IG-USERNAME' # ig username
 
 	return creds
 
 def makeApiCall( url, endpointParams, debug = 'no' ) :
-	data = requests.get( url, endpointParams )
+	""" Request data from endpoint with params
+	
+	Args:
+		url: string of the url endpoint to make request from
+		endpointParams: dictionary keyed by the names of the url parameters
+
+
+	Returns:
+		object: data from the endpoint
 
-	response = dict()
-	response['url'] = url
-	response['endpoint_params'] = endpointParams
-	response['endpoint_params_pretty'] = json.dumps( endpointParams, indent = 4 )
-	response['json_data'] = json.loads( data.content )
-	response['json_data_pretty'] = json.dumps( response['json_data'], indent = 4 )
+	"""
 
-	if ( 'yes' == debug ) :
-		displayApiCallData( response )
+	data = requests.get( url, endpointParams ) # make get request
 
-	return response
+	response = dict() # hold response info
+	response['url'] = url # url we are hitting
+	response['endpoint_params'] = endpointParams #parameters for the endpoint
+	response['endpoint_params_pretty'] = json.dumps( endpointParams, indent = 4 ) # pretty print for cli
+	response['json_data'] = json.loads( data.content ) # response data from the api
+	response['json_data_pretty'] = json.dumps( response['json_data'], indent = 4 ) # pretty print for cli
+
+	if ( 'yes' == debug ) : # display out response info
+		displayApiCallData( response ) # display response
+
+	return response # get and return content
 
 def displayApiCallData( response ) :
-	print "\nURL: "
-	print response['url']
-	print "\nEndpoint Params: "
-	print response['endpoint_params_pretty']
-	print "\nResponse: "
-	print response['json_data_pretty']
+	""" Print out to cli response from api call """
+
+	print "\nURL: " # title
+	print response['url'] # display url hit
+	print "\nEndpoint Params: " # title
+	print response['endpoint_params_pretty'] # display params passed to the endpoint
+	print "\nResponse: " # title
+	print response['json_data_pretty'] # make look pretty for cli

instagram_graph_api/python/get_instagram_account.py

@@ -11,20 +11,20 @@ def getInstagramAccount( params ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['access_token'] = params['access_token']
-	endpointParams['fields'] = 'instagram_business_account'
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['access_token'] = params['access_token'] # tell facebook we want to exchange token
+	endpointParams['fields'] = 'instagram_business_account' # access token
 
-	url = params['endpoint_base'] + params['page_id']
+	url = params['endpoint_base'] + params['page_id'] # endpoint url
 
-	return makeApiCall( url, endpointParams, params['debug'] )
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
 
-params = getCreds()
-params['debug'] = 'no'
-response = getInstagramAccount( params )
+params = getCreds() # get creds
+params['debug'] = 'no' # set debug
+response = getInstagramAccount( params ) # get debug info
 
 print "\n---- INSTAGRAM ACCOUNT INFO ----\n"
-print "Page Id:"
-print response['json_data']['id']
-print "\nInstagram Business Account Id:"
-print response['json_data']['instagram_business_account']['id']
+print "Page Id:" # label
+print response['json_data']['id'] # display the page id
+print "\nInstagram Business Account Id:" # label
+print response['json_data']['instagram_business_account']['id'] #display the instagram account id

instagram_graph_api/python/get_long_lived_access_token.py

@@ -11,20 +11,20 @@ def getLongLivedAccessToken( params ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['grant_type'] = 'fb_exchange_token'
-	endpointParams['client_id'] = params['client_id']
-	endpointParams['client_secret'] = params['client_secret']
-	endpointParams['fb_exchange_token'] = params['access_token']
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['grant_type'] = 'fb_exchange_token' # tell facebook we want to exchange token
+	endpointParams['client_id'] = params['client_id'] # client id from facebook app
+	endpointParams['client_secret'] = params['client_secret'] # client secret from facebook app
+	endpointParams['fb_exchange_token'] = params['access_token'] # access token to get exchange for a long lived token
 
-	url = params['endpoint_base'] + 'oauth/access_token'
+	url = params['endpoint_base'] + 'oauth/access_token' # endpoint url
 
-	return makeApiCall( url, endpointParams, params['debug'] )
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
 
-params = getCreds()
-params['debug'] = 'yes'
-response = getLongLivedAccessToken( params )
+params = getCreds() # get creds
+params['debug'] = 'yes' # set debug
+response = getLongLivedAccessToken( params ) # hit the api for some data!
 
-print "\n ---- ACCESS TOKEN INFO ----\n"
-print "Access Token:"
-print response['json_data']['access_token']
+print "\n ---- ACCESS TOKEN INFO ----\n" # section header
+print "Access Token:"  # label
+print response['json_data']['access_token'] # display access token

instagram_graph_api/python/get_user_media.py

@@ -11,46 +11,46 @@ def getUserMedia( params, pagingUrl = '' ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['fields'] = 'id,caption,media_type,media_url,permalink,thumbnail_url,timestamp,username'
-	endpointParams['access_token'] = params['access_token']
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['fields'] = 'id,caption,media_type,media_url,permalink,thumbnail_url,timestamp,username' # fields to get back
+	endpointParams['access_token'] = params['access_token'] # access token
 
-	if ( '' == pagingUrl ) : 
-		url = params['endpoint_base'] + params['instagram_account_id'] + '/media'
-	else :
-		url = pagingUrl
+	if ( '' == pagingUrl ) : # get first page
+		url = params['endpoint_base'] + params['instagram_account_id'] + '/media' # endpoint url
+	else : # get specific page
+		url = pagingUrl  # endpoint url
 
-	return makeApiCall( url, endpointParams, params['debug'] )
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
 
-params = getCreds()
-params['debug'] = 'no'
-response = getUserMedia( params )
+params = getCreds() # get creds
+params['debug'] = 'no' # set debug
+response = getUserMedia( params ) # get users media from the api
 
-print "\n\n\n\t\t\t >>>>>>>>>>>>>>>>>>>> PAGE 1 <<<<<<<<<<<<<<<<<<<<\n"
+print "\n\n\n\t\t\t >>>>>>>>>>>>>>>>>>>> PAGE 1 <<<<<<<<<<<<<<<<<<<<\n" # display page 1 of the posts
 
 for post in response['json_data']['data'] :
-	print "\n\n---------- POST ----------\n"
-	print "Link to post:"
-	print post['permalink']
-	print "\nPost caption:"
-	print post['caption']
-	print "\nMedia type:"
-	print post['media_type']
-	print "\nPosted at:"
-	print post['timestamp']
+	print "\n\n---------- POST ----------\n" # post heading
+	print "Link to post:" # label
+	print post['permalink'] # link to post
+	print "\nPost caption:" # label
+	print post['caption'] # post caption
+	print "\nMedia type:" # label
+	print post['media_type'] # type of media
+	print "\nPosted at:" # label
+	print post['timestamp'] # when it was posted
 
-params['debug'] = 'no'
-response = getUserMedia( params, response['json_data']['paging']['next'] )
+params['debug'] = 'no' # set debug
+response = getUserMedia( params, response['json_data']['paging']['next'] ) # get next page of posts from the api
 
-print "\n\n\n\t\t\t >>>>>>>>>>>>>>>>>>>> PAGE 2 <<<<<<<<<<<<<<<<<<<<\n"
+print "\n\n\n\t\t\t >>>>>>>>>>>>>>>>>>>> PAGE 2 <<<<<<<<<<<<<<<<<<<<\n" # display page 2 of the posts
 
 for post in response['json_data']['data'] :
-	print "\n\n---------- POST ----------\n"
-	print "Link to post:"
-	print post['permalink']
-	print "\nPost caption:"
-	print post['caption']
-	print "\nMedia type:"
-	print post['media_type']
-	print "\nPosted at:"
-	print post['timestamp']
+	print "\n\n---------- POST ----------\n" # post heading
+	print "Link to post:" # label
+	print post['permalink'] # link to post
+	print "\nPost caption:" # label
+	print post['caption'] # post caption
+	print "\nMedia type:" # label
+	print post['media_type'] # type of media
+	print "\nPosted at:" # label
+	print post['timestamp'] # when it was posted

instagram_graph_api/python/get_user_pages.py

@@ -11,21 +11,21 @@ def getUserPages( params ) :
 
 	"""
 
-	endpointParams = dict()
-	endpointParams['access_token'] = params['access_token']
+	endpointParams = dict() # parameter to send to the endpoint
+	endpointParams['access_token'] = params['access_token'] # access token
 
-	url = params['endpoint_base'] + 'me/accounts'
+	url = params['endpoint_base'] + 'me/accounts' # endpoint url
 
-	return makeApiCall( url, endpointParams, params['debug'] )
+	return makeApiCall( url, endpointParams, params['debug'] ) # make the api call
 
-params = getCreds()
-params['debug'] = 'no'
-response = getUserPages( params )
+params = getCreds() # get creds
+params['debug'] = 'no' # set debug
+response = getUserPages( params ) # get debug info
 
-print "\n---- FACEBOOK PAGE INFO ----\n"
-print "Page Name:"
-print response['json_data']['data'][0]['name']
-print "\nPage Category:"
-print response['json_data']['data'][0]['category']
-print "\nPage Id:"
-print response['json_data']['data'][0]['id']
+print "\n---- FACEBOOK PAGE INFO ----\n" # section heading
+print "Page Name:" # label
+print response['json_data']['data'][0]['name'] # display name
+print "\nPage Category:" # label
+print response['json_data']['data'][0]['category'] # display category
+print "\nPage Id:" # label
+print response['json_data']['data'][0]['id'] # display id