diff --git a/CHANGES.rst b/CHANGES.rst index 571746c..3452982 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,7 +4,7 @@ Changelog A list of changes between each release 0.7.0.dev (development version) -^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Fixed style errors for bumped pydocstring and pylint versions 0.6.0 (2017-05-12) diff --git a/README.rst b/README.rst index f800917..d3eb6f5 100644 --- a/README.rst +++ b/README.rst @@ -1,5 +1,5 @@ blinkpy |Build Status| |Coverage Status| -============ +============================================= A Python library for the Blink Camera system Disclaimer: @@ -85,6 +85,8 @@ Class Descriptions * ``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: + + .. code:: python Blink.get_auth_token() @@ -101,6 +103,7 @@ 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. @@ -108,6 +111,7 @@ Ultimately, this class is just a wrapper for each individual camera in order to * ``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) @@ -118,10 +122,3 @@ The ``BlinkURLHandler`` class expects to be initialized with the region id found :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 - - - - - - - diff --git a/requirements_test.txt b/requirements_test.txt index ea788b1..1f8e313 100644 --- a/requirements_test.txt +++ b/requirements_test.txt @@ -5,4 +5,6 @@ pydocstyle==2.0.0 pytest>=2.9.2 pytest-cov>=2.3.1 pytest-sugar>=0.8.0 -pytest-timeout>=1.0.0 \ No newline at end of file +pytest-timeout>=1.0.0 +restructuredtext-lint>=1.0.1 +pygments>=2.2.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index b57e2d2..032b19d 100644 --- a/tox.ini +++ b/tox.ini @@ -23,6 +23,8 @@ commands = pylint --rcfile={toxinidir}/pylintrc blinkpy.py tests flake8 blinkpy.py tests pydocstyle blinkpy.py tests + rst-lint README.rst + rst-lint CHANGES.rst [testenv:build] recreate = True