reviese all comments

Author: Wasin Waeosri

trkd_chart.py

@@ -50,10 +50,11 @@ def CreateAuthorization(username, password, appid):
 
     return token
 
-## Perform Quote request 
+## Perform Chart request 
 def RetrieveChart(token, appid):
-    
+    ##construct a Chart request message
     ricName = raw_input('Please input Symbol: ')
+
     chartRequestMsg = {'GetChart_Request_2': {'chartRequest': {
     'TimeSeries': {'TimeSeriesRequest_typehint': ['TimeSeriesRequest'],
                    'TimeSeriesRequest': [{'Symbol': ricName,
@@ -270,15 +271,16 @@ def RetrieveChart(token, appid):
     'Culture': 'en-US',
     'ReturnPrivateNetworkURL': False,
     }}}
-
-    interdayURL = 'http://api.rkd.reuters.com/api/Charts/Charts.svc/REST/Charts_1/GetChart_2'
+    ##construct Chart URL and header
+    chartURL = 'http://api.rkd.reuters.com/api/Charts/Charts.svc/REST/Charts_1/GetChart_2'
     headers = {'content-type': 'application/json;charset=utf-8' ,'X-Trkd-Auth-ApplicationID': appid, 'X-Trkd-Auth-Token' : token}
 
     print '############### Sending Chart request message to TRKD ###############'
-    chartResult = doSendRequest(interdayURL, chartRequestMsg,headers)
+    chartResult = doSendRequest(chartURL, chartRequestMsg,headers)
     if chartResult is not None and chartResult.status_code == 200:
         print 'Time Series Interday response message: '
         print chartResult.json()
+        ##print returned server, tag and image url
         server = chartResult.json()['GetChart_Response_2']['ChartImageResult']['Server']
         print '\nServer: %s'%(server)
         tag = chartResult.json()['GetChart_Response_2']['ChartImageResult']['Tag']
@@ -287,12 +289,16 @@ def RetrieveChart(token, appid):
         print 'Url: %s'%(imageUrl)
         return imageUrl
 
+##download image url from the TRKD Chart service as chart.png
 def downloadChartImage(chartURL):
+    ##create header
     user_agent = 'Mozilla/4.0 (compatible; MSIE 5.5; Windows NT)'
     headers = { 'User-Agent' : user_agent }
     print '\nDownlading chart.png file from %s'%(chartURL)
+    ##download image using Python urllib2
     downloadResult = urllib2.Request(chartURL, headers=headers)
     imgData = urllib2.urlopen(downloadResult).read()
+    ##write file
     fileName = './chart.png'
     with open(fileName,'wb') as outfile:
         outfile.write(imgData)
@@ -309,9 +315,10 @@ def downloadChartImage(chartURL):
 
 token = CreateAuthorization(username,password,appid)
 print 'Token = %s'%(token)
-## if authentiacation success, continue subscribing Time Series intraday
+## if authentiacation success, continue subscribing Chart
 if token is not None:
     chartURL = RetrieveChart(token,appid)
+    ## if chart request success, continue downloading Chart image
     if chartURL is not None:
         print '############### Downloading Chart file from TRKD ###############'
         downloadChartImage(chartURL)

trkd_interday.py

@@ -49,9 +49,9 @@ def CreateAuthorization(username, password, appid):
 
     return token
 
-## Perform Quote request 
+## Perform Interday request 
 def RetrieveInteraday(token, appid):
-
+    ##construct Time Series Interday request message
     ricName = raw_input('Please input Symbol: ')
     interdayRequestMsg = None
     fields = ['OPEN','HIGH','LOW','CLOSE','CLOSEYIELD','VOLUME','BID','ASK'] #change your fields (support these 'OPEN','HIGH','LOW','CLOSE','CLOSEYIELD','VOLUME','BID','ASK' fields only)
@@ -71,7 +71,7 @@ def RetrieveInteraday(token, appid):
             'MetaField': ['NAME','QOS','CCY','TZ','TZOFFSET','NAME_LL']
         }
     }
-
+    ##construct Time Series Interday URL and header
     interdayURL = 'http://api.rkd.reuters.com/api/TimeSeries/TimeSeries.svc/REST/TimeSeries_1/GetInterdayTimeSeries_4'
     headers = {'content-type': 'application/json;charset=utf-8' ,'X-Trkd-Auth-ApplicationID': appid, 'X-Trkd-Auth-Token' : token}
 
@@ -91,7 +91,7 @@ def RetrieveInteraday(token, appid):
 
 token = CreateAuthorization(username,password,appid)
 print 'Token = %s'%(token)
-## if authentiacation success, continue subscribing Time Series intraday
+## if authentiacation success, continue subscribing Time Series interday
 if token is not None:
     RetrieveInteraday(token,appid)
 

trkd_intraday.py

@@ -49,9 +49,9 @@ def CreateAuthorization(username, password, appid):
 
     return token
 
-## Perform Quote request 
+## Perform Intraday request 
 def RetrieveIntraday(token, appid):
-
+     ##construct Time Series Intraday request message
     ricName = raw_input('Please input Symbol: ')
     intradayRequestMsg = None
     fields = ['OPEN','HIGH','LOW','CLOSE','CLOSEYIELD','VOLUME','BID','ASK'] #change your fields (support these 'OPEN','HIGH','LOW','CLOSE','CLOSEYIELD','VOLUME','BID','ASK' fields only)
@@ -71,7 +71,7 @@ def RetrieveIntraday(token, appid):
             'MetaField': ['NAME','QOS','CCY','TZ','TZOFFSET','NAME_LL']
         }
     }
-
+    ##construct Time Series Intraday URL and header
     intradayURL = 'http://api.rkd.reuters.com/api/TimeSeries/TimeSeries.svc/REST/TimeSeries_1/GetIntradayTimeSeries_4'
     headers = {'content-type': 'application/json;charset=utf-8' ,'X-Trkd-Auth-ApplicationID': appid, 'X-Trkd-Auth-Token' : token}
 

trkd_newsheadline.py

@@ -89,7 +89,7 @@ def RetrieveNewsHeadline(token, appid):
 token = CreateAuthorization(username,password,appid)
 print 'Token = %s'%(token)
 
-## if authentiacation success, continue subscribing Quote
+## if authentiacation success, continue subscribing News Headline
 if token is not None:
     RetrieveNewsHeadline(token,appid)
 

trkd_newsstory.py

@@ -49,10 +49,10 @@ def CreateAuthorization(username, password, appid):
 
 ## Perform News Story request 
 def RetrieveNewsStory(token, appid):
-    ##construct news headline URL and header
+    ##construct news story URL and header
     newsURL = 'http://api.rkd.reuters.com/api/News/News.svc/REST/News_1/RetrieveStoryML_1'
     headers = {'content-type': 'application/json;charset=utf-8' ,'X-Trkd-Auth-ApplicationID': appid, 'X-Trkd-Auth-Token' : token}
-    ##construct a news headline story message
+    ##construct a news story request message
     storyid = raw_input('Please input news story id: ')
     newsRequestMsg = {'RetrieveStoryML_Request_1': {
         'StoryMLRequest':{
@@ -78,7 +78,7 @@ def RetrieveNewsStory(token, appid):
 token = CreateAuthorization(username,password,appid)
 print 'Token = %s'%(token)
 
-## if authentiacation success, continue subscribing Quote
+## if authentiacation success, continue subscribing News Story
 if token is not None:
     RetrieveNewsStory(token,appid)
 

trkd_onlinereport.py

@@ -47,12 +47,12 @@ def CreateAuthorization(username, password, appid):
 
     return token
 
-## Perform News Headline request 
+## Perform Online Report request 
 def RetrieveOnlineReport(token, appid):
-    ##construct news headline URL and header
+    ##construct Online Report URL and header
     onlinereportURL = 'http://api.rkd.reuters.com/api/OnlineReports/OnlineReports.svc/REST/OnlineReports_1/GetSummaryByTopic_1'
     headers = {'content-type': 'application/json;charset=utf-8' ,'X-Trkd-Auth-ApplicationID': appid, 'X-Trkd-Auth-Token' : token}
-    ##construct a news headline request message
+    ##construct a Online Report request message
     onelinereportRequestMsg = {'GetSummaryByTopic_Request_1': {
         'Topic': 'OLRUTOPNEWS',
         'MaxCount': 20,
@@ -62,7 +62,7 @@ def RetrieveOnlineReport(token, appid):
     print '############### Sending News - Online Report request message to TRKD ###############'
     onlinereportResult = doSendRequest(onlinereportURL, onelinereportRequestMsg,headers)
     if onlinereportResult is not None and onlinereportResult.status_code == 200:
-        print 'News Headline response message: '
+        print 'Online Report response message: '
         print onlinereportResult.json()
 
 
@@ -77,7 +77,7 @@ def RetrieveOnlineReport(token, appid):
 token = CreateAuthorization(username,password,appid)
 print 'Token = %s'%(token)
 
-## if authentiacation success, continue subscribing Quote
+## if authentiacation success, continue subscribing Online Report
 if token is not None:
     RetrieveOnlineReport(token,appid)