Improved credentials handling to ease library upgrade

Author: philippelt

.gitignore

@@ -5,4 +5,6 @@ dist/
 
 lnetatmo.egg-info/
 
-*.pyc
+*.pyc
+
+__pycache__/

.netatmo.credentials

@@ -0,0 +1,7 @@
+{
+    "CLIENT_ID" : "",
+    "CLIENT_SECRET" : "",
+    "USERNAME" : "",
+    "PASSWORD" : ""
+}
+

LICENSE.txt

@@ -17,7 +17,3 @@ Depending on your permissions you might be required to use sudo.
 Once installed you can simple add latmo to your python scripts by including:
 
     import lnetatmo
-
-### Note ###
-
-this release is an interim release waiting for Netatmo dashboard finalization. As any work in progress, it can stop to work at any time if serious changes occurs.

README.md

@@ -1,7 +1,9 @@
 # Published Jan 2013
 # Revised Jan 2014 (to add new modules data)
-# Author : Philippe Larduinat, philippelt@users.sourceforge.net
-# Public domain source code
+# Revised 2016 (to add camera support)
+# Author : Philippe Larduinat, ph.larduinat@wanadoo.fr
+# Multiple contributors : see https://github.com/philippelt/netatmo-api-python
+# License : GPL V3
 """
 This API provides access to the Netatmo weather station or/and the Welcome camera
 This package can be used with Python2 or Python3 applications and do not
@@ -11,6 +13,8 @@
 coding=utf-8
 """
 from sys import version_info
+from os import getenv
+from os.path import expanduser, exists
 import json, time
 import imghdr
 import warnings
@@ -22,29 +26,59 @@
     from urllib import urlencode
     import urllib2
 
-######################## USER SPECIFIC INFORMATION ######################
+######################## AUTHENTICATION INFORMATION ######################
 
 # To be able to have a program accessing your netatmo data, you have to register your program as
 # a Netatmo app in your Netatmo account. All you have to do is to give it a name (whatever) and you will be
 # returned a client_id and secret that your app has to supply to access netatmo servers.
 
-_CLIENT_ID     = ""   # Your client ID from Netatmo app registration at http://dev.netatmo.com/dev/listapps
-_CLIENT_SECRET = ""   # Your client app secret   '     '
-_USERNAME      = ""   # Your netatmo account username
-_PASSWORD      = ""   # Your netatmo account password
+# To ease Docker packaging of your application, you can setup your authentication parameters through env variables
+
+# Authentication use :
+#  1 - Values hard coded in the library
+#  2 - The .netatmo.credentials file in JSON format in your home directory
+#  3 - Values defined in environment variables : CLIENT_ID, CLIENT_SECRET, USERNAME, PASSWORD
+
+# Each level override values defined in the previous level. You could define CLIENT_ID and CLIENT_SECRET hard coded in the library
+# and username/password in .netatmo.credentials or environment variables
+
+cred = {                       # You can hard code authentication information in the following lines
+        "CLIENT_ID" :  "",     #   Your client ID from Netatmo app registration at http://dev.netatmo.com/dev/listapps
+        "CLIENT_SECRET" : "",  #   Your client app secret   '     '
+        "USERNAME" : "",       #   Your netatmo account username
+        "PASSWORD" : ""        #   Your netatmo account password
+        }
+
+# Other authentication setup management (optionals)
+
+CREDENTIALS = expanduser("~/.netatmo.credentials")
+
+def getParameter(key, default):
+    return getenv(key, default[key])
+
+# 2 : Override hard coded values with credentials file if any
+if exists(CREDENTIALS) :
+    with open(CREDENTIALS, "r") as f: cred = json.loads(f.read())
+
+# 3 : Override final value with content of env variables if defined
+_CLIENT_ID     = getParameter("CLIENT_ID", cred)
+_CLIENT_SECRET = getParameter("CLIENT_SECRET", cred)
+_USERNAME      = getParameter("USERNAME", cred)
+_PASSWORD      = getParameter("PASSWORD", cred)
 
 #########################################################################
 
 
 # Common definitions
 
-_BASE_URL       = "https://api.netatmo.com/"
-_AUTH_REQ       = _BASE_URL + "oauth2/token"
-_GETMEASURE_REQ = _BASE_URL + "api/getmeasure"
-_GETSTATIONDATA_REQ = _BASE_URL + "api/getstationsdata"
-_GETHOMEDATA_REQ = _BASE_URL + "api/gethomedata"
+_BASE_URL = "https://api.netatmo.com/"
+_AUTH_REQ             = _BASE_URL + "oauth2/token"
+_GETMEASURE_REQ       = _BASE_URL + "api/getmeasure"
+_GETSTATIONDATA_REQ   = _BASE_URL + "api/getstationsdata"
+_GETHOMEDATA_REQ      = _BASE_URL + "api/gethomedata"
 _GETCAMERAPICTURE_REQ = _BASE_URL + "api/getcamerapicture"
-_GETEVENTSUNTIL_REQ = _BASE_URL + "api/geteventsuntil"
+_GETEVENTSUNTIL_REQ   = _BASE_URL + "api/geteventsuntil"
+
 
 
 class NoDevice( Exception ):
@@ -72,6 +106,7 @@ def __init__(self, clientId=_CLIENT_ID,
                        username=_USERNAME,
                        password=_PASSWORD,
                        scope="read_station"):
+        
         postParams = {
                 "grant_type" : "password",
                 "client_id" : clientId,
@@ -166,7 +201,7 @@ def moduleByName(self, module, station=None):
         for m in self.modules:
             mod = self.modules[m]
             if mod['module_name'] == module :
-                if not s or mod['main_device'] == s['_id'] : return mod
+                return mod
         return None
 
     def moduleById(self, mid, sid=None):
@@ -548,6 +583,7 @@ def getStationMinMaxTH(station=None, module=None):
         result.extend(devList.MinMaxTH(station, mname))
     return result
 
+
 # auto-test when executed directly
 
 if __name__ == "__main__":

lnetatmo.py

@@ -0,0 +1,3 @@
+[metadata]
+description-file = README.md
+

setup.cfg

@@ -9,6 +9,7 @@ Python Netatmo API programmers guide
 
 >2016-06-25 Update documentation for Netatmo Welcome
 
+>2017-01-09 Minor updates to packaging info
 
 No additional library other than standard Python library is required.
 
@@ -34,26 +35,41 @@ In the netatmo philosophy, both the application itself and the user have to be r
 
 
 
-### 2 Setup your library ###
+### 2 Setup your authentication information ###
 
 
 
 Copy the lnetatmo.py file in your work directory (or your platform choice of user libraries or virtualenv or ...).
 
-To ease future uses, I suggest that you hardcode in the library your application and user credentials. This is not mandatory as this parameters can be explicitly passed at authentication phase but will save you parameters each time you write a new tool.
-
-If you want to do it, just edit the source file and hard code required values for :
-
+Authentication data can be supplied with 4 different methods : 
 
+ 1. Some or all values can be hard coded in the library source (and default to empty strings). If you use this method, you are back to the initial suggested method. It would be nice to switch to other methods to isolate credentials and ease library upgrades.
+ 2. Some or all values can be overriden in a ~/.netatmo.credentials file containing the keys in JSON format
+```bash
+$ cat .netatmo.credentials   # Here all values are defined but it is not mandatory
+{
+    "CLIENT_ID" : "`xxx",
+    "CLIENT_SECRET" : "xxx",
+    "USERNAME" : "xxx",
+    "PASSWORD" : "xxx"
+}
+$
+```
+ 3. Some or all values can be overriden by environment variables. This is the easiest method if your are packaging your application with Docker.
+```bash
+$ export USERNAME=newUsername
+$ export PASSWORD=password
+$ python3 MyCodeUsingLnetatmo.py
+...
+```
+ 4. Some or all values can be overriden by explicit call to initializer of ClientAuth class
 ```python
-_CLIENT_ID     = "<your client_id>"
-_CLIENT_SECRET = "<your client_secret>"
-_USERNAME      = "<netatmo username>"
-_PASSWORD      = "<netatmo user password>"
+# Example: CLIENT_ID and CLIENT_SECRET supposed to be defined by one of the previous methods
+authData = lnetatmo.ClientAuth( username="newUsername",
+                                password="password" )
 ```
 
-
-If you provide all the values, you can test that everything is working properly by simply running the package as a standalone program.
+If you provide all the values, using any method or mix except 4, you can test that everything is working properly by simply running the package as a standalone program.
 
 This will run a full access test to the account and stations and return 0 as return code if everything works well. If run interactively, it will also display an OK message.
 
@@ -65,7 +81,6 @@ $ echo $?
 ```
 
 
-
 ### 3 Package guide ###