alchemyapi.py

#!/usr/bin/env python
from __future__ import print_function

try:
	from urllib.request import urlopen
	from urllib.parse import urlparse
	from urllib.parse import quote as urlquote
except ImportError:	
	from urlparse import urlparse
	from urllib2 import urlopen
	from urllib2 import quote as urlquote

try:
	import json
except ImportError:
	#Older versions of Python (i.e. 2.4) require simplejson instead of json
	import simplejson as json


if __name__ == '__main__':
	"""
	Writes the API key to api_key.txt file. It will create the file if it doesn't exist.
	This function is intended to be called from the Python command line using: python alchemyapi YOUR_API_KEY
	If you don't have an API key yet, register for one at: http://www.alchemyapi.com/api/register.html
	
	INPUT:
	argv[1] -> Your API key from AlchemyAPI. Should be 40 hex characters
	
	OUTPUT:
	none
	"""
	
	import sys
	if len(sys.argv) == 2 and sys.argv[1]:
		if len(sys.argv[1]) == 40:
			#write the key to the file
			f = open('api_key.txt','w')
			f.write(sys.argv[1])
			f.close()
			print('Key: ' + sys.argv[1] + ' was written to api_key.txt')
			print('You are now ready to start using AlchemyAPI. For an example, run: python example.py')
		else:
			print('The key appears to invalid. Please make sure to use the 40 character key assigned by AlchemyAPI')



class AlchemyAPI:
	#Setup the endpoints
	ENDPOINTS = {}
	ENDPOINTS['sentiment'] = {}
	ENDPOINTS['sentiment']['url'] = '/url/URLGetTextSentiment'
	ENDPOINTS['sentiment']['text'] = '/text/TextGetTextSentiment'
	ENDPOINTS['sentiment']['html'] = '/html/HTMLGetTextSentiment'
	ENDPOINTS['sentiment_targeted'] = {}
	ENDPOINTS['sentiment_targeted']['url'] = '/url/URLGetTargetedSentiment'
	ENDPOINTS['sentiment_targeted']['text'] = '/text/TextGetTargetedSentiment'
	ENDPOINTS['sentiment_targeted']['html'] = '/html/HTMLGetTargetedSentiment'
	ENDPOINTS['author'] = {}
	ENDPOINTS['author']['url'] = '/url/URLGetAuthor'
	ENDPOINTS['author']['html'] = '/html/HTMLGetAuthor'
	ENDPOINTS['keywords'] = {}
	ENDPOINTS['keywords']['url'] = '/url/URLGetRankedKeywords'
	ENDPOINTS['keywords']['text'] = '/text/TextGetRankedKeywords'
	ENDPOINTS['keywords']['html'] = '/html/HTMLGetRankedKeywords'
	ENDPOINTS['concepts'] = {}
	ENDPOINTS['concepts']['url'] = '/url/URLGetRankedConcepts'
	ENDPOINTS['concepts']['text'] = '/text/TextGetRankedConcepts'
	ENDPOINTS['concepts']['html'] = '/html/HTMLGetRankedConcepts'
	ENDPOINTS['entities'] = {}
	ENDPOINTS['entities']['url'] = '/url/URLGetRankedNamedEntities'
	ENDPOINTS['entities']['text'] = '/text/TextGetRankedNamedEntities'
	ENDPOINTS['entities']['html'] = '/html/HTMLGetRankedNamedEntities'
	ENDPOINTS['category'] = {}
	ENDPOINTS['category']['url']  = '/url/URLGetCategory'
	ENDPOINTS['category']['text'] = '/text/TextGetCategory'
	ENDPOINTS['category']['html'] = '/html/HTMLGetCategory'
	ENDPOINTS['relations'] = {}
	ENDPOINTS['relations']['url']  = '/url/URLGetRelations'
	ENDPOINTS['relations']['text'] = '/text/TextGetRelations'
	ENDPOINTS['relations']['html'] = '/html/HTMLGetRelations'
	ENDPOINTS['language'] = {}
	ENDPOINTS['language']['url']  = '/url/URLGetLanguage'
	ENDPOINTS['language']['text'] = '/text/TextGetLanguage'
	ENDPOINTS['language']['html'] = '/html/HTMLGetLanguage'
	ENDPOINTS['text_clean'] = {}
	ENDPOINTS['text_clean']['url']  = '/url/URLGetText'
	ENDPOINTS['text_clean']['html'] = '/html/HTMLGetText'
	ENDPOINTS['text_raw'] = {}
	ENDPOINTS['text_raw']['url']  = '/url/URLGetRawText'
	ENDPOINTS['text_raw']['html'] = '/html/HTMLGetRawText'
	ENDPOINTS['text_title'] = {}
	ENDPOINTS['text_title']['url']  = '/url/URLGetTitle'
	ENDPOINTS['text_title']['html'] = '/html/HTMLGetTitle'
	ENDPOINTS['feeds'] = {}
	ENDPOINTS['feeds']['url']  = '/url/URLGetFeedLinks'
	ENDPOINTS['feeds']['html'] = '/html/HTMLGetFeedLinks'
	ENDPOINTS['microformats'] = {}
	ENDPOINTS['microformats']['url']  = '/url/URLGetMicroformatData'
	ENDPOINTS['microformats']['html'] = '/html/HTMLGetMicroformatData'
	BASE_URL = 'http://access.alchemyapi.com/calls'


	def __init__(self):
		"""	
		Initializes the SDK so it can send requests to AlchemyAPI for analysis.
		It loads the API key from api_key.txt and configures the endpoints.
		"""

		import sys
		try:
			# Open the key file and read the key
			f = open("api_key.txt", "r")
			key = f.read().strip()
			
			if key == '':
				#The key file should't be blank
				print('The api_key.txt file appears to be blank, please run: python alchemyapi.py YOUR_KEY_HERE')
				print('If you do not have an API Key from AlchemyAPI, please register for one at: http://www.alchemyapi.com/api/register.html')
				sys.exit(0)
			elif len(key) != 40:
				#Keys should be exactly 40 characters long
				print('It appears that the key in api_key.txt is invalid. Please make sure the file only includes the API key, and it is the correct one.')
				sys.exit(0)
			else:
				#setup the key
				self.apiKey = key
				
			# Close file
			f.close()
		except IOError:
			#The file doesn't exist, so show the message and create the file.
			print('API Key not found! Please run: python alchemyapi.py YOUR_KEY_HERE')
			print('If you do not have an API Key from AlchemyAPI, please register for one at: http://www.alchemyapi.com/api/register.html')
			
			#create a blank key file
			open('api_key.txt', 'a').close()
			sys.exit(0)
		except Exception as e:
			print(e)



	def sentiment(self, flavor, data, options={}):
		"""
		Calculates the sentiment for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
		For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		showSourceText -> 0: disabled (default), 1: enabled

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""

		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['sentiment']:
			return { 'status':'ERROR', 'statusInfo':'sentiment analysis for ' + flavor + ' not available' }
			
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['sentiment'][flavor], options)



	def sentiment_targeted(self, flavor, data, target, options={}):
		"""
		Calculates the targeted sentiment for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/sentiment-analysis/
		For the docs, please refer to: http://www.alchemyapi.com/api/sentiment-analysis/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		target -> the word or phrase to run sentiment analysis on.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		showSourceText	-> 0: disabled, 1: enabled

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""

		#Make sure the target is valid
		if target is None or target == '':
			return { 'status':'ERROR', 'statusInfo':'targeted sentiment requires a non-null target' }

		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['sentiment_targeted']:
			return { 'status':'ERROR', 'statusInfo':'targeted sentiment analysis for ' + flavor + ' not available' }
			
		#add the URL encoded data and target to the options and analyze 			
		options[flavor] = urlquote(data)
		options['target'] = urlquote(target)
		return self.__analyze(AlchemyAPI.ENDPOINTS['sentiment_targeted'][flavor], options)



	def author(self, flavor, data, options={}):
		"""
		Extracts the author from a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/author-extraction/
		For the docs, please refer to: http://www.alchemyapi.com/api/author-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

		Availble Options:
		none

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['author']:
			return { 'status':'ERROR', 'statusInfo':'author extraction for ' + flavor + ' not available' }

		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['author'][flavor], options)


	def keywords(self, flavor, data, options={}):
		"""
		Extracts the keywords from text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/keyword-extraction/
		For the docs, please refer to: http://www.alchemyapi.com/api/keyword-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
				
		Available Options:
		keywordExtractMode -> normal (default), strict
		sentiment -> analyze sentiment for each keyword. 0: disabled (default), 1: enabled. Requires 1 additional API transaction if enabled.
		showSourceText -> 0: disabled (default), 1: enabled.
		maxRetrieve -> the max number of keywords returned (default: 50)

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['keywords']:
			return { 'status':'ERROR', 'statusInfo':'keyword extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['keywords'][flavor], options)

			
	def concepts(self, flavor, data, options={}):
		"""
		Tags the concepts for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/concept-tagging/
		For the docs, please refer to: http://www.alchemyapi.com/api/concept-tagging/ 
		
		Available Options:
		maxRetrieve -> the maximum number of concepts to retrieve (default: 8)
		linkedData -> include linked data, 0: disabled, 1: enabled (default)
		showSourceText -> 0:disabled (default), 1: enabled

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['concepts']:
			return { 'status':'ERROR', 'statusInfo':'concept tagging for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['concepts'][flavor], options)
			

	def entities(self, flavor, data, options={}):
		"""
		Extracts the entities for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/entity-extraction/ 
		For the docs, please refer to: http://www.alchemyapi.com/api/entity-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
		linkedData -> include linked data on disambiguated entities. 0: disabled, 1: enabled (default) 
		coreference -> resolve coreferences (i.e. the pronouns that correspond to named entities). 0: disabled, 1: enabled (default)
		quotations -> extract quotations by entities. 0: disabled (default), 1: enabled.
		sentiment -> analyze sentiment for each entity. 0: disabled (default), 1: enabled. Requires 1 additional API transction if enabled.
		showSourceText -> 0: disabled (default), 1: enabled 
		maxRetrieve -> the maximum number of entities to retrieve (default: 50)

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['entities']:
			return { 'status':'ERROR', 'statusInfo':'entity extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['entities'][flavor], options)


	def category(self, flavor, data, options={}):
		"""
		Categorizes the text for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/text-categorization/
		For the docs, please refer to: http://www.alchemyapi.com/api/text-categorization/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		showSourceText -> 0: disabled (default), 1: enabled

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['category']:
			return { 'status':'ERROR', 'statusInfo':'text categorization for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		
		return self.__analyze(AlchemyAPI.ENDPOINTS['category'][flavor], options)


	def relations(self, flavor, data, options={}):
		"""
		Extracts the relations for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/relation-extraction/ 
		For the docs, please refer to: http://www.alchemyapi.com/api/relation-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		sentiment -> 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
		keywords -> extract keywords from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
		entities -> extract entities from the subject and object. 0: disabled (default), 1: enabled. Requires one additional API transaction if enabled.
		requireEntities -> only extract relations that have entities. 0: disabled (default), 1: enabled.
		sentimentExcludeEntities -> exclude full entity name in sentiment analysis. 0: disabled, 1: enabled (default)
		disambiguate -> disambiguate entities (i.e. Apple the company vs. apple the fruit). 0: disabled, 1: enabled (default)
		linkedData -> include linked data with disambiguated entities. 0: disabled, 1: enabled (default).
		coreference -> resolve entity coreferences. 0: disabled, 1: enabled (default)  
		showSourceText -> 0: disabled (default), 1: enabled.
		maxRetrieve -> the maximum number of relations to extract (default: 50, max: 100)

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['relations']:
			return { 'status':'ERROR', 'statusInfo':'relation extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['relations'][flavor], options)


	def language(self, flavor, data, options={}):
		"""
		Detects the language for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/api/language-detection/ 
		For the docs, please refer to: http://www.alchemyapi.com/products/features/language-detection/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

		Available Options:
		none

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['language']:
			return { 'status':'ERROR', 'statusInfo':'language detection for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['language'][flavor], options)


	def text_clean(self, flavor, data, options={}):
		"""
		Extracts the cleaned text (removes ads, navigation, etc.) for text, a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/
		For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		useMetadata -> utilize meta description data, 0: disabled, 1: enabled (default)
		extractLinks -> include links, 0: disabled (default), 1: enabled.

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['text_clean']:
			return { 'status':'ERROR', 'statusInfo':'clean text extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['text_clean'][flavor], options)


	def text_raw(self, flavor, data, options={}):
		"""
		Extracts the raw text (includes ads, navigation, etc.) for a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/ 
		For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		none

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['text_raw']:
			return { 'status':'ERROR', 'statusInfo':'raw text extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['text_raw'][flavor], options)



	def text_title(self, flavor, data, options={}):
		"""
		Extracts the title for a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/text-extraction/ 
		For the docs, please refer to: http://www.alchemyapi.com/api/text-extraction/
		
		INPUT:
		flavor -> which version of the call, i.e. text, url or html.
		data -> the data to analyze, either the text, the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		useMetadata -> utilize title info embedded in meta data, 0: disabled, 1: enabled (default) 

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['text_title']:
			return { 'status':'ERROR', 'statusInfo':'title extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['text_title'][flavor], options)



	def microformats(self, flavor, data, options={}):
		"""
		Parses the microformats for a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/microformats-parsing/
		For the docs, please refer to: http://www.alchemyapi.com/api/microformats-parsing/
		
		INPUT:
		flavor -> which version of the call, i.e.  url or html.
		data -> the data to analyze, either the the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.
		
		Available Options:
		none

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['microformats']:
			return { 'status':'ERROR', 'statusInfo':'microformat extraction for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['microformats'][flavor], options)



	def feeds(self, flavor, data, options={}):
		"""
		Detects the RSS/ATOM feeds for a URL or HTML.
		For an overview, please refer to: http://www.alchemyapi.com/products/features/feed-detection/ 
		For the docs, please refer to: http://www.alchemyapi.com/api/feed-detection/
		
		INPUT:
		flavor -> which version of the call, i.e.  url or html.
		data -> the data to analyze, either the the url or html code.
		options -> various parameters that can be used to adjust how the API works, see below for more info on the available options.

		Available Options:
		none

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""
		
		#Make sure this request supports this flavor
		if flavor not in AlchemyAPI.ENDPOINTS['feeds']:
			return { 'status':'ERROR', 'statusInfo':'feed detection for ' + flavor + ' not available' }
		
		#add the URL encoded data to the options and analyze 			
		options[flavor] = urlquote(data)
		return self.__analyze(AlchemyAPI.ENDPOINTS['feeds'][flavor], options)



	def __analyze(self, url, options):
		"""
		HTTP Request wrapper that is called by the endpoint functions. This function is not intended to be called through an external interface. 
		It makes the call, then converts the returned JSON string into a Python object. 
		
		INPUT:
		url -> the full URI encoded url

		OUTPUT:
		The response, already converted from JSON to a Python object. 
		"""

		#Insert the base url
		url = AlchemyAPI.BASE_URL + url;

		#Add the API Key and set the output mode to JSON
		url += '?apikey=' + self.apiKey + '&outputMode=json'

		#Add the options	
		for key in options:
			url += '&' + key + '=' + str(options[key])
		
		try: 
			#build the request with uri encoding
			page = urlopen(url).read().decode("utf-8")
			return json.loads(page)
		except Exception as e:
			print('error for url: ', url)
			print(e)
			return { 'status':'ERROR', 'statusInfo':'network-error' }