mcotton
/
EE-status-v3
1
0
Fork 0
Code Issues 13 Pull Requests Packages Projects Releases Wiki Activity

Update 'README.md'

redesign
mcotton 2023-07-14 16:41:16 +00:00
parent 155a0f7f14
commit 842d067502
1 changed files with 5 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -1,15 +1,13 @@
# EagleEyev3 #
# EE-status-v3 #
## Summary ##
This is a python package for working with the Eagle Eye Networks v3 API. It is all about syntatical sugar and making things a little nicer to work with.
This is a python webapp for getting status history for your cameras.
## 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.
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.
## 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.
I encluded an example Flask server in `app.py`. You can run it locally with `python flask run -p 3333 --debug`
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.
There is also a `Playground.ipynb` that you can run in Jupyter Notebook.
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.