Merge pull request #57 from fronzbot/dev

v0.7.0

Author: fronzbot

.hound.yml

@@ -1,4 +1,6 @@
 python:
   enabled: true
+  ignored_directories:
+  - docs
 
 fail_on_violations: true

.travis.yml

@@ -3,15 +3,15 @@ matrix:
   include:
     - python: "3.4.2"
       env: TOXENV=py34
-    - python: "3.4.2"
+    - python: "3.6"
       env: TOXENV=lint
     - python: "3.5"
       env: TOXENV=py35
     - python: "3.6"
       env: TOXENV=py36
     - python: "3.6-dev"
       env: TOXENV=py36
-    - python: "3.4.2"
+    - python: "3.6"
       env: TOXENV=build
 
 install: pip install -U tox coveralls

CHANGES.rst

@@ -7,6 +7,15 @@ A list of changes between each release
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 - Fixed style errors for bumped pydocstring and pylint versions
 - Changed Blink.cameras dictionary to be case-insensitive (fixes `#35 <https://github.com/fronzbot/blinkpy/issues/35>`_)
+- Changed api endpoint for video extraction (fixes `#35 <https://github.com/fronzbot/blinkpy/issues/35>`_ and `#41 <https://github.com/fronzbot/blinkpy/issues/41>`_)
+- Removed last_motion() function from Blink class
+- Refactored code for better organization
+- Moved some request calls out of @property methods (enables future CLI support)
+- Renamed get_summary() method to summary and changed to @property
+- Added ability to download most recent video clip
+- Improved camera arm/disarm handling (`@b10m <https://github.com/fronzbot/blinkpy/pull/50>`_)
+- Added authentication to ``login()`` function and deprecated ``setup_system()`` in favor of ``start()``
+- Added ``attributes`` dictionary to camera object
 
 0.6.0 (2017-05-12)
 ^^^^^^^^^^^^^^^^^^

README.rst

@@ -1,12 +1,8 @@
-blinkpy |Build Status| |Coverage Status| |PyPi Version|
-===========================================================
+blinkpy |Build Status| |Coverage Status| |Docs|  |PyPi Version|
+================================================================
 A Python library for the Blink Camera system
 Only compatible with Python 3+
 
-UPDATE (Dec. 29, 2017)
-======================
-Work on this API has been halted indefinitely since Blink has seemed to cut off API access.  Looks like it's time to cut losses and go with a different camera system that's more friendly to the DIY community.
-
 Disclaimer:
 ~~~~~~~~~~~~~~~
 Published under the MIT license - See LICENSE file for more details.
@@ -42,105 +38,35 @@ This library was built with the intention of allowing easy communication with Bl
 
 Usage
 =========
-In terms of usage, you just need to instantiate the module with a username and password
+The simplest way to use this package from a terminal is to call ``Blink.start()`` which will prompt for your Blink username and password and then log you in.  Alternatively, you can instantiate the Blink class with a username and password, and call ``Blink.start()`` to login and setup without prompt, as shown below.
 
 .. code:: python
 
     import blinkpy
     blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD')
+    blink.start()
 
+If you would like to log in without setting up the cameras or system, you can simply call the ``Blink.login()`` function which will prompt for a username and password and then authenticate with the server.  This is useful if you want to avoid use of the ``start()`` function which simply acts as a wrapper for more targeted API methods.
 
-If you leave out either of those parameters, you need to call the login function which will prompt for your username and password
-
-.. code:: python
-
-    import blinkpy
-    blink = blinkpy.Blink()
-    blink.login()
-
-
-Once the login information is entered, you can run the `setup_system()` function which will attempt to authenticate with Blink servers using your username and password, obtain network ids, and create a list of cameras.
 The cameras are of a BlinkCamera class, of which the following parameters can be used (the code below creates a Blink object and iterates through each camera found)
 
 .. code:: python
 
     import blinkpy
     
     blink = blinkpy.Blink(username='YOUR USER NAME', password='YOUR PASSWORD')
-    blink.setup_system()
+    blink.start()
     
     for name, camera in blink.cameras.items():
         print(name)                  # Name of the camera
-        print(camera.id)             # Integer id of the camera (assigned by Blink)
-        print(camera.armed)          # Whether the device is armed/disarmed (ie. detecting motion)
-        print(camera.clip)           # Link to last motion clip captured
-        print(camera.thumbnail)      # Link to current camera thumbnail
-        print(camera.temperature)    # Current camera temperature (not super accurate, but might be useful for someone)
-        print(camera.battery)        # Current battery level... I think the value ranges from 0-3, but not quite sure yet.
-        print(camera.battery_string) # Gives battery level as a string ("OK" or "Low").  Returns "Unknown" if value is... well, unknown 
-        print(camera.notifications)  # Number of unread notifications (ie. motion alerts that haven't been viewed)
-        print(camera.motion)         # Dictionary containing values for keys ['video', 'image', 'time']
-                                     #   which corresponds to last motion recorded, thumbnail of last motion, and timestamp of last motion
-
-
-Class Descriptions
-===================                               
-.. code:: python
-
-    class Blink()
-
-* ``Blink.cameras`` Returns a dictionary of ``BlinkCamera`` objects where the key corresponds to the camera name and the value is the actual BlinkCamera object.
-* ``Blink.network_id`` Returns the current network id.
-* ``Blink.account_id`` Returns the account id.
-* ``Blink.events`` Returns a list of events recorded by blink.  This information will contain links to any motion caught by an armed camera..
-* ``Blink.online`` Returns online status of sync module (True = online, False = offline).
-* ``Blink.last_motion()`` Finds last motion information for each camera and stores it in the ``BlinkCamera.motion`` field.
-* ``Blink.arm`` Set to True to arm, False to disarm.  Can be used to see the status of the system as well.
-* ``Blink.refresh()`` Forces a refresh of all camera information.
-* ``Blink.get_summary()`` Returns json formatted summary of the system.
-* ``Blink.get_cameras()`` Finds all cameras in the system and creates ``BlinkCamera`` objects to represent them.
-* ``Blink.set_links()`` Gives each BlinkCamera object the links needed to find recent images and videos.
-* ``Blink.login()`` Prompts user for login information.
-* ``Blink.get_auth_token()`` Uses login information to retrieve authorization token from Blink for further communication.
-* ``Blink.get_ids()`` Retrieves the network_id and account_id from Blink in order to access video and image pages on their server.
-* ``Blink.setup_system()`` A wrapper script that calls:
-
+        print(camera.attributes)      # Print available attributes of camera
 
-.. code:: python
-
-    Blink.get_auth_token()
-    Blink.get_ids()
-    Blink.get_camers()
-    Blink.set_links()
 
-.. code:: python
-
-  class BlinkCamera(config, urls)
-  
-The ``BlinkCamera`` class expects to receive:
-
-* A dictionary ``config`` that contains the camera name, device id, armed status, thumbnail url, camera temperature, camery battery level, number of notifications, and region id
-* A ``BlinkURLHandler`` object that contains all the links necessary for communication.
-
-
-Ultimately, this class is just a wrapper for each individual camera in order to make communication with individual cameras less clunky.  The following properties/methods are availiable (in addition to the ones mentioned earlier):
-
-* ``BlinkCamera.snap_picture()`` Takes an image with the camera and saves it as the new thumbnail.  The ``Blink.refresh()`` method should be called after this if you want to store the new thumbnail link.
-* ``BlinkCamera.set_motion_detect(enable=True/False)`` Sending True to this function will enable motion detection for the camera.  Setting to False will disable motion detection.
-* ``BlinkCamera.image_to_file(path)`` This will write the current thumbnail to the location indicated in 'path'
-* ``BlinkCamera.image_refresh()`` Refreshes the current thumbnail.
-
-
-.. code:: python
-
-    class BlinkURLHandler(region_id)
-    
-The ``BlinkURLHandler`` class expects to be initialized with the region id found in the ``Blink.get_auth_token()`` function.  The class will then create the necessary links required for various communication.
-
-.. |Build Status| image:: https://travis-ci.org/fronzbot/blinkpy.svg?branch=master
+.. |Build Status| image:: https://travis-ci.org/fronzbot/blinkpy.svg?branch=dev
    :target: https://travis-ci.org/fronzbot/blinkpy
-.. |Coverage Status| image:: https://coveralls.io/repos/github/fronzbot/blinkpy/badge.svg?branch=master
-    :target: https://coveralls.io/github/fronzbot/blinkpy?branch=master
+.. |Coverage Status| image:: https://coveralls.io/repos/github/fronzbot/blinkpy/badge.svg?branch=dev
+    :target: https://coveralls.io/github/fronzbot/blinkpy?branch=dev
 .. |PyPi Version| image:: https://img.shields.io/pypi/v/blinkpy.svg
     :target: https://pypi.python.org/pypi/blinkpy
-    
+.. |Docs| image:: https://readthedocs.org/projects/blinkpy/badge/?version=latest
+   :target: http://blinkpy.readthedocs.io/en/latest/?badge=latest

__init__.py

@@ -0,0 +1 @@
+"""Init file for blinkpy."""