new infrastructure files, use ruff, update for new displayio API

Author: FoamyGuy

.pre-commit-config.yaml

@@ -1,40 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
--   repo: https://github.com/python/black
-    rev: 20.8b1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
     hooks:
-    - id: black
--   repo: https://github.com/fsfe/reuse-tool
-    rev: v0.12.1
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-    - id: reuse
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
-    hooks:
-    -   id: pylint
-        name: pylint (library code)
-        types: [python]
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
--   repo: local
-    hooks:
-    -   id: pylint_examples
-        name: pylint (examples code)
-        description: Run pylint rules on "examples/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)']
-        language: system
-    -   id: pylint_tests
-        name: pylint (tests code)
-        description: Run pylint rules on "tests/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "tests" ]] || for test in $(find . -path "./tests/*.py"); do pylint --disable=missing-docstring $test; done)']
-        language: system
+      - id: reuse

.readthedocs.yaml

@@ -8,8 +8,11 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
-  os: ubuntu-20.04
+  os: ubuntu-lts-latest
   tools:
     python: "3"
 

README.rst

@@ -17,9 +17,9 @@ Introduction
     :alt: Build Status
 
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 Add some flair to your widgets with effects!
 

displayio_effects/__init__.py

@@ -21,9 +21,9 @@
   https://circuitpython.org/downloads
 """
 
-
 WIDGET_TYPE_ATTR = "_widget_type"
 
+
 # pylint: disable=too-few-public-methods
 class WidgetType:
     """Enum values  for customizable widget types.  Valid options are:

displayio_effects/colorwheel_effect.py

@@ -4,7 +4,7 @@
 # SPDX-License-Identifier: MIT
 # pylint: disable=protected-access
 """
-`displayio_effects.fluctuation_effect`
+`displayio_effects.colorwheel_effect`
 ================================================================================
 
 Add the colorwheel effect to your widgets
@@ -21,9 +21,10 @@
   https://circuitpython.org/downloads
 """
 
+from adafruit_itertools import cycle
 from rainbowio import colorwheel
-from adafruit_itertools.adafruit_itertools import cycle
-from displayio_effects import WidgetType, WIDGET_TYPE_ATTR
+
+from displayio_effects import WIDGET_TYPE_ATTR, WidgetType
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/tekktrik/CircuitPython_Org_DisplayIO_Effects.git"
@@ -69,9 +70,7 @@ def hook_colorwheel_effect(widget_class, widget_type):
     """
 
     if not COLORWHEEL_WIDGET_VALUES.get(widget_type):
-        raise ValueError(
-            "The given widget does not have the ability to use this effect"
-        )
+        raise ValueError("The given widget does not have the ability to use this effect")
 
     setattr(widget_class, WIDGET_TYPE_ATTR, widget_type)
 

displayio_effects/fluctuation_effect.py

@@ -22,7 +22,8 @@
 """
 
 import random
-from displayio_effects import WidgetType, WIDGET_TYPE_ATTR
+
+from displayio_effects import WIDGET_TYPE_ATTR, WidgetType
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/tekktrik/CircuitPython_Org_DisplayIO_Effects.git"
@@ -79,11 +80,10 @@ def update_fluctuation(self):
         self._fluctuation_destination = None
         return
 
-    if self._fluctuation_destination in (None, self._fluctuation_hold_value):
+    if self._fluctuation_destination in {None, self._fluctuation_hold_value}:
         limit_bound = self._fluctuation_amplitude * 10
         self._fluctuation_destination = (
-            random.uniform(-limit_bound, limit_bound) / 10
-            + self._fluctuation_hold_value
+            random.uniform(-limit_bound, limit_bound) / 10 + self._fluctuation_hold_value
         )
 
     value = getattr(self, value_name)
@@ -124,9 +124,7 @@ def hook_fluctuation_effect(widget_class, widget_type):
     """
 
     if not FLUCTUATION_WIDGET_VALUES.get(widget_type):
-        raise ValueError(
-            "The given widget does not have the ability to use this effect"
-        )
+        raise ValueError("The given widget does not have the ability to use this effect")
 
     setattr(widget_class, WIDGET_TYPE_ATTR, widget_type)
 

docs/api.rst

@@ -4,5 +4,11 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: displayio_effects.fluctuation_effect
     :members:
+
+.. automodule:: displayio_effects.colorwheel_effect
+    :members:

docs/conf.py

@@ -1,9 +1,8 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
 
@@ -16,6 +15,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
@@ -27,6 +27,7 @@
 # autodoc module docs will fail to generate with a warning.
 # autodoc_mock_imports = ["digitalio", "busio"]
 
+autodoc_preserve_defaults = True
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
@@ -46,7 +47,12 @@
 
 # General information about the project.
 project = "CircuitPython DisplayIO_Effects Library"
-copyright = "2022 Alec Delaney"
+creation_year = "2022"
+current_year = str(datetime.datetime.now().year)
+year_duration = (
+    current_year if current_year == creation_year else creation_year + " - " + current_year
+)
+copyright = year_duration + " Alec Delaney"
 author = "Alec Delaney"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -63,7 +69,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -101,19 +107,9 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
-
-if not on_rtd:  # only import and set the theme if we're building docs locally
-    try:
-        import sphinx_rtd_theme
-
-        html_theme = "sphinx_rtd_theme"
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
-    except:
-        html_theme = "default"
-        html_theme_path = ["."]
-else:
-    html_theme_path = ["."]
+import sphinx_rtd_theme
+
+html_theme = "sphinx_rtd_theme"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

examples/displayio_effects_colorwheel.py

@@ -8,10 +8,12 @@
 """
 
 import time
+
 import board
 import displayio
 import terminalio
 from displayio_dial import Dial
+
 from displayio_effects import WidgetType, colorwheel_effect
 
 # Fonts used for the Dial tick labels
@@ -47,12 +49,11 @@
 my_group = displayio.Group()
 my_group.append(my_dial)
 
-display.show(my_group)  # add high level Group to the display
+display.root_group = my_group  # add high level Group to the display
 
 # Set the dial to the value before turning on the fluctuation effect
 my_dial.value = 50
 
 while True:
-
     my_dial.update_colorwheel()
     time.sleep(0.01)

examples/displayio_effects_gauge.py

@@ -6,11 +6,12 @@
 Use the random fluctuation effect for the Gauge.
 """
 
-
 import time
+
 import board
 import displayio
 from displayio_gauge import Gauge
+
 from displayio_effects import WidgetType, fluctuation_effect
 
 display = board.DISPLAY
@@ -24,7 +25,7 @@
 color_palette[0] = 0x000000
 bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)
 main_group.append(bg_sprite)
-display.show(main_group)
+display.root_group = main_group
 
 fluctuation_effect.hook_fluctuation_effect(Gauge, WidgetType.GAUGE)
 
@@ -45,5 +46,4 @@
 
 
 while True:
-
     my_gauge.update_fluctuation()