improving error catching + example in README

Author: alexandrecuer

README.md

@@ -1,2 +1,36 @@
 # pyemoncms
 python library for emoncms API
+
+rely on [aiohttp](https://github.com/aio-libs/aiohttp)
+
+to install : `pip3 install pyemoncms`
+
+how to use :
+
+```
+import logging
+import asyncio
+from pyemoncms import EmoncmsClient
+
+key = "your32bitsAPIkey"
+url = "http://url:8081"
+client = EmoncmsClient(url, key, request_timeout=1)
+client.logger.setLevel("DEBUG")
+
+async def get_path(path):
+    print(await client.async_request(path))
+
+async def list_feeds():
+    print(await client.async_list_feeds())
+    
+async def get_feed_fields(feed_id):
+    print(await client.async_get_feed_fields(feed_id))
+
+
+loop = asyncio.get_event_loop()
+loop.create_task(get_path("/feed/list.json"))
+loop.create_task(get_path("/user/getuuid.json"))
+loop.create_task(list_feeds())
+loop.create_task(get_feed_fields(1))
+loop.run_forever()
+```

pyemoncms/emoncms_client.py

@@ -1,16 +1,23 @@
-"""Emoncms client."""
+"""Emoncms client.
+
+emoncms feed module :
+an inexisting json route responds by {success: false, message : "Feed does not exist"}
+examples of inexisting json routes :
+- feed/aget.json?id=200 if there is no feed number 200
+- feed/basket.json 
+the feed/list.json always returns an array of json objects, which can be empty if there is no feed
+
+emoncms user module
+an inexisting json route responds by false which is not a json object
+so there is a type error if you search for a key in the response
+"""
 
 import asyncio
 import logging
 from typing import Any
 
 import aiohttp
 
-client_exceptions = (
-    aiohttp.ClientError,
-    asyncio.TimeoutError,
-)
-
 HTTP_STATUS = {
     400: "invalid request",
     401: "unauthorized access",
@@ -50,17 +57,27 @@ async def async_request(
                 response = await session.get(
                     path, timeout=self.request_timeout, params=params
                 )
-            except client_exceptions as e:
-                message = f"exception {e}"
+            except aiohttp.ClientError as er:
+                message = f"client error : {er}"
+                data[MESSAGE_KEY] = message
+                self.logger.error(message)
+                return data
+            except asyncio.TimeoutError:
+                message = "time out error"
                 data[MESSAGE_KEY] = message
                 self.logger.error(message)
                 return data
             if response.status == 200:
                 data[SUCCESS_KEY] = True
                 json_response = await response.json()
                 data[MESSAGE_KEY] = json_response
-                if MESSAGE_KEY in json_response:
-                    data[MESSAGE_KEY] = json_response[MESSAGE_KEY]
+                try:
+                    if MESSAGE_KEY in json_response:
+                        data[MESSAGE_KEY] = json_response[MESSAGE_KEY]
+                except TypeError as er:
+                    message = f"type error : {er}"
+                    self.logger.error(message)
+                    data[SUCCESS_KEY] = False
             else:
                 message = f"error {response.status}"
                 if response.status in HTTP_STATUS:

setup.py

@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name="pyemoncms",
-    version="0.0.3",
+    version="0.0.4",
     author="Alexandre CUER",
     author_email="alexandre.cuer@wanadoo.fr",
     description="A python library to interrogate emoncms API",