From e388006015c9127b731e20e69c8d7c2d5c470f05 Mon Sep 17 00:00:00 2001 From: Mark Cotton Date: Tue, 25 Jul 2023 10:23:10 -0600 Subject: [PATCH] updating README, removing settings.py --- README.md | 27 ++++++++++++++++++++++++--- src/EagleEyev3/settings.py | 14 -------------- 2 files changed, 24 insertions(+), 17 deletions(-) delete mode 100644 src/EagleEyev3/settings.py diff --git a/README.md b/README.md index 421ba8c..4102d70 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# EE-status-v3 # +# EagleEyev3 # ## Summary ## -This is a python webapp for getting status history for your cameras. +This is a python package for working with the Eagle Eye Networks APIv3. It takes some liberties with the API to make it more pythonic. There is plenty of sugar sprinkled in to make it a little easier to use. ## 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. diff --git a/src/EagleEyev3/settings.py b/src/EagleEyev3/settings.py deleted file mode 100644 index 7a35d6d..0000000 --- a/src/EagleEyev3/settings.py +++ /dev/null @@ -1,14 +0,0 @@ - -# 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"