apccapi 0.0.1__py3-none-any.whl

apccapi/__init__.py

@@ -0,0 +1,5 @@
+import apccapi
+Client = apccapi.Client
+__version__ = '0.0.1'
+__author__ = 'APEC Climate Center'
+print(apccapi.__version__)

apccapi/apccapi.py

@@ -0,0 +1,285 @@
+import json
+import time
+import os
+import requests
+import logging
+import urllib3
+
+def read_config(path):
+	config = {}
+	with open(path) as f:
+		for l in f.readlines():
+			if '=' in l:
+				k, v = l.strip().split('=')	
+				if k in ('request_url', 'key', 'status_url'):
+					config[k] = v.strip()
+	return config
+
+def download_MME_3MONTH(request, output_zipfile_name):
+	client = Client()
+	client.retrieve(
+		{
+				'jobtype': 'MME',
+				'dataset': 'MME_3MONTH',
+				'type': request['type'],
+				'method': request['method'],
+				'variable': request['variable'],
+				'period': request['period'],
+				'yearmonth': request['yearmonth']
+			},
+			output_zipfile_name
+	)
+	return output_zipfile_name
+
+def download_MME_6MONTH(request, output_zipfile_name):
+	client = Client()
+	client.retrieve(
+		{
+			'jobtype': 'MME',
+			'dataset': 'MME_6MONTH',
+			'type': request['type'],
+			'method': request['method'],
+			'variable': request['variable'],
+			'period': request['period'],
+			'yearmonth': request['yearmonth']
+		},
+		output_zipfile_name
+	)
+	return output_zipfile_name
+
+def download_MME_MODEL(request, output_zipfile_name):
+	client = Client()
+	client.retrieve(
+		{
+			'jobtype': 'MODEL',
+			'dataset': 'MODEL',
+			'type': request['type'],
+			'institute': request['institute'],
+			'model': request['model'],
+			'variable': request['variable'],
+			'yearmonth': request['yearmonth']
+		},
+		output_zipfile_name
+	)
+	return output_zipfile_name
+
+def download_CMIP5(request, output_zipfile_name):
+	client = Client()
+	client.retrieve(
+		{
+			'jobtype': 'CMIP5',
+			'dataset': 'CMIP5',
+			'code': request['code']
+		},
+		output_zipfile_name
+	)
+	return output_zipfile_name
+
+class Client(object):
+	logger = logging.getLogger('apccapi')
+
+	def __init__(self, 
+				debug=False,
+				sleep_max=120,
+				retry_max=500,
+				timeout=60):
+		
+		self.sleep_max = sleep_max
+		self.retry_max = retry_max
+		self.timeout = timeout
+		self.last_status = None
+		self.target = None
+
+		if debug:
+			level = logging.DEBUG
+		else:
+			level = logging.INFO
+
+		logging.basicConfig(level=level, 
+			format='[%(asctime)s] [%(levelname)s] %(message)s')	
+
+		self.requesturl = None
+		self.key = None
+		self.statusurl = None
+
+		urllib3.disable_warnings()
+		
+		propertyFile = os.path.join(os.path.expanduser('~'), 'apccapi.properties')
+		self.debug(propertyFile)
+
+		if self.requesturl is None or self.key is None or self.statusurl is None:
+			if os.path.exists(propertyFile):
+				config = read_config(propertyFile)
+
+				self.key = config.get('key')
+				self.requesturl = config.get('request_url')
+				self.statusurl = config.get('status_url')
+
+		if self.requesturl is None or self.key is None or self.statusurl is None:
+			raise Exception('Missing/incomplete properties file: %s' % (propertyFile))
+
+	
+	def retrieve(self, details, target):
+		headers = {'Content-Type': 'application/json; charset-utf-8'}
+		request = {}
+		request['key'] = self.key
+		request['details'] = details
+
+		self.target = target
+
+		try:
+			response = self.post_api(self.requesturl, request)
+			print(response)
+			reply = response.json()
+			status_code = reply['status']
+			message = reply['message']
+		except Exception:
+#			self.debug(response.text)
+			raise
+	
+		if status_code > 202:
+			info = reply['data']['info']
+			self.error(message + "-" + info)
+			return None
+
+		sleep = 0
+		jobid = None
+
+		while True:
+
+			self.debug("REPLY %s", reply)
+
+			if sleep == 0:
+				jobid = reply['data']['id']
+				userid = reply['data']['userid']
+				self.info('Hello ' + userid + ".")
+				self.info('Your job id is ' + jobid)
+			
+			if reply['data']['status'] != self.last_status:
+				self.info("Request is %s" % (reply['data']['status'],))
+				self.last_status = reply['data']['status']
+		
+			if reply['data']['status'] == 'Complete':
+				self.debug("Done")
+				result = self.download(reply['data']['download_url'], self.target)
+				if result is False:
+					self.error('Failed to download result file.')
+
+				return
+
+			if reply['data']['status'] == 'Queued' or reply['data']['status'] == 'Running':
+				self.debug("Request ID is %s, sleep %s", jobid, sleep)
+				time.sleep(3)
+				sleep += 3;
+
+				if sleep > self.sleep_max:
+					sleep = self.sleep_max
+
+				status_url = '%s/%s' % (self.statusurl, jobid)
+				self.debug("GET %s", status_url)
+
+				try:
+					response = self.get_api(status_url)
+					reply = response.json()
+				except Exception:
+					self.debug("Failed to get response. Retrying");	
+
+				continue
+
+			if reply['data']['status'] == "Failed":
+				print(reply['data']['message'])
+				return
+
+			raise Exception('Unknown API state [%s]' % reply['data']['status'])
+
+	def download(self, url, target):
+		self.info('Start to save file - ' + target)
+
+		tries = 0
+
+		while tries < self.retry_max:
+			try:
+				response = requests.get(url, verify=False, allow_redirects=True)
+				open(target, 'wb').write(response.content)
+			except requests.exceptions.ConnectionError as e:
+				self.warning("Recovering from connection error [%s], attemps %s of %s",
+					response.status_code, response.reason, tries, self.retry_max)
+
+			if os.path.exists(target):
+				self.info('Done')
+				return True
+
+			tries += 1
+
+			self.warning("Retrying in %s seconds", self.sleep_max)
+			time.sleep(self.sleep_max)
+			self.info("Retrying now...")
+
+		return False
+
+
+	def get_api(self, url):
+		tries = 0
+
+		while tries < self.retry_max:
+			try:
+				response = requests.get(url, verify=False)
+			except requests.exceptions.ConnectionError as e:
+				response = None
+				self.warning("Recovering from connection error [%s], attemps %s of %s",
+							response.status_code, response.reason, tries, self.retry_max)
+
+			if response	is not None:
+				if response.status_code == 202 or response.status_code == 200:
+					return response
+				else:
+					self.error('Failed to get status of the job.')
+					self.error(response['data']['info'])
+
+			tries += 1
+
+			self.warning("Retrying in %s seconds", self.sleep_max)
+			time.sleep(self.sleep_max)
+			self.info("Retrying now...")
+
+		return None
+
+
+	def post_api(self, url, request):
+		headers = {'Content-Type': 'application/json; charset-utf-8'}	
+		tries = 0
+
+		while tries < self.retry_max:
+			try:
+				response = requests.post(url, verify=False, headers=headers, data=json.dumps(request))
+			except requests.exceptions.ConnectionError as e:
+				response = None
+				self.warning("Recovering from connection error [%s], attemps %s of %s",
+							 e, tries, self.retry_max)
+
+			if response	is not None:
+				if response.status_code > 202:
+					self.warning("Recovering from HTTP error [%s %s], attemps %s of %s",
+							response.status_code, response.reason, tries, self.retry_max)
+				else:
+					return response				
+
+			tries += 1
+
+			self.warning("Retrying in %s seconds", self.sleep_max)
+			time.sleep(self.sleep_max)
+			self.info("Retrying now...")
+
+		return None
+
+	def info(self, *args, **kwargs):
+		self.logger.info(*args, **kwargs)
+
+	def warning(self, *args, **kwargs):
+		self.logger.warning(*args, **kwargs)
+
+	def error(self, *args, **kwargs):
+		self.logger.error(*args, **kwargs)
+
+	def debug(self, *args, **kwargs):
+		self.logger.debug(*args, **kwargs)

apccapi-0.0.1.dist-info/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2019 - 2024, APEC Climate Center
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

apccapi-0.0.1.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.1
+Name: apccapi
+Version: 0.0.1
+Summary: APCC Climate Information toolKit API package
+Home-page: https://www.apcc21.org
+Author: APEC Climate Center
+Author-email: joohyung@apcc21.org
+Project-URL: CLIK, https://cliks.apcc21.org
+Keywords: APCC,apcc,Climate,Climate Information,Climate API
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: urllib3
+
+## Installation
+
+Install via pip with:
+
+```bash
+$ pip install apccapi
+```
+
+## Configure (Linux)
+
+Obtain your API key from the CLIK (Climate Information toolKit) at https://cliks.apcc21.org and enter it into the apccapi.properties file, formatting it as follows:
+
+```
+$ vi ~/.apccapi.properties
+
+key={your API key}
+request_url=https://request.apcc21.org/apccdata
+status_url=https://request.apcc21.org/status
+```
+
+## Configure (Windows)
+
+Obtain your API key from the CLIK (Climate Information toolKit) at https://cliks.apcc21.org, and create the apccapi.properties file in your Windows Home directory (typically C:\Users\YourUserName) with the following format:
+
+```
+key={your API key}
+request_url=https://request.apcc21.org/apccdata
+status_url=https://request.apcc21.org/status
+```
+
+## Test
+
+Perform a small test retrieve of MME data:
+```
+$ python
+>>> import apccapi
+>>> c = apccapi.Client()
+>>> c.retrieve(
+	{
+		'jobtype': 'MME',
+		'dataset': 'MME_3MONTH',
+		'type': 'FORECAST',
+		'method': 'SCM',
+		'variable': ['prec', 't2m'],
+		'period': ['Monthly mean'],
+		'yearmonth': ['201909']
+	},
+	'mme3.zip'
+)
+>>>
+
+```
+
+## License
+
+MIT License
+
+Copyright (c) 2019 - 2024, APEC Climate Center
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

apccapi-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+apccapi/__init__.py,sha256=-w95Jv18HG14Pz0EI7PNybeqv3qN2LguI2ahq-na8GU,122
+apccapi/apccapi.py,sha256=OxCjGbz0kXYxHtryo8clWHoRok6_Uzm8fmW6IuhOpdo,7072
+apccapi-0.0.1.dist-info/LICENSE,sha256=bJx5OeJ0W0ARQFMPTTojbOWSGaq6QqW1kquNZs-NY28,1091
+apccapi-0.0.1.dist-info/METADATA,sha256=-ZFflXZMOuwhHT3hSbkHFvrDplzDF9Lel6wObbqhLmc,2877
+apccapi-0.0.1.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+apccapi-0.0.1.dist-info/top_level.txt,sha256=TbdOgbug3IVPe2wuPgmutaHU62n1TC4xmnqdC1rkLH0,8
+apccapi-0.0.1.dist-info/RECORD,,

apccapi-0.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.3)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

apccapi-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+apccapi