From 8eb3a45e2e0f52e53227dddf5aec6d129daa490f Mon Sep 17 00:00:00 2001 From: Mark Cotton Date: Fri, 21 Jul 2023 16:14:21 -0600 Subject: [PATCH] updated README --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index adc7aa6..e43951d 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,33 @@ This is a python webapp for getting status history for your cameras. ## Settings File ## -There is file `settings.py` that is needed to run. You can create your application and setup credentials at: [https://developerv3.eagleeyenetworks.com/page/my-application-html](my applications). You can also reach out to api_support@een.com for help. +There is file `settings.py` that is needed to run. It should look similar to this: + +``` +config = { + + # Set up your application and get client id/secrete first + # https://developerv3.eagleeyenetworks.com/page/my-application + "client_id": "", + "client_secret": "", + + # you will need to add approved redirect_uris in your application + # this examples assumes you've added http://127.0.0.1:3333/login_callback + # change the following variables if you did something different + # Note: do not use localhost for server_host, use 127.0.0.1 instead + "server_protocol": "http", + "server_host": "127.0.0.1", + "server_port": "3333", + "server_path": "login_callback", +} +``` + +You can create your application and setup credentials at: [https://developerv3.eagleeyenetworks.com/page/my-application-html](my applications). You can also reach out to api_support@een.com for help. + + ## Ideas on how to use ## I encluded an example Flask server in `app.py`. You can run it locally with `python flask run -p 3333 --debug` -It uses server sessions to track your instance of the EagleEyev3 class but doesn't have any other storage. It uses the API as the source of truth. \ No newline at end of file +It uses server sessions to track your instance of the EagleEyev3 class but doesn't have any other storage. It uses the API as the source of truth.