Docs, pylint.

Author: kattni

adafruit_led_animation/animation/__init__.py

@@ -24,7 +24,7 @@
 `adafruit_led_animation.animation`
 ================================================================================
 
-Animation base class, and basic animations for CircuitPython helper library for LED animations.
+Animation base class for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
@@ -46,9 +46,7 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git"
 
-from time import monotonic_ns
-
-from adafruit_led_animation import NANOS_PER_SECOND
+from adafruit_led_animation import NANOS_PER_SECOND, monotonic_ns
 
 
 class Animation:

adafruit_led_animation/animation/blink.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.blink`
 ================================================================================
 
-TODO
+Blink animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.animation.colorcycle import ColorCycle

adafruit_led_animation/animation/chase.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.chase`
 ================================================================================
 
-TODO
+Theatre chase animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from math import ceil

adafruit_led_animation/animation/colorcycle.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.colorcycle`
 ================================================================================
 
-TODO
+Color cycle animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.animation import Animation

adafruit_led_animation/animation/comet.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.comet`
 ================================================================================
 
-TODO
+Comet animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.animation import Animation

adafruit_led_animation/animation/pulse.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.pulse`
 ================================================================================
 
-TODO
+Pulse animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.animation import Animation

adafruit_led_animation/animation/rainbow.py

@@ -24,8 +24,7 @@
 `adafruit_led_animation.animation.rainbow`
 ================================================================================
 
-Rainbow animations for CircuitPython helper library for LED animations.
-TODO
+Rainbow animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
@@ -52,7 +51,6 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git"
 
 
-
 class Rainbow(Animation):
     """
     The classic rainbow color wheel.
@@ -62,11 +60,14 @@ class Rainbow(Animation):
     :param float period: Period to cycle the rainbow over in seconds.  Default 5.
     :param float step: Color wheel step.  Default 1.
     :param str name: Name of animation (optional, useful for sequences and debugging).
-    :param bool precompute_rainbow: Whether to precompute the rainbow.  Uses more memory.  (default True).
+    :param bool precompute_rainbow: Whether to precompute the rainbow.  Uses more memory.
+                                    (default True).
     """
 
     # pylint: disable=too-many-arguments
-    def __init__(self, pixel_object, speed, period=5, step=1, name=None, precompute_rainbow=True):
+    def __init__(
+        self, pixel_object, speed, period=5, step=1, name=None, precompute_rainbow=True
+    ):
         super().__init__(pixel_object, speed, BLACK, name=name)
         self._period = period
         self._step = step
@@ -77,6 +78,7 @@ def __init__(self, pixel_object, speed, period=5, step=1, name=None, precompute_
             self.generate_rainbow()
 
     def generate_rainbow(self):
+        """Generates the rainbow."""
         self.colors = []
         i = 0
         while i < 256:
@@ -108,8 +110,7 @@ def _color_wheel_generator(self):
             else:
                 wheel_index = int((pos / period) * 256)
                 self.pixel_object[:] = [
-                    colorwheel((i + wheel_index) % 255)
-                    for i in range(num_pixels)
+                    colorwheel((i + wheel_index) % 255) for i in range(num_pixels)
                 ]
             self._wheel_index = wheel_index
             self.show()
@@ -124,10 +125,14 @@ def _draw_precomputed(self, num_pixels, wheel_index):
                 num = num_pixels - i
             if wheel_index + num > len(self.colors):
                 colors_left = len(self.colors) - wheel_index
-                self.pixel_object[i:i + colors_left] = self.colors[wheel_index:]
-                self.pixel_object[i + colors_left:i + num] = self.colors[:num - colors_left]
+                self.pixel_object[i : i + colors_left] = self.colors[wheel_index:]
+                self.pixel_object[i + colors_left : i + num] = self.colors[
+                    : num - colors_left
+                ]
             else:
-                self.pixel_object[i:i + num] = self.colors[wheel_index:wheel_index + num]
+                self.pixel_object[i : i + num] = self.colors[
+                    wheel_index : wheel_index + num
+                ]
 
     def draw(self):
         next(self._generator)

adafruit_led_animation/animation/rainbowchase.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.rainbowchase`
 ================================================================================
 
-TODO
+Rainbow chase animation for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.color import colorwheel

adafruit_led_animation/animation/rainbowcomet.py

@@ -24,10 +24,24 @@
 `adafruit_led_animation.animation.rainbowcomet`
 ================================================================================
 
-TODO
+Rainbow comet for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
+
 """
 
 from adafruit_led_animation.animation.comet import Comet

adafruit_led_animation/animation/rainbowsparkle.py

@@ -21,56 +21,96 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 """
-`adafruit_led_animation.animation.rainbowcomet`
+`adafruit_led_animation.animation.rainbowsparkle`
 ================================================================================
 
-TODO
+Rainbow sparkle for CircuitPython helper library for LED animations.
 
 * Author(s): Roy Hooper, Kattni Rembor
 
+Implementation Notes
+--------------------
+
+**Hardware:**
+
+* `Adafruit NeoPixels <https://www.adafruit.com/category/168>`_
+* `Adafruit DotStars <https://www.adafruit.com/category/885>`_
+
+**Software and Dependencies:**
+
+* Adafruit CircuitPython firmware for the supported boards:
+  https://circuitpython.org/downloads
+
 """
 
 import random
-
 from adafruit_led_animation.animation.rainbow import Rainbow
 
 
 class RainbowSparkle(Rainbow):
+    """Rainbow sparkle animation.
+
+    :param pixel_object: The initialised LED object.
+    :param float speed: Animation refresh rate in seconds, e.g. ``0.1``.
+    :param float period: Period to cycle the rainbow over in seconds.  Default 5.
+    :param float step: Color wheel step.  Default 1.
+    :param str name: Name of animation (optional, useful for sequences and debugging).
+    :param float background_brightness: The brightness of the background rainbow. Defaults to
+                                        ``0.2`` or 20 percent.
+    :param bool precompute_rainbow: Whether to precompute the rainbow.  Uses more memory.
+                                    (default True).
+    """
 
-    def __init__(self, pixel_object, speed, period=5, num_sparkles=None, step=1, name=None,
-                 bg_brightness=0.2):
+    # pylint: disable=too-many-arguments
+    def __init__(
+        self,
+        pixel_object,
+        speed,
+        period=5,
+        num_sparkles=None,
+        step=1,
+        name=None,
+        background_brightness=0.2,
+    ):
         self._num_sparkles = num_sparkles
         if num_sparkles is None:
             self._num_sparkles = max(1, int(len(pixel_object) / 20))
         self._sparkle_duration = 2
-        self._bg_brightness = bg_brightness
+        self._background_brightness = background_brightness
         self._bright_colors = None
-        super().__init__(pixel_object=pixel_object, speed=speed, period=period, step=step, name=name,
-                         precompute_rainbow=True)
+        super().__init__(
+            pixel_object=pixel_object,
+            speed=speed,
+            period=period,
+            step=step,
+            name=name,
+            precompute_rainbow=True,
+        )
 
-    def generate_rainbow(self, step=1):
+    def generate_rainbow(self):
         super().generate_rainbow()
         self._bright_colors = self.colors[:]
         for i, color in enumerate(self.colors):
             if isinstance(self.colors[i], int):
                 self.colors[i] = (
-                    int(self._bg_brightness * ((color & 0xff0000) >> 16)),
-                    int(self._bg_brightness * ((color & 0xff00) >> 8)),
-                    int(self._bg_brightness * (color & 0xff))
+                    int(self._background_brightness * ((color & 0xFF0000) >> 16)),
+                    int(self._background_brightness * ((color & 0xFF00) >> 8)),
+                    int(self._background_brightness * (color & 0xFF)),
                 )
             else:
                 self.colors[i] = (
-                    int(self._bg_brightness * color[0]),
-                    int(self._bg_brightness * color[1]),
-                    int(self._bg_brightness * color[2])
+                    int(self._background_brightness * color[0]),
+                    int(self._background_brightness * color[1]),
+                    int(self._background_brightness * color[2]),
                 )
 
     def show(self):
         pixels = [
-            random.randint(0, len(self.pixel_object)-1)
+            random.randint(0, len(self.pixel_object) - 1)
             for n in range(self._num_sparkles)
         ]
         for pixel in pixels:
-            bc = (self._wheel_index + pixel) % len(self._bright_colors)
-            self.pixel_object[pixel] = self._bright_colors[bc]
+            self.pixel_object[pixel] = self._bright_colors[
+                (self._wheel_index + pixel) % len(self._bright_colors)
+            ]
         super().show()