version 0.0.2 (#15)

* set version to 0.0.1

* Support for ArloQ (#2)

* Support for ArloQ

* Moved all detection to same conditional

* Fixed lint issues

* Added tests for arm/disarm

* Added extra methods

* Implement method to refresh attrs

* Combined API_URL and force super()__init__() for ArloCamera

* Filter on Provisioned Devices (#3)

Filter on Provisioned Devices

* - Fixed lint error
      E502 the backslash is redundant between brackets

- Fixed super() constructor lint error
      E: 12,13: Bad first argument 'ArloGeneric' given to super() (bad-super-call)
      https://docs.quantifiedcode.com/python-anti-patterns/correctness/bad_first_argument_given_to_super.html

- Fixed build
 Travis: https://travis-ci.org/tchellomello/python-arlo/jobs/224846095

* WIP (#4)

Code refactoring

* Updated README.rst and added ArloBaseStation object.

* Updated pip git install

* Moved mode from Camera to Base Station

* Added method to show number of unseen videos

* Added Arlo Q camera (#9)

Fixes issue #7

* Implemented ability to reset unseen videos by camera or globally. (#10)

* Enhancements (#14)

* Refactoring

* Created function to return number of videos recorded today

*  - Simplified documentation
 - Created pretty_timestamp
 - Created method to refresh Arlo object

* Keeping simple name on README

* Added contributing.rst instructions

* Bump version 0.0.2

Author: tchellomello

CONTRIBUTING.rst

@@ -0,0 +1,81 @@
+============
+Contributing
+============
+
+Contributions are welcome and very appreciated!!
+Keep in mind that every little contribution helps, don't matter what.
+
+Types of Contributions
+----------------------
+
+Report Bugs
+~~~~~~~~~~~
+
+Report bugs at https://github.com/tchellomello/python-arlo/issues
+
+If you are reporting a bug, please include:
+
+* Arlo product and firmware version
+* Steps to reproduce the issue
+* Anything you judge interesting for the troubleshooting
+
+Fix Bugs
+~~~~~~~~
+
+Look through the GitHub issues for bugs. Anything tagged with "bug"
+and "help wanted" is open to whoever wants to implement it.
+
+Implement Features
+~~~~~~~~~~~~~~~~~~
+
+Look through the GitHub issues for features. Anything tagged with "enhancement"
+and "help wanted" is open to whoever wants to implement it.
+
+Documentation
+~~~~~~~~~~~~~
+
+Documentation is always good. So please feel free to add any documentation
+you think will help our users.
+
+Request Features
+~~~~~~~~~~~~~~~~
+
+File an issue at https://github.com/tchellomello/python-arlo/issues.
+
+Get Started!
+------------
+
+Ready to contribute? Here's how to set up `python-arlo` for local development.
+
+1. Fork the `python-arlo` repo on GitHub.
+2. Clone your fork locally::
+
+    $ git clone [email protected]:your_name_here/python-arlo.git
+
+3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+
+    $ mkvirtualenv python-arlo
+    $ cd python-arlo/
+    $ python setup.py develop
+    $ pip install -r requirements_tests.txt
+
+4. Create a branch for local development::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+   Now you can make your changes locally.
+
+5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+
+    $ tox -r
+
+6. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Your detailed description of your changes."
+    $ git push origin name-of-your-bugfix-or-feature
+
+7. Submit a pull request through the GitHub website.
+
+
+Thank you!!

README.rst

@@ -24,28 +24,81 @@ Installation
     $ pip install pyarlo
 
     # Install latest development
-    $ pip install \
-        git+https://github.com/tchellomello/python-arlo@dev
+    $ pip install git+https://github.com/tchellomello/python-arlo@dev
 
 Usage
 -----
 
 .. code-block:: python
 
-    # list devices
+    # connecting
     from pyarlo import PyArlo
     arlo  = PyArlo('foo@bar', 'secret')
 
+    # listing devices
     arlo.devices
-    {'cameras': [<ArloCamera: Garage>,  <ArloCamera: Patio>,
-      <ArloCamera: Front Door>, <ArloCamera: Patio Gate>]}
 
-    # list all cameras
+    # listing base stations
+    arlo.base_stations
+
+    # listing Arlo modes
+    base.available_modes
+    ['armed', 'disarmed', 'schedule', 'custom']
+
+    # setting a mode
+    garage_cam.mode = 'armed'
+
+    # listing all cameras
     arlo.cameras
-    [<ArloCamera: Garage>, <ArloCamera: Patio>,
-     <ArloCamera: Front Door>, <ArloCamera: Patio Gate>]
 
-    # download latest snapshot image
-    for camera in arlo.cameras:
-        snapshot = '{0}.jpg'.format(camera.name)
-        camera.download_snapshot(snapshot)
+    # showing camera preferences
+    cam = arlo.cameras[0]
+
+    # printing camera attributes
+    cam.serial_number
+    cam.model_id
+    cam.unseen_videos
+
+    # refreshing camera properties
+    cam.update()
+
+    # gathering live_streaming URL
+    cam.live_streaming()
+    rtmps://vzwow72-z2-prod.vz.netgear.com:80/vzmodulelive?egressToken=b723a7bb_abbXX&userAgent=web&cameraId=48AAAAA
+
+    # gather last recorded video URL
+    cam.last_video.video_url
+
+Loading Videos
+--------------
+
+.. code-block:: python
+
+    # by default, all videos recorded within
+    # the last 30 days will be pre-loaded
+    arlo.ArloMediaLibrary.videos
+
+    # Or you can load Arlo videos directly
+    from pyarlo.media import ArloMediaLibrary
+    library = ArloMediaLibrary(arlo, days=2)
+    len(library.videos)
+
+    # showing a video properties
+    media = library.videos[0]
+
+    # printing video attributes
+    media.camera
+    media.content_type
+    media.media_duration_seconds
+
+    # displaying thumbnail to stdout
+    media.download_thumbnail()
+
+    # downloading video
+    media.download_video('/home/user/demo.mp4')
+
+
+Contributing
+------------
+
+See more at CONTRIBUTING.rst