From c180ec9c38ba6602489b1ecf3bce8a80694f96f3 Mon Sep 17 00:00:00 2001 From: Mark Cotton Date: Thu, 18 May 2023 11:19:14 -0500 Subject: [PATCH] updated readme --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index cd91372..32aedb8 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,9 @@ This is a python package for working with the Eagle Eye Networks v3 API. It is ## Settings File ## There is file `settings.py` that is needed to run. Please reach out to api_support@een.com to get the necessary credentials. + +## Ideas on how to use ## + +I encluded an example Flask server in `server.py`. This shows how to wire it up to a login route and handle the callback. + +You can also use this in a script by running in iPython in interactive mode `ipython -i server.py`. After you complete to login process, you can hit `CTRL-C` to stop the Flask server. You can then look at the `een` object to get all the instance variables. \ No newline at end of file