diff --git a/README.md b/README.md index ba76af3..d4f42cb 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,37 @@ ![](logo.png) # arlo ![](https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5%2C%203.6-blue.svg) > Python module for interacting with Netgear's Arlo camera system. +> +>### Now in Golang! +>If you love the Go programming language, check out [arlo-golang](https://github.com/jeffreydwalter/arlo-golang). +>My goal is to bring parity to the Python version asap. If you know what you're doing in Go, I would appreciate any feedback on the >general structure of the library, and contributions, etc. --- -### Now in Golang! -If you love the Go programming language, check out [arlo-golang](https://github.com/jeffreydwalter/arlo-golang). -My goal is to bring parity to the Python version asap. If you know what you're doing in Go, I would appreciate any feedback on the general structure of the library, and contributions, etc. +### GETTING STARTED +Check out the [API DOCS](https://github.com/jeffreydwalter/arlo/tree/master/docs) + +**IMPORTANT:** Please ensure you don't have ANY other `sseclient` packages installed in addition to `sseclient 0.0.22`! This may cause this package to fail in unexpected ways. A common one that is known to cause issues is the `sseclient-py 1.7` package. If you have a hard requirement to have more than one, please let me know and we can look into making that work. + +**IMPORTANT:** my.arlo.com requires TLS 1.2 for their API. So, if you're getting ssl errors, it's most likely related to your version of openssl. You may need to upgrade your openssl library. +If you're running this library on OSX or macOS, they ship with `openssl v0.9.x` which does not support TLS 1.2. You should follow the instructions found [here](https://comeroutewithme.com/2016/03/13/python-osx-openssl-issue/) to upgrade your openssl library. + +**IMPORTANT:** There is a regression in sseclient 0.0.24 that breaks this package. Please ensure you have seeclient 0.0.22 installed. + +--- +### Filing an Issue +Please read the [Issue Guidelines and Policies](https://github.com/jeffreydwalter/arlo/wiki/Issue-Guidelines-and-Policies) wiki page **BEFORE** you file an issue. Thanks. + +--- +## Install +```bash +# Install latest stable package +$ pip install arlo + +--or-- + +# Install from master branch +$ pip install git+https://github.com/jeffreydwalter/arlo +``` --- This just a personal utility that I created out of necessity. It is by no means complete, although it does expose quite a bit of the Arlo interface in an easy to use Python pacakge. As such, this package does not come with unit tests (feel free to add them) or guarantees. @@ -43,30 +69,6 @@ This just a personal utility that I created out of necessity. It is by no means If You'd like to make a diffrence in the world and get your name on this most prestegious list, have a look at our [help wanted](https://github.com/jeffreydwalter/arlo/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) section! ---- -### Filing an Issue -Please read the [Issue Guidelines and Policies](https://github.com/jeffreydwalter/arlo/wiki/Issue-Guidelines-and-Policies) wiki page **BEFORE** you file an issue. Thanks. - ---- - -## Install -```bash -# Install latest stable package -$ pip install arlo - ---or-- - -# Install from master branch -$ pip install git+https://github.com/jeffreydwalter/arlo -``` - -**IMPORTANT:** my.arlo.com requires TLS 1.2 for their API. So, if you're getting ssl errors, it's most likely related to your version of openssl. You may need to upgrade your openssl library. -If you're running this library on OSX or macOS, they ship with `openssl v0.9.x` which does not support TLS 1.2. You should follow the instructions found [here](https://comeroutewithme.com/2016/03/13/python-osx-openssl-issue/) to upgrade your openssl library. - -**IMPORTANT:** Please ensure you don't have ANY other `sseclient` packages installed in addition to `sseclient 0.0.22`! This may cause this package to fail in unexpected ways. A common one that is known to cause issues is the `sseclient-py 1.7` package. If you have a hard requirement to have more than one, please let me know and we can look into making that work. - -**IMPORTANT:** There is a regression in sseclient 0.0.24 that breaks this package. Please ensure you have seeclient 0.0.22 installed. - After installing all of the required libraries, you can import and use this library like so: ```python