From bd8e7ae037b6586af38957a8cc8e48d0b581ae75 Mon Sep 17 00:00:00 2001 From: Artanicus Date: Tue, 4 Apr 2017 18:41:26 +0300 Subject: [PATCH] Update README.md for recent config location changes --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 065c554..94e5a05 100644 --- a/README.md +++ b/README.md @@ -24,20 +24,21 @@ print(multisensor.getMultisensorData(devices)) from cozify import cloud cloud.authenticate() # authenticate() is interactive and usually triggered automatically -# authentication data is stored in ~/.config/python-cozify.cfg +# authentication data is stored in ~/.config/python-cozify/python-cozify.cfg ``` ### authenticate with a non-default state storage ```python from cozify import cloud, config config.setStatePath('/tmp/testing-state.cfg') cloud.authenticate() -# authentication and other useful data is now stored in the defined location instead of ~/.config/python-cozify.cfg +# authentication and other useful data is now stored in the defined location instead of ~/.config/python-cozify/python-cozify.cfg +# you could also use the environment variable XDG_CONFIG_HOME to override where config files are stored ``` ## Current limitations -* Right now tokens are assumed to never expire and their functionality is not questioned. +* Token functionality is sanity-checked up to a point and renewal is attempted. This however is new code and may not be perfect. * For now there are only read calls. New API call requests are welcome as issues or pull requests! -* authentication flow is as automatic as possible but still a bit fragile. Any reported issues are very welcome. +* authentication flow is as automatic as possible but if the Cozify Cloud token expires we can't help but request it and ask it to be entered. If you are running a daemon that requires authentication and your cloud token expires, run just the authenticate() flow in an interactive terminal and then restart your daemon. ## Sample projects * [github.com/Artanicus/cozify-temp](https://github.com/Artanicus/cozify-temp) - Store Multisensor data into InfluxDB