From bbd233edb97ef472c7b690f0dfa8cf36dd641ca7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 24 Jul 2021 13:45:34 -0500 Subject: [PATCH 01/76] removing usage of gamepad and using keypad instead. --- adafruit_pybadger/clue.py | 18 +++++------ adafruit_pybadger/cpb_gizmo.py | 21 ++++++------ adafruit_pybadger/mag_tag.py | 15 --------- adafruit_pybadger/pewpewm4.py | 51 ++++++++++++++++-------------- adafruit_pybadger/pybadge.py | 34 ++++++++------------ adafruit_pybadger/pybadger_base.py | 43 +++++++++++++++++++++++++ adafruit_pybadger/pygamer.py | 28 +++++++++------- docs/conf.py | 4 +-- docs/mocks/keypad.py | 15 +++++++++ 9 files changed, 137 insertions(+), 92 deletions(-) create mode 100644 docs/mocks/keypad.py diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 4998612..debdbc3 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -27,12 +27,11 @@ from collections import namedtuple import board -import digitalio import audiopwmio -from gamepad import GamePad +import keypad import adafruit_lsm6ds.lsm6ds33 import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -59,10 +58,10 @@ def __init__(self): board.NEOPIXEL, self._neopixel_count, brightness=1, pixel_order=neopixel.GRB ) - self._buttons = GamePad( - digitalio.DigitalInOut(board.BUTTON_A), - digitalio.DigitalInOut(board.BUTTON_B), + self._keys = keypad.Keys( + [board.BUTTON_A, board.BUTTON_B], value_when_pressed=False, pull=True ) + self._buttons = KeyStates(self._keys) @property def button(self): @@ -80,10 +79,11 @@ def button(self): elif pybadger.button.b: print("Button B") """ - button_values = self._buttons.get_pressed() - return Buttons( - button_values & PyBadgerBase.BUTTON_B, button_values & PyBadgerBase.BUTTON_A + self._buttons.update() + button_values = tuple( + self._buttons.was_pressed(i) for i in range(self._keys.key_count) ) + return Buttons(button_values[0], button_values[1]) @property def _unsupported(self): diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 39530fb..29c23b1 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -32,11 +32,11 @@ import analogio import busio import audiopwmio +import keypad from adafruit_gizmo import tft_gizmo -from gamepad import GamePad import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -66,11 +66,11 @@ def __init__(self): self._neopixels = neopixel.NeoPixel( board.NEOPIXEL, self._neopixel_count, brightness=1, pixel_order=neopixel.GRB ) - _a_btn = digitalio.DigitalInOut(board.BUTTON_A) - _a_btn.switch_to_input(pull=digitalio.Pull.DOWN) - _b_btn = digitalio.DigitalInOut(board.BUTTON_B) - _b_btn.switch_to_input(pull=digitalio.Pull.DOWN) - self._buttons = GamePad(_a_btn, _b_btn) + + self._keys = keypad.Keys( + [board.BUTTON_A, board.BUTTON_B], value_when_pressed=True, pull=True + ) + self._buttons = KeyStates(self._keys) self._light_sensor = analogio.AnalogIn(board.LIGHT) @property @@ -89,10 +89,11 @@ def button(self): elif pybadger.button.b: print("Button B") """ - button_values = self._buttons.get_pressed() - return Buttons( - button_values & PyBadgerBase.BUTTON_B, button_values & PyBadgerBase.BUTTON_A + self._buttons.update() + button_values = tuple( + self._buttons.was_pressed(i) for i in range(self._keys.key_count) ) + return Buttons(button_values[0], button_values[1]) @property def _unsupported(self): diff --git a/adafruit_pybadger/mag_tag.py b/adafruit_pybadger/mag_tag.py index 2f8b849..be4e1a9 100644 --- a/adafruit_pybadger/mag_tag.py +++ b/adafruit_pybadger/mag_tag.py @@ -27,9 +27,6 @@ from collections import namedtuple import board - -# import digitalio -# from gamepad import GamePad import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase @@ -52,13 +49,6 @@ def __init__(self): board.NEOPIXEL, self._neopixel_count, brightness=1, pixel_order=neopixel.GRB ) - # self._buttons = GamePad( - # , - # digitalio.DigitalInOut(board.BUTTON_B), - # digitalio.DigitalInOut(board.BUTTON_C), - # digitalio.DigitalInOut(board.BUTTON_D), - # ) - @property def button(self): """The buttons on the board. @@ -75,11 +65,6 @@ def button(self): elif pybadger.button.b: print("Button B") """ - # button_values = self._buttons.get_pressed() - # return Buttons( - # button_values & PyBadgerBase.BUTTON_B, button_values & PyBadgerBase.BUTTON_A, - # button_values & PyBadgerBase.BUTTON_START, button_values & PyBadgerBase.BUTTON_SELECT - # ) @property def _unsupported(self): diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index cb6462a..7a6bbca 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -27,10 +27,9 @@ from collections import namedtuple import board -import digitalio import audioio -from gamepad import GamePad -from adafruit_pybadger.pybadger_base import PyBadgerBase +import keypad +from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -47,16 +46,22 @@ class PewPewM4(PyBadgerBase): def __init__(self): super().__init__() - self._buttons = GamePad( - digitalio.DigitalInOut(board.BUTTON_O), - digitalio.DigitalInOut(board.BUTTON_X), - digitalio.DigitalInOut(board.BUTTON_Z), - digitalio.DigitalInOut(board.BUTTON_RIGHT), - digitalio.DigitalInOut(board.BUTTON_DOWN), - digitalio.DigitalInOut(board.BUTTON_UP), - digitalio.DigitalInOut(board.BUTTON_LEFT), + self._keys = keypad.Keys( + [ + board.BUTTON_O, + board.BUTTON_X, + board.BUTTON_Z, + board.BUTTON_RIGHT, + board.BUTTON_DOWN, + board.BUTTON_UP, + board.BUTTON_LEFT, + ], + value_when_pressed=False, + pull=True, ) + self._buttons = KeyStates(self._keys) + @property def button(self): """The buttons on the board. @@ -73,20 +78,18 @@ def button(self): elif pybadger.button.o: print("Button O") """ - button_values = self._buttons.get_pressed() + self._buttons.update() + button_values = tuple( + self._buttons.was_pressed(i) for i in range(self._keys.key_count) + ) return Buttons( - *[ - button_values & button - for button in ( - PyBadgerBase.BUTTON_B, - PyBadgerBase.BUTTON_A, - PyBadgerBase.BUTTON_START, - PyBadgerBase.BUTTON_SELECT, - PyBadgerBase.BUTTON_RIGHT, - PyBadgerBase.BUTTON_DOWN, - PyBadgerBase.BUTTON_UP, - ) - ] + button_values[0], + button_values[1], + button_values[2], + button_values[3], + button_values[4], + button_values[5], + button_values[6], ) @property diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index 083b727..ecf9b96 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -35,10 +35,10 @@ import digitalio import analogio import audioio -from gamepadshift import GamePadShift +import keypad import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -77,11 +77,14 @@ def __init__(self): board.NEOPIXEL, self._neopixel_count, brightness=1, pixel_order=neopixel.GRB ) - self._buttons = GamePadShift( - digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH), + self._keys = keypad.ShiftRegisterKeys( + clock=board.BUTTON_CLOCK, + data=board.BUTTON_OUT, + latch=board.BUTTON_LATCH, + key_count=8, + value_when_pressed=True, ) + self._buttons = KeyStates(self._keys) self._light_sensor = analogio.AnalogIn(board.A7) @@ -106,22 +109,11 @@ def button(self): print("Button select") """ - button_values = self._buttons.get_pressed() - return Buttons( - *[ - button_values & button - for button in ( - PyBadgerBase.BUTTON_B, - PyBadgerBase.BUTTON_A, - PyBadgerBase.BUTTON_START, - PyBadgerBase.BUTTON_SELECT, - PyBadgerBase.BUTTON_RIGHT, - PyBadgerBase.BUTTON_DOWN, - PyBadgerBase.BUTTON_UP, - PyBadgerBase.BUTTON_LEFT, - ) - ] + self._buttons.update() + button_values = tuple( + self._buttons.was_pressed(i) for i in range(self._keys.key_count) ) + return Buttons(*[button_values]) pybadge = PyBadge() # pylint: disable=invalid-name diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index dc187d7..7aa76c9 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -745,3 +745,46 @@ def play_file(self, file_name): while audio.playing: pass self._enable_speaker(enable=True) + + +class KeyStates: + """Convert `keypad.Event` information from the given `keypad` scanner into key-pressed state. + + :param scanner: a `keypad` scanner, such as `keypad.Keys` + """ + + def __init__(self, scanner): + self._scanner = scanner + self._pressed = [False] * self._scanner.key_count + self.update() + + def update(self): + """Update key information based on pending scanner events.""" + + # If the event queue overflowed, discard any pending events, + # and assume all keys are now released. + if self._scanner.events.overflowed: + self._scanner.events.clear() + self._scanner.reset() + self._pressed = [False] * self._scanner.key_count + + self._was_pressed = self._pressed.copy() + + while True: + event = self._scanner.events.get() + if not event: + # Event queue is now empty. + break + self._pressed[event.key_number] = event.pressed + if event.pressed: + self._was_pressed[event.key_number] = True + + def was_pressed(self, key_number): + """True if key was down at any time since the last `update()`, + even if it was later released. + """ + return self._was_pressed[key_number] + + def pressed(self, key_number): + """True if key is currently pressed, as of the last `update()`.""" + return self._pressed[key_number] diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index d4d1759..784a290 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -31,9 +31,9 @@ import digitalio import audioio import neopixel -from gamepadshift import GamePadShift +import keypad import adafruit_lis3dh -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -65,11 +65,14 @@ def __init__(self): board.NEOPIXEL, self._neopixel_count, brightness=1, pixel_order=neopixel.GRB ) - self._buttons = GamePadShift( - digitalio.DigitalInOut(board.BUTTON_CLOCK), - digitalio.DigitalInOut(board.BUTTON_OUT), - digitalio.DigitalInOut(board.BUTTON_LATCH), + self._keys = keypad.ShiftRegisterKeys( + clock=board.BUTTON_CLOCK, + data=board.BUTTON_OUT, + latch=board.BUTTON_LATCH, + key_count=4, + value_when_pressed=True, ) + self._buttons = KeyStates(self._keys) self._pygamer_joystick_x = analogio.AnalogIn(board.JOYSTICK_X) self._pygamer_joystick_y = analogio.AnalogIn(board.JOYSTICK_Y) @@ -97,13 +100,16 @@ def button(self): print("Button select") """ - button_values = self._buttons.get_pressed() + self._buttons.update() + button_values = tuple( + self._buttons.was_pressed(i) for i in range(self._keys.key_count) + ) x, y = self.joystick return Buttons( - button_values & PyBadgerBase.BUTTON_B, - button_values & PyBadgerBase.BUTTON_A, - button_values & PyBadgerBase.BUTTON_START, - button_values & PyBadgerBase.BUTTON_SELECT, + button_values[0], + button_values[1], + button_values[2], + button_values[3], x > 50000, # RIGHT y > 50000, # DOWN y < 15000, # UP diff --git a/docs/conf.py b/docs/conf.py index d2c5565..863bd38 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -8,6 +8,7 @@ import sys sys.path.insert(0, os.path.abspath("..")) +sys.path.insert(0, os.path.abspath("mocks")) # -- General configuration ------------------------------------------------ @@ -28,13 +29,12 @@ autodoc_mock_imports = [ "audioio", "displayio", - "gamepadshift", + "keypad", "neopixel", "analogio", "terminalio", "adafruit_lis3dh", "adafruit_lsm6ds", - "gamepad", "audiocore", "audiopwmio", "micropython", diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py new file mode 100644 index 0000000..7d91f9c --- /dev/null +++ b/docs/mocks/keypad.py @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 Jeff Epler for Adafruit Industries +# +# SPDX-License-Identifier: MIT +class EventQueue: + def __init__(self): + self.overflowed = False + + def get(self): + return None + + +class Keys: + def __init__(self, pins, value_when_pressed, pull): + self.key_count = len(pins) + self.events = EventQueue() \ No newline at end of file From 76240675d2bf0686480673c623bdb2f81164051b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 24 Jul 2021 13:49:56 -0500 Subject: [PATCH 02/76] pre-commit --- docs/mocks/keypad.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py index 7d91f9c..42220e2 100644 --- a/docs/mocks/keypad.py +++ b/docs/mocks/keypad.py @@ -12,4 +12,4 @@ def get(self): class Keys: def __init__(self, pins, value_when_pressed, pull): self.key_count = len(pins) - self.events = EventQueue() \ No newline at end of file + self.events = EventQueue() From 24949962c76526306d41692ed5e598e1edcd205d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 24 Jul 2021 21:20:42 -0500 Subject: [PATCH 03/76] fix docs build. fix pybadge button property --- adafruit_pybadger/pybadge.py | 11 ++++++++++- docs/conf.py | 1 - docs/mocks/keypad.py | 17 +++++++++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index ecf9b96..e873809 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -113,7 +113,16 @@ def button(self): button_values = tuple( self._buttons.was_pressed(i) for i in range(self._keys.key_count) ) - return Buttons(*[button_values]) + return Buttons( + button_values[0], + button_values[1], + button_values[2], + button_values[3], + button_values[4], + button_values[5], + button_values[6], + button_values[7], + ) pybadge = PyBadge() # pylint: disable=invalid-name diff --git a/docs/conf.py b/docs/conf.py index 863bd38..1b6b30c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,6 @@ autodoc_mock_imports = [ "audioio", "displayio", - "keypad", "neopixel", "analogio", "terminalio", diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py index 42220e2..5fcd12a 100644 --- a/docs/mocks/keypad.py +++ b/docs/mocks/keypad.py @@ -13,3 +13,20 @@ class Keys: def __init__(self, pins, value_when_pressed, pull): self.key_count = len(pins) self.events = EventQueue() + + +class ShiftRegisterKeys: + def __init__( + self, + *, + clock, + data, + latch, + value_to_latch=True, + key_count, + value_when_pressed, + interval=0.020, + max_events=64 + ): + self.key_count = 123 + self.events = EventQueue() From 8e12355409096f832e567e5ed0f23d755edd1b28 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 04/76] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index e78bad2..cfd1c41 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From cefca9d4c04c3a622f89063670e21a7ee92582ac Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 9 Nov 2021 13:11:29 -0600 Subject: [PATCH 05/76] rerun CI From 857ed811e7d9cb7fe953c7f5e88a26354adfb99a Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 06/76] Updated readthedocs file Signed-off-by: dherrada --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 75785b69ff6adffa457532115d8ef956c87b532d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:15:53 -0600 Subject: [PATCH 07/76] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 8f5fa0860d0ef02e16cf1ecc9cbb5d945ea5ace5 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 5 Dec 2021 10:24:49 -0600 Subject: [PATCH 08/76] check for accelerometer before initialising --- adafruit_pybadger/pybadge.py | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index e873809..d344b56 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -64,13 +64,18 @@ def __init__(self): self._accelerometer = None if i2c is not None: - int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) - try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) - except ValueError: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) + while not i2c.try_lock(): + pass + _i2c_devices = i2c.scan() + i2c.unlock() + if (int(0x18) in _i2c_devices): # PyBadge LC doesn't have accelerometer + int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) + try: + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( + i2c, address=0x19, int1=int1 + ) + except ValueError: + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) # NeoPixels self._neopixels = neopixel.NeoPixel( From 346e8d35428cdbb07cc314c118cb622ffcf0410d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 5 Dec 2021 10:34:50 -0600 Subject: [PATCH 09/76] check alternate address. code format --- adafruit_pybadger/pybadge.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index d344b56..bccff32 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -68,7 +68,9 @@ def __init__(self): pass _i2c_devices = i2c.scan() i2c.unlock() - if (int(0x18) in _i2c_devices): # PyBadge LC doesn't have accelerometer + + # PyBadge LC doesn't have accelerometer + if int(0x18) in _i2c_devices or int(0x19) in _i2c_devices: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( From c0abb195bfe27e0b418dd6a00baa8221a41f9c20 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 5 Dec 2021 12:44:00 -0600 Subject: [PATCH 10/76] attempt i2c lock 10 times at most --- adafruit_pybadger/pybadge.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index bccff32..faadda5 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -64,10 +64,14 @@ def __init__(self): self._accelerometer = None if i2c is not None: - while not i2c.try_lock(): - pass - _i2c_devices = i2c.scan() - i2c.unlock() + _i2c_devices = [] + + for i in range(10): + # try lock 10 times to avoid infinite loop in sphinx build + if i2c.try_lock(): + _i2c_devices = i2c.scan() + i2c.unlock() + break # PyBadge LC doesn't have accelerometer if int(0x18) in _i2c_devices or int(0x19) in _i2c_devices: From 2e6781ee7373fb41151ed9cbffa055f01dc678fd Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 5 Dec 2021 13:15:53 -0600 Subject: [PATCH 11/76] remove unused variable i and use _ instead --- adafruit_pybadger/pybadge.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index faadda5..38f1645 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -66,7 +66,7 @@ def __init__(self): if i2c is not None: _i2c_devices = [] - for i in range(10): + for _ in range(10): # try lock 10 times to avoid infinite loop in sphinx build if i2c.try_lock(): _i2c_devices = i2c.scan() From 5dd187aa7705879939f8b67c2e231909f89f3880 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Dec 2021 12:38:42 -0600 Subject: [PATCH 12/76] rename mag_tag to magtag. Remove neopixel power pin handling from magtag example --- adafruit_pybadger/__init__.py | 2 +- adafruit_pybadger/{mag_tag.py => magtag.py} | 0 examples/pybadger_magtag_simpletest.py | 6 ------ 3 files changed, 1 insertion(+), 7 deletions(-) rename adafruit_pybadger/{mag_tag.py => magtag.py} (100%) diff --git a/adafruit_pybadger/__init__.py b/adafruit_pybadger/__init__.py index c322ff8..7672a3b 100644 --- a/adafruit_pybadger/__init__.py +++ b/adafruit_pybadger/__init__.py @@ -21,4 +21,4 @@ elif "Circuit Playground Bluefruit" in os.uname().machine: from .cpb_gizmo import cpb_gizmo as pybadger elif "MagTag with ESP32S2" in os.uname().machine: - from .mag_tag import mag_tag as pybadger + from .magtag import mag_tag as pybadger diff --git a/adafruit_pybadger/mag_tag.py b/adafruit_pybadger/magtag.py similarity index 100% rename from adafruit_pybadger/mag_tag.py rename to adafruit_pybadger/magtag.py diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index afa0e51..504c7c7 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -52,9 +52,6 @@ def try_refresh(): print("after show, going to loop") -neopixel_pwr = digitalio.DigitalInOut(board.NEOPIXEL_POWER) -neopixel_pwr.direction = digitalio.Direction.OUTPUT -neopixel_pwr.value = False pybadger.pixels.fill(0x000022) while True: @@ -65,7 +62,6 @@ def try_refresh(): if prev_a and not cur_a: pybadger.pixels.fill(0x000000) - neopixel_pwr.value = True if SHOWING != "badge": print("changing to badge") SHOWING = "badge" @@ -76,7 +72,6 @@ def try_refresh(): if prev_b and not cur_b: pybadger.pixels.fill(0x000000) - neopixel_pwr.value = True if SHOWING != "qr": print("changing to qr") SHOWING = "qr" @@ -85,7 +80,6 @@ def try_refresh(): if prev_c and not cur_c: pybadger.pixels.fill(0x000000) - neopixel_pwr.value = True if SHOWING != "card": print("changing to card") SHOWING = "card" From 86c4141c21090750a871ca339606c61ec247dee7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Dec 2021 12:48:56 -0600 Subject: [PATCH 13/76] rename mag_tag to magtag. fix docs build for new name --- adafruit_pybadger/__init__.py | 2 +- adafruit_pybadger/magtag.py | 4 ++-- docs/api.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_pybadger/__init__.py b/adafruit_pybadger/__init__.py index 7672a3b..159826a 100644 --- a/adafruit_pybadger/__init__.py +++ b/adafruit_pybadger/__init__.py @@ -21,4 +21,4 @@ elif "Circuit Playground Bluefruit" in os.uname().machine: from .cpb_gizmo import cpb_gizmo as pybadger elif "MagTag with ESP32S2" in os.uname().machine: - from .magtag import mag_tag as pybadger + from .magtag import magtag as pybadger diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index be4e1a9..6db0f9b 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_pybadger.mag_tag` +`adafruit_pybadger.magtag` ================================================================================ Badge-focused CircuitPython helper library for Mag Tag. @@ -80,5 +80,5 @@ def _unsupported(self): button = _unsupported -mag_tag = MagTag() # pylint: disable=invalid-name +magtag = MagTag() # pylint: disable=invalid-name """Object that is automatically created on import.""" diff --git a/docs/api.rst b/docs/api.rst index 1154da2..a50522d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -10,7 +10,7 @@ .. automodule:: adafruit_pybadger.clue :members: -.. automodule:: adafruit_pybadger.mag_tag +.. automodule:: adafruit_pybadger.magtag :members: .. automodule:: adafruit_pybadger.pewpewm4 From adb3b7c7a0a86be87f9b1c75dd0d5044f473650b Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 14/76] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..474520d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 3492ff778df773162fabe70caea6f26101932b37 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 15/76] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 4 ++-- docs/index.rst | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 6df4d1d..de00863 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-pybadger/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/pybadger/en/latest/ + :target: https://docs.circuitpython.org/projects/pybadger/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -73,7 +73,7 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index 1b6b30c..f541e09 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 98b65bb..5ce0d37 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System From 510d62918902e709bd66199357cdeefba0ae3318 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 10 Feb 2022 10:07:14 -0500 Subject: [PATCH 16/76] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index de00863..4435493 100644 --- a/README.rst +++ b/README.rst @@ -75,14 +75,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From b879a441d9f6d9c80b223e1858b27ea36ea4da0a Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 17/76] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 299ae8ae803d3eb40e972a694c27b8fe5abf6532 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sat, 19 Feb 2022 22:05:44 -0500 Subject: [PATCH 18/76] Add type annotations --- adafruit_pybadger/clue.py | 9 +- adafruit_pybadger/cpb_gizmo.py | 9 +- adafruit_pybadger/magtag.py | 9 +- adafruit_pybadger/pewpewm4.py | 9 +- adafruit_pybadger/pybadge.py | 9 +- adafruit_pybadger/pybadger_base.py | 212 ++++++++++++++++------------- adafruit_pybadger/pygamer.py | 11 +- adafruit_pybadger/pyportal.py | 2 +- 8 files changed, 161 insertions(+), 109 deletions(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index debdbc3..e49180b 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -38,6 +38,11 @@ Buttons = namedtuple("Buttons", "a b") +try: + from typing import Type +except ImportError: + pass + class Clue(PyBadgerBase): """Class that represents a single CLUE.""" @@ -45,7 +50,7 @@ class Clue(PyBadgerBase): _audio_out = audiopwmio.PWMAudioOut _neopixel_count = 1 - def __init__(self): + def __init__(self) -> None: super().__init__() i2c = board.I2C() @@ -64,7 +69,7 @@ def __init__(self): self._buttons = KeyStates(self._keys) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 29c23b1..5d205c7 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -38,6 +38,11 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +try: + from typing import Type +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -51,7 +56,7 @@ class CPB_Gizmo(PyBadgerBase): _audio_out = audiopwmio.PWMAudioOut _neopixel_count = 10 - def __init__(self): + def __init__(self) -> None: super().__init__() _i2c = busio.I2C(board.ACCELEROMETER_SCL, board.ACCELEROMETER_SDA) @@ -74,7 +79,7 @@ def __init__(self): self._light_sensor = analogio.AnalogIn(board.LIGHT) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 6db0f9b..77415bb 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -30,6 +30,11 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase +try: + from typing import Type +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -41,7 +46,7 @@ class MagTag(PyBadgerBase): _neopixel_count = 4 - def __init__(self): + def __init__(self) -> None: super().__init__() # NeoPixels @@ -50,7 +55,7 @@ def __init__(self): ) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 7a6bbca..6fa95fc 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -31,6 +31,11 @@ import keypad from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +try: + from typing import Type +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -43,7 +48,7 @@ class PewPewM4(PyBadgerBase): _audio_out = audioio.AudioOut _neopixel_count = 0 - def __init__(self): + def __init__(self) -> None: super().__init__() self._keys = keypad.Keys( @@ -63,7 +68,7 @@ def __init__(self): self._buttons = KeyStates(self._keys) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index 38f1645..a90b3e1 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -40,6 +40,11 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +try: + from typing import Type +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -52,7 +57,7 @@ class PyBadge(PyBadgerBase): _audio_out = audioio.AudioOut _neopixel_count = 5 - def __init__(self): + def __init__(self) -> None: super().__init__() i2c = None @@ -100,7 +105,7 @@ def __init__(self): self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index e81a7ec..3567286 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -53,11 +53,25 @@ except ImportError: # Allow to work with no audio pass + +try: + from typing import Union, Tuple, Optional, Generator + from adafruit_bitmap_font.bdf import BDF + from adafruit_bitmap_font.pcf import PCF + from fontio import BuiltinFont + from keypad import Keys, ShiftRegisterKeys + from neopixel import NeoPixel + from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 + from adafruit_lis3dh import LIS3DH_I2C +except ImportError: + pass + + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" -def load_font(fontname, text): +def load_font(fontname: str, text: str) -> Union[BDF, PCF]: """Load a font and glyphs in the text string :param str fontname: The full path to the font file. @@ -112,7 +126,7 @@ class PyBadgerBase: BUTTON_A = const(2) BUTTON_B = const(1) - def __init__(self): + def __init__(self) -> None: self._light_sensor = None self._accelerometer = None self._label = label @@ -141,7 +155,7 @@ def __init__(self): self._sine_wave = None self._sine_wave_sample = None - def _create_badge_background(self): + def _create_badge_background(self) -> None: self._created_background = True if self._background_group is None: @@ -171,16 +185,16 @@ def _create_badge_background(self): def badge_background( self, - background_color=RED, - rectangle_color=WHITE, - rectangle_drop=0.4, - rectangle_height=0.5, - ): + background_color: Tuple[int, int, int] = RED, + rectangle_color: Tuple[int, int, int] = WHITE, + rectangle_drop: float = 0.4, + rectangle_height: float = 0.5, + ) -> displayio.Group: """Create a customisable badge background made up of a background color with a rectangle color block over it. Defaults are for ``show_badge``. - :param tuple background_color: The color to fill the entire screen as a background. - :param tuple rectangle_color: The color of a rectangle that displays over the background. + :param tuple background_color: The color to fill the entire screen as a background, as RGB values. + :param tuple rectangle_color: The color of a rectangle that displays over the background, as RGB values. :param float rectangle_drop: The distance from the top of the display to begin displaying the rectangle. Float represents a percentage of the display, e.g. 0.4 = 40% of the display. Defaults to ``0.4``. @@ -206,11 +220,11 @@ def badge_background( def _badge_background( self, - background_color=RED, - rectangle_color=WHITE, - rectangle_drop=0.4, - rectangle_height=0.5, - ): + background_color: Tuple[int, int, int] = RED, + rectangle_color: Tuple[int, int, int] = WHITE, + rectangle_drop: float = 0.4, + rectangle_height: float = 0.5, + ) -> displayio.Group: """Populate the background color with a rectangle color block over it as the background for a name badge.""" background_group = displayio.Group() @@ -233,7 +247,7 @@ def _badge_background( background_group.append(rectangle) return background_group - def image_background(self, image_name=None): + def image_background(self, image_name: Optional[str] = None) -> None: """Create a bitmap image background. :param str image_name: The name of the bitmap image as a string including ``.bmp``, e.g. @@ -253,13 +267,13 @@ def image_background(self, image_name=None): # pylint: disable=too-many-arguments def badge_line( self, - text=" ", - color=BLACK, - scale=1, - font=terminalio.FONT, - left_justify=False, - padding_above=0, - ): + text: str = " ", + color: Tuple[int, int, int] = BLACK, + scale: int = 1, + font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + left_justify: bool = False, + padding_above: int = 0, + ) -> None: """Add a line of text to the display. Designed to work with ``badge_background`` for a color-block style badge, or with ``image_background`` for a badge with a background image. @@ -268,7 +282,7 @@ def badge_line( :param tuple color: The color of the line of text. Defaults to ``(0, 0, 0)``. :param int scale: The scale of the text. Must be an integer 1 or higher. Defaults to ``1``. :param font: The font used for displaying the text. Defaults to ``terminalio.FONT``. - :param left_justify: Left-justify the line of text. Defaults to ``False`` which centers the + :param bool left_justify: Left-justify the line of text. Defaults to ``False`` which centers the font on the display. :param int padding_above: Add padding above the displayed line of text. A ``padding_above`` of ``1`` is equivalent to the height of one line of text, ``2`` @@ -339,7 +353,7 @@ def badge_line( else: self._y_position += height * scale + 4 - def show_custom_badge(self): + def show_custom_badge(self) -> None: """Call ``pybadger.show_custom_badge()`` to display the custom badge elements. If ``show_custom_badge()`` is not called, the custom badge elements will not be displayed. """ @@ -351,15 +365,15 @@ def show_custom_badge(self): # pylint: disable=too-many-arguments def _create_label_group( self, - text, - font, - scale, - height_adjustment, - background_color=None, - color=0xFFFFFF, - width_adjustment=2, - line_spacing=0.75, - ): + text: str, + font: Union[BuiltinFont, BDF, PCF], + scale: int, + height_adjustment: float, + background_color: Optional[int] = None, + color: int = 0xFFFFFF, + width_adjustment: float = 2, + line_spacing: float = 0.75, + ) -> displayio.Group: """Create a label group with the given text, font, and spacing.""" # If the given font is a string, treat it as a file path and try to load it if isinstance(font, str): @@ -379,7 +393,7 @@ def _create_label_group( create_label_group.append(create_label) return create_label_group - def _check_for_movement(self, movement_threshold=10): + def _check_for_movement(self, movement_threshold: int = 10) -> bool: """Checks to see if board is moving. Used to auto-dim display when not moving.""" current_accelerometer = self.acceleration if self._last_accelerometer is None: @@ -394,10 +408,10 @@ def _check_for_movement(self, movement_threshold=10): self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold - def auto_dim_display(self, delay=5.0, movement_threshold=10): + def auto_dim_display(self, delay: float = 5.0, movement_threshold: int = 10): """Auto-dim the display when board is not moving. - :param int delay: Time in seconds before display auto-dims after movement has ceased. + :param float delay: Time in seconds before display auto-dims after movement has ceased. :param int movement_threshold: Threshold required for movement to be considered stopped. Change to increase or decrease sensitivity. @@ -417,17 +431,17 @@ def auto_dim_display(self, delay=5.0, movement_threshold=10): self.display.brightness = self._display_brightness @property - def pixels(self): + def pixels(self) -> NeoPixel: """Sequence like object representing the NeoPixels on the board.""" return self._neopixels @property - def light(self): + def light(self) -> bool: """Light sensor data.""" return self._light_sensor.value @property - def acceleration(self): + def acceleration(self) -> Union[LSM6DS33, LIS3DH_I2C]: """Accelerometer data, +/- 2G sensitivity.""" return ( self._accelerometer.acceleration @@ -436,12 +450,12 @@ def acceleration(self): ) @property - def brightness(self): + def brightness(self) -> float: """Display brightness. Must be a value between ``0`` and ``1``.""" return self.display.brightness @brightness.setter - def brightness(self, value): + def brightness(self, value: float) -> None: self._display_brightness = value self.display.brightness = value @@ -449,19 +463,19 @@ def brightness(self, value): def show_business_card( self, *, - image_name=None, - name_string=None, - name_scale=1, - name_font=terminalio.FONT, - font_color=0xFFFFFF, - font_background_color=None, - email_string_one=None, - email_scale_one=1, - email_font_one=terminalio.FONT, - email_string_two=None, - email_scale_two=1, - email_font_two=terminalio.FONT - ): + image_name: Optional[str] = None, + name_string: Optional[str] = None, + name_scale: int = 1, + name_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + font_color: int = 0xFFFFFF, + font_background_color: Optional[int] = None, + email_string_one: Optional[str] = None, + email_scale_one: int = 1, + email_font_one: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + email_string_two: Optional[str] = None, + email_scale_two: int = 1, + email_font_two: Union[BuiltinFont, BDF, PCF] = terminalio.FONT + ) -> None: """Display a bitmap image and a text string, such as a personal image and email address. :param str image_name: REQUIRED. The name of the bitmap image including .bmp, e.g. @@ -470,10 +484,14 @@ def show_business_card( ``"Blinka"``. :param int name_scale: The scale of ``name_string``. Defaults to 1. :param name_font: The font for the name string. Defaults to ``terminalio.FONT``. + :type name_font: ~BuiltinFont|~BDF|~PCF + :param int font_background_color: The color of the font background, default is None (transparent) + :param int font_color: The font color, default is white :param str email_string_one: A string to display along the bottom of the display, e.g. ``"blinka@adafruit.com"``. :param int email_scale_one: The scale of ``email_string_one``. Defaults to 1. :param email_font_one: The font for the first email string. Defaults to ``terminalio.FONT``. + :type email_font_one: ~BuiltinFont|~BDF|~PCF :param str email_string_two: A second string to display along the bottom of the display. Use if your email address is longer than one line or to add more space between the name and email address, @@ -481,6 +499,7 @@ def show_business_card( :param int email_scale_two: The scale of ``email_string_two``. Defaults to 1. :param email_font_two: The font for the second email string. Defaults to ``terminalio.FONT``. + :type email_font_two: ~BuiltinFont|~BDF|~PCF .. code-block:: python @@ -546,38 +565,41 @@ def show_business_card( def show_badge( self, *, - background_color=RED, - foreground_color=WHITE, - background_text_color=WHITE, - foreground_text_color=BLACK, - hello_font=terminalio.FONT, - hello_scale=1, - hello_string="HELLO", - my_name_is_font=terminalio.FONT, - my_name_is_scale=1, - my_name_is_string="MY NAME IS", - name_font=terminalio.FONT, - name_scale=1, - name_string="Blinka" - ): + background_color: Tuple[int, int, int] = RED, + foreground_color: Tuple[int, int, int] = WHITE, + background_text_color: Tuple[int, int, int] = WHITE, + foreground_text_color: Tuple[int, int, int] = BLACK, + hello_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + hello_scale: int = 1, + hello_string: str = "HELLO", + my_name_is_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + my_name_is_scale: int = 1, + my_name_is_string: str = "MY NAME IS", + name_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, + name_scale: int = 1, + name_string: str = "Blinka" + ) -> None: """Create a "Hello My Name is"-style badge. - :param background_color: The color of the background. Defaults to ``(255, 0, 0)``. - :param foreground_color: The color of the foreground rectangle. Defaults to + :param tuple background_color: The color of the background. Defaults to ``(255, 0, 0)``. + :param tuple foreground_color: The color of the foreground rectangle. Defaults to ``(255, 255, 255)``. - :param background_text_color: The color of the "HELLO MY NAME IS" text. Defaults to + :param tuple background_text_color: The color of the "HELLO MY NAME IS" text. Defaults to ``(255, 255, 255)``. - :param foreground_text_color: The color of the name text. Defaults to ``(0, 0, 0)``. + :param tuple foreground_text_color: The color of the name text. Defaults to ``(0, 0, 0)``. :param hello_font: The font for the "HELLO" string. Defaults to ``terminalio.FONT``. - :param hello_scale: The size scale of the "HELLO" string. Defaults to 1. - :param hello_string: The first string of the badge. Defaults to "HELLO". + :type hello_font: ~BuiltinFont|~BDF|~PCF + :param int hello_scale: The size scale of the "HELLO" string. Defaults to 1. + :param str hello_string: The first string of the badge. Defaults to "HELLO". :param my_name_is_font: The font for the "MY NAME IS" string. Defaults to ``terminalio.FONT``. - :param my_name_is_scale: The size scale of the "MY NAME IS" string. Defaults to 1. - :param my_name_is_string: The second string of the badge. Defaults to "MY NAME IS". + :type my_name_is_font: ~BuiltinFont|~BDF|~PCF + :param int my_name_is_scale: The size scale of the "MY NAME IS" string. Defaults to 1. + :param str my_name_is_string: The second string of the badge. Defaults to "MY NAME IS". :param name_font: The font for the name string. Defaults to ``terminalio.FONT``. - :param name_scale: The size scale of the name string. Defaults to 1. - :param name_string: The third string of the badge - change to be your name. Defaults to + :type name_font: ~BuiltinFont|~BDF|~PCF + :param int name_scale: The size scale of the name string. Defaults to 1. + :param str name_string: The third string of the badge - change to be your name. Defaults to "Blinka". .. code-block:: python @@ -624,12 +646,12 @@ def show_badge( group.append(name_group) self.display.show(group) - def show_terminal(self): + def show_terminal(self) -> None: """Revert to terminalio screen.""" self.display.show(None) @staticmethod - def bitmap_qr(matrix): + def bitmap_qr(matrix: adafruit_miniqr.QRBitMatrix) -> displayio.Bitmap: """The QR code bitmap.""" border_pixels = 2 bitmap = displayio.Bitmap( @@ -643,10 +665,10 @@ def bitmap_qr(matrix): bitmap[x + border_pixels, y + border_pixels] = 0 return bitmap - def show_qr_code(self, data="https://circuitpython.org"): + def show_qr_code(self, data: str = "https://circuitpython.org") -> None: """Generate a QR code. - :param string data: A string of data for the QR code + :param str data: A string of data for the QR code .. code-block:: python @@ -681,13 +703,13 @@ def show_qr_code(self, data="https://circuitpython.org"): self.display.show(qr_code) @staticmethod - def _sine_sample(length): + def _sine_sample(length: int) -> Generator[int, None, None]: tone_volume = (2 ** 15) - 1 shift = 2 ** 15 for i in range(length): yield int(tone_volume * math.sin(2 * math.pi * (i / length)) + shift) - def _generate_sample(self, length=100): + def _generate_sample(self, length: int = 100) -> None: if AUDIO_ENABLED: if self._sample is not None: return @@ -700,12 +722,12 @@ def _generate_sample(self, length=100): else: print("Required audio modules were missing") - def _enable_speaker(self, enable): + def _enable_speaker(self, enable: bool) -> None: if not hasattr(board, "SPEAKER_ENABLE"): return self._speaker_enable.value = enable - def play_tone(self, frequency, duration): + def play_tone(self, frequency: int, duration: float) -> None: """Produce a tone using the speaker. Try changing frequency to change the pitch of the tone. @@ -718,7 +740,7 @@ def play_tone(self, frequency, duration): time.sleep(duration) self.stop_tone() - def start_tone(self, frequency): + def start_tone(self, frequency: int) -> None: """Produce a tone using the speaker. Try changing frequency to change the pitch of the tone. Use ``stop_tone`` to stop the tone. @@ -735,7 +757,7 @@ def start_tone(self, frequency): if not self._sample.playing: self._sample.play(self._sine_wave_sample, loop=True) - def stop_tone(self): + def stop_tone(self) -> None: """Use with ``start_tone`` to stop the tone produced.""" # Stop playing any tones. if self._sample is not None and self._sample.playing: @@ -744,10 +766,10 @@ def stop_tone(self): self._sample = None self._enable_speaker(enable=False) - def play_file(self, file_name): + def play_file(self, file_name: str) -> None: """Play a .wav file using the onboard speaker. - :param file_name: The name of your .wav file in quotation marks including .wav + :param str file_name: The name of your .wav file in quotation marks including .wav """ # Play a specified file. @@ -769,12 +791,12 @@ class KeyStates: :param scanner: a `keypad` scanner, such as `keypad.Keys` """ - def __init__(self, scanner): + def __init__(self, scanner: Union[Keys, ShiftRegisterKeys]) -> None: self._scanner = scanner self._pressed = [False] * self._scanner.key_count self.update() - def update(self): + def update(self) -> None: """Update key information based on pending scanner events.""" # If the event queue overflowed, discard any pending events, @@ -795,12 +817,12 @@ def update(self): if event.pressed: self._was_pressed[event.key_number] = True - def was_pressed(self, key_number): + def was_pressed(self, key_number: int) -> bool: """True if key was down at any time since the last `update()`, even if it was later released. """ return self._was_pressed[key_number] - def pressed(self, key_number): + def pressed(self, key_number: int) -> bool: """True if key is currently pressed, as of the last `update()`.""" return self._pressed[key_number] diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index 784a290..faf5ca0 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -35,6 +35,11 @@ import adafruit_lis3dh from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +try: + from typing import Type, Tuple +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -47,7 +52,7 @@ class PyGamer(PyBadgerBase): _audio_out = audioio.AudioOut _neopixel_count = 5 - def __init__(self): + def __init__(self) -> None: super().__init__() i2c = board.I2C() @@ -80,7 +85,7 @@ def __init__(self): self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self): + def button(self) -> Type[tuple]: """The buttons on the board. Example use: @@ -117,7 +122,7 @@ def button(self): ) @property - def joystick(self): + def joystick(self) -> Tuple[int, int]: """The joystick on the PyGamer.""" x = self._pygamer_joystick_x.value y = self._pygamer_joystick_y.value diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 556fcbd..83e9604 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -40,7 +40,7 @@ class PyPortal(PyBadgerBase): _audio_out = audioio.AudioOut _neopixel_count = 1 - def __init__(self): + def __init__(self) -> None: super().__init__() # NeoPixels From 756048d5b89470347aaab7f573421a4c3723824d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sat, 19 Feb 2022 22:13:55 -0500 Subject: [PATCH 19/76] Linted and reformatted --- adafruit_pybadger/pybadger_base.py | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 3567286..5cd5abf 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -56,8 +56,8 @@ try: from typing import Union, Tuple, Optional, Generator - from adafruit_bitmap_font.bdf import BDF - from adafruit_bitmap_font.pcf import PCF + from adafruit_bitmap_font.bdf import BDF # pylint: disable=ungrouped-imports + from adafruit_bitmap_font.pcf import PCF # pylint: disable=ungrouped-imports from fontio import BuiltinFont from keypad import Keys, ShiftRegisterKeys from neopixel import NeoPixel @@ -193,13 +193,15 @@ def badge_background( """Create a customisable badge background made up of a background color with a rectangle color block over it. Defaults are for ``show_badge``. - :param tuple background_color: The color to fill the entire screen as a background, as RGB values. - :param tuple rectangle_color: The color of a rectangle that displays over the background, as RGB values. + :param tuple background_color: The color to fill the entire screen as a background, as + RGB values. + :param tuple rectangle_color: The color of a rectangle that displays over the background, + as RGB values. :param float rectangle_drop: The distance from the top of the display to begin displaying the rectangle. Float represents a percentage of the display, e.g. 0.4 = 40% of the display. Defaults to ``0.4``. - :param float rectangle_height: The height of the rectangle. Float represents a percentage of - the display, e.g. 0.5 = 50% of the display. Defaults to + :param float rectangle_height: The height of the rectangle. Float represents a percentage + of the display, e.g. 0.5 = 50% of the display. Defaults to ``0.5``. .. code-block:: python @@ -282,8 +284,8 @@ def badge_line( :param tuple color: The color of the line of text. Defaults to ``(0, 0, 0)``. :param int scale: The scale of the text. Must be an integer 1 or higher. Defaults to ``1``. :param font: The font used for displaying the text. Defaults to ``terminalio.FONT``. - :param bool left_justify: Left-justify the line of text. Defaults to ``False`` which centers the - font on the display. + :param bool left_justify: Left-justify the line of text. Defaults to ``False`` which centers + the font on the display. :param int padding_above: Add padding above the displayed line of text. A ``padding_above`` of ``1`` is equivalent to the height of one line of text, ``2`` is equivalent to the height of two lines of text, etc. Defaults @@ -485,7 +487,8 @@ def show_business_card( :param int name_scale: The scale of ``name_string``. Defaults to 1. :param name_font: The font for the name string. Defaults to ``terminalio.FONT``. :type name_font: ~BuiltinFont|~BDF|~PCF - :param int font_background_color: The color of the font background, default is None (transparent) + :param int font_background_color: The color of the font background, default is None + (transparent) :param int font_color: The font color, default is white :param str email_string_one: A string to display along the bottom of the display, e.g. ``"blinka@adafruit.com"``. From 3e822c34619f49d1ae2fbfcd0f99efb40abe31e0 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 20/76] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 43d1385..29230db 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 3ec03ecb0acda32fc505ea958158554c73e6f93c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 29 Mar 2022 18:16:31 -0400 Subject: [PATCH 21/76] "Reformatted per new black version" --- adafruit_pybadger/pybadger_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 5cd5abf..bd5c7ed 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -707,8 +707,8 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: @staticmethod def _sine_sample(length: int) -> Generator[int, None, None]: - tone_volume = (2 ** 15) - 1 - shift = 2 ** 15 + tone_volume = (2**15) - 1 + shift = 2**15 for i in range(length): yield int(tone_volume * math.sin(2 * math.pi * (i / length)) + shift) From de8add09637844e0af7f2890f1cda723ab49ff79 Mon Sep 17 00:00:00 2001 From: Eva Herrada <33632497+evaherrada@users.noreply.github.com> Date: Thu, 21 Apr 2022 18:53:10 -0400 Subject: [PATCH 22/76] Update .gitignore --- .gitignore | 49 ++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 40 insertions(+), 9 deletions(-) diff --git a/.gitignore b/.gitignore index 39dd71b..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea -.vscode + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From 5dc4b3f8da6f3fb3ab11b4cb5c0d9b2dac17f5a3 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:10 -0400 Subject: [PATCH 23/76] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4435493..86d700f 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/pybadger/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From b5c03fa79cb0fc35e3d82abb1bdb9441fcb82f3d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 14:05:44 -0500 Subject: [PATCH 24/76] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 86d700f..7bd2813 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/pybadger/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 39d3f9c4b94aba542e62f77c220414a140fdacdf Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 13:51:20 -0500 Subject: [PATCH 25/76] Allow padding to be a float padding_above is in "lines of text" units, so being able to position by 0.3 e.g., is useful to get a desired layout. --- adafruit_pybadger/pybadger_base.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index bd5c7ed..7081cce 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -274,7 +274,7 @@ def badge_line( scale: int = 1, font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, left_justify: bool = False, - padding_above: int = 0, + padding_above: float = 0, ) -> None: """Add a line of text to the display. Designed to work with ``badge_background`` for a color-block style badge, or with ``image_background`` for a badge with a background image. @@ -331,7 +331,7 @@ def badge_line( trim_padding = 0 if font is terminalio.FONT: trim_y = 4 * scale - trim_padding = 4 * padding_above + trim_padding = round(4 * padding_above) if not padding_above: text_label.y = self._y_position + ((height // 2) * scale) - trim_y @@ -342,14 +342,14 @@ def badge_line( self._y_position += height * scale + 4 else: - text_label.y = ( + text_label.y = round( self._y_position + (((height // 2) * scale) - trim_y) + ((height * padding_above) - trim_padding) ) if font is terminalio.FONT: - self._y_position += (height * scale - trim_y) + ( + self._y_position += (height * scale - trim_y) + round( (height * padding_above) - trim_padding ) else: From 0237d6658583206c26d18ce822f3df7ae402a1b1 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 13:51:37 -0500 Subject: [PATCH 26/76] use bitmap text in most cases this is more performant and can also use less RAM --- adafruit_pybadger/pybadger_base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 7081cce..91ffc81 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -36,7 +36,7 @@ from adafruit_bitmap_font import bitmap_font import displayio from adafruit_display_shapes.rect import Rect -from adafruit_display_text import label +from adafruit_display_text import bitmap_label as label import terminalio import adafruit_miniqr From bae8fe746e9b65314a1fbf5e5359f01efe9a463b Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 13:54:16 -0500 Subject: [PATCH 27/76] Fix dimming of display The old code would never brighten again after it went dim. Now, it will brighten on movement or when `activity()` is called from outside. --- adafruit_pybadger/pybadger_base.py | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 91ffc81..6b9894d 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -424,14 +424,17 @@ def auto_dim_display(self, delay: float = 5.0, movement_threshold: int = 10): while True: pybadger.auto_dim_display(delay=10) """ - if not self._check_for_movement(movement_threshold=movement_threshold): - current_time = time.monotonic() - if current_time - self._start_time > delay: - self.display.brightness = 0.1 - self._start_time = current_time + current_time = time.monotonic() + if self._check_for_movement(movement_threshold=movement_threshold: + self.activity(current_time) + if current_time - self._start_time > delay: + self.display.brightness = 0.1 else: self.display.brightness = self._display_brightness + def activity(self, current_time=None): + self._start_time = current_time or time.monotonic() + @property def pixels(self) -> NeoPixel: """Sequence like object representing the NeoPixels on the board.""" From d5660075eca986098090a9ce32ef89d0fdd1a1da Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 13:56:57 -0500 Subject: [PATCH 28/76] Add, use `show` method to reduce display jank This also removes 'with open(...) as ...:' because for correct functionality the OnDiskBitmap needs to retain the open file handle for as long as it exists. In particular, this fixes a problem where switching to the 'business card' view with a background image would redraw twice. Calling `show()` also acts as activity, so it'll brighten the screen. At present, this is not configurable. --- adafruit_pybadger/pybadger_base.py | 73 ++++++++++++++---------------- 1 file changed, 35 insertions(+), 38 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 6b9894d..6dc5a9b 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -161,27 +161,20 @@ def _create_badge_background(self) -> None: if self._background_group is None: self._background_group = displayio.Group() - self.display.show(self._background_group) + self.show(self._background_group) if self._background_image_filename: - with open(self._background_image_filename, "rb") as file_handle: - on_disk_bitmap = displayio.OnDiskBitmap(file_handle) - background_image = displayio.TileGrid( - on_disk_bitmap, - pixel_shader=getattr( - on_disk_bitmap, "pixel_shader", displayio.ColorConverter() - ), - # TODO: Once CP6 is no longer supported, replace the above line with below - # pixel_shader=on_disk_background.pixel_shader, - ) - self._background_group.append(background_image) - for image_label in self._lines: - self._background_group.append(image_label) - - self.display.refresh() - else: - for background_label in self._lines: - self._background_group.append(background_label) + file_handle = open(self._background_image_filename, "rb") + on_disk_bitmap = displayio.OnDiskBitmap(file_handle) + background_image = displayio.TileGrid( + on_disk_bitmap, + pixel_shader=getattr( + on_disk_bitmap, "pixel_shader", displayio.ColorConverter() + ), + ) + self._background_group.append(background_image) + for image_label in self._lines: + self._background_group.append(image_label) def badge_background( self, @@ -362,7 +355,7 @@ def show_custom_badge(self) -> None: if not self._created_background: self._create_badge_background() - self.display.show(self._background_group) + self.show(self._background_group) # pylint: disable=too-many-arguments def _create_label_group( @@ -550,22 +543,20 @@ def show_business_card( business_card_label_groups.append(email_two_group) business_card_splash = displayio.Group() - self.display.show(business_card_splash) - with open(image_name, "rb") as file_name: - on_disk_bitmap = displayio.OnDiskBitmap(file_name) - face_image = displayio.TileGrid( - on_disk_bitmap, - pixel_shader=getattr( - on_disk_bitmap, "pixel_shader", displayio.ColorConverter() - ), - # TODO: Once CP6 is no longer supported, replace the above line with below - # pixel_shader=on_disk_bitmap.pixel_shader, - ) - business_card_splash.append(face_image) - for group in business_card_label_groups: - business_card_splash.append(group) - - self.display.refresh() + image_file = open(image_name, "rb") + on_disk_bitmap = displayio.OnDiskBitmap(image_file) + face_image = displayio.TileGrid( + on_disk_bitmap, + pixel_shader=getattr( + on_disk_bitmap, "pixel_shader", displayio.ColorConverter() + ), + # TODO: Once CP6 is no longer supported, replace the above line with below + # pixel_shader=on_disk_bitmap.pixel_shader, + ) + business_card_splash.append(face_image) + for group in business_card_label_groups: + business_card_splash.append(group) + self.show(business_card_splash) # pylint: disable=too-many-locals def show_badge( @@ -650,11 +641,17 @@ def show_badge( group.append(hello_group) group.append(my_name_is_group) group.append(name_group) + self.show(group) + + def show(self, group) -> None: self.display.show(group) + self.auto_refresh = False + self.display.refresh() + self.activity() def show_terminal(self) -> None: """Revert to terminalio screen.""" - self.display.show(None) + self.show(None) @staticmethod def bitmap_qr(matrix: adafruit_miniqr.QRBitMatrix) -> displayio.Bitmap: @@ -706,7 +703,7 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: ) qr_code = displayio.Group(scale=qr_code_scale) qr_code.append(qr_img) - self.display.show(qr_code) + self.show(qr_code) @staticmethod def _sine_sample(length: int) -> Generator[int, None, None]: From eb31a88b0b6a35bea0eb7a933e048cb842401eb7 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:04:39 -0500 Subject: [PATCH 29/76] remove circuitpython6 compatibility code --- adafruit_pybadger/pybadger_base.py | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 6dc5a9b..873947d 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -168,9 +168,7 @@ def _create_badge_background(self) -> None: on_disk_bitmap = displayio.OnDiskBitmap(file_handle) background_image = displayio.TileGrid( on_disk_bitmap, - pixel_shader=getattr( - on_disk_bitmap, "pixel_shader", displayio.ColorConverter() - ), + pixel_shader=on_disk_bitmap.pixel_shader, ) self._background_group.append(background_image) for image_label in self._lines: @@ -546,12 +544,7 @@ def show_business_card( image_file = open(image_name, "rb") on_disk_bitmap = displayio.OnDiskBitmap(image_file) face_image = displayio.TileGrid( - on_disk_bitmap, - pixel_shader=getattr( - on_disk_bitmap, "pixel_shader", displayio.ColorConverter() - ), - # TODO: Once CP6 is no longer supported, replace the above line with below - # pixel_shader=on_disk_bitmap.pixel_shader, + on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader ) business_card_splash.append(face_image) for group in business_card_label_groups: From cd3f9a8f62d7ce49c81b1ba1f539307da1617b7a Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:07:23 -0500 Subject: [PATCH 30/76] fix movement check call --- adafruit_pybadger/pybadger_base.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 873947d..e20890a 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -164,7 +164,9 @@ def _create_badge_background(self) -> None: self.show(self._background_group) if self._background_image_filename: - file_handle = open(self._background_image_filename, "rb") + file_handle = open( # pylint: disable=consider-using-with + self._background_image_filename, "rb" + ) on_disk_bitmap = displayio.OnDiskBitmap(file_handle) background_image = displayio.TileGrid( on_disk_bitmap, @@ -416,7 +418,7 @@ def auto_dim_display(self, delay: float = 5.0, movement_threshold: int = 10): pybadger.auto_dim_display(delay=10) """ current_time = time.monotonic() - if self._check_for_movement(movement_threshold=movement_threshold: + if self._check_for_movement(movement_threshold=movement_threshold): self.activity(current_time) if current_time - self._start_time > delay: self.display.brightness = 0.1 @@ -541,7 +543,7 @@ def show_business_card( business_card_label_groups.append(email_two_group) business_card_splash = displayio.Group() - image_file = open(image_name, "rb") + image_file = open(image_name, "rb") # pylint: disable=consider-using-with on_disk_bitmap = displayio.OnDiskBitmap(image_file) face_image = displayio.TileGrid( on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader From 998e0f988c26bcad2427f791f9129a36d2a8662f Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:10:01 -0500 Subject: [PATCH 31/76] make it OK to call acceleration() if no accelerometer; fix return type --- adafruit_pybadger/pybadger_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index e20890a..543d8a2 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -439,12 +439,12 @@ def light(self) -> bool: return self._light_sensor.value @property - def acceleration(self) -> Union[LSM6DS33, LIS3DH_I2C]: + def acceleration(self) -> Tuple[int, int, int]: """Accelerometer data, +/- 2G sensitivity.""" return ( self._accelerometer.acceleration if self._accelerometer is not None - else None + else (0, 0, 0) ) @property From d2df1ef3be8646d47ea9699c9233e9012c8ceb6e Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:13:02 -0500 Subject: [PATCH 32/76] use annotations and TYPE_CHECKING .. and eliminate imports no longer used since the change to the acceleration property --- adafruit_pybadger/pybadger_base.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 543d8a2..2411b28 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -27,6 +27,9 @@ """ +from __future__ import annotations + + import time import array import math @@ -55,16 +58,17 @@ pass try: + from typing import TYPE_CHECKING +except ImportError: + TYPE_CHECKING = const(0) + +if TYPE_CHECKING: from typing import Union, Tuple, Optional, Generator from adafruit_bitmap_font.bdf import BDF # pylint: disable=ungrouped-imports from adafruit_bitmap_font.pcf import PCF # pylint: disable=ungrouped-imports from fontio import BuiltinFont from keypad import Keys, ShiftRegisterKeys from neopixel import NeoPixel - from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 - from adafruit_lis3dh import LIS3DH_I2C -except ImportError: - pass __version__ = "0.0.0-auto.0" From c8cbc432f55d883b6b19a056e198a9c8af79fdab Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:13:55 -0500 Subject: [PATCH 33/76] changes made by black via pre-commit --- adafruit_pybadger/pybadger_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 2411b28..23c14c8 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -476,7 +476,7 @@ def show_business_card( email_font_one: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, email_string_two: Optional[str] = None, email_scale_two: int = 1, - email_font_two: Union[BuiltinFont, BDF, PCF] = terminalio.FONT + email_font_two: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, ) -> None: """Display a bitmap image and a text string, such as a personal image and email address. @@ -573,7 +573,7 @@ def show_badge( my_name_is_string: str = "MY NAME IS", name_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, name_scale: int = 1, - name_string: str = "Blinka" + name_string: str = "Blinka", ) -> None: """Create a "Hello My Name is"-style badge. From e1f96af4d69adcb6057c6f3bb27dc9dc9e9eae1e Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:14:16 -0500 Subject: [PATCH 34/76] fix use of auto_refresh property during display update --- adafruit_pybadger/pybadger_base.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 23c14c8..b72cf08 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -643,10 +643,12 @@ def show_badge( self.show(group) def show(self, group) -> None: + """Show the given group, refreshing the screen immediately""" + self.activity() + self.display.auto_refresh = False self.display.show(group) - self.auto_refresh = False self.display.refresh() - self.activity() + self.display.auto_refresh = True def show_terminal(self) -> None: """Revert to terminalio screen.""" From 4a23749b6df562e46fcf049efe823bd45c8be170 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:14:38 -0500 Subject: [PATCH 35/76] fix activity() to immediately un-dim screen --- adafruit_pybadger/pybadger_base.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index b72cf08..01b8e7f 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -430,6 +430,10 @@ def auto_dim_display(self, delay: float = 5.0, movement_threshold: int = 10): self.display.brightness = self._display_brightness def activity(self, current_time=None): + """Turn postpone dimming of the screen""" + if not hasattr(self.display, "brightness"): + return + self.display.brightness = self._display_brightness self._start_time = current_time or time.monotonic() @property From ee4d7dfcaaaa6b23df3e268eb2a6971a109dfd58 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 14:14:59 -0500 Subject: [PATCH 36/76] make it OK to call auto_dim_display if brightness is not settable --- adafruit_pybadger/pybadger_base.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 01b8e7f..c7d280c 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -421,6 +421,8 @@ def auto_dim_display(self, delay: float = 5.0, movement_threshold: int = 10): while True: pybadger.auto_dim_display(delay=10) """ + if not hasattr(self.display, "brightness"): + return current_time = time.monotonic() if self._check_for_movement(movement_threshold=movement_threshold): self.activity(current_time) From d15c90b87e7e0d34a5e381f5c262c643443f8c0e Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Tue, 26 Apr 2022 15:15:10 -0500 Subject: [PATCH 37/76] Add an asyncio example with a fancy precomputed qr code --- examples/QR_Blinka_CircuitPythonOrg.bmp | Bin 0 -> 38470 bytes .../QR_Blinka_CircuitPythonOrg.bmp.license | 3 + examples/pybadger_pygamer_asyncio.py | 88 ++++++++++++++++++ 3 files changed, 91 insertions(+) create mode 100644 examples/QR_Blinka_CircuitPythonOrg.bmp create mode 100644 examples/QR_Blinka_CircuitPythonOrg.bmp.license create mode 100644 examples/pybadger_pygamer_asyncio.py diff --git a/examples/QR_Blinka_CircuitPythonOrg.bmp b/examples/QR_Blinka_CircuitPythonOrg.bmp new file mode 100644 index 0000000000000000000000000000000000000000..84d9e1195975e24d7c9e04170f76703e53077843 GIT binary patch literal 38470 zcmeHQ4^R|WntxZDKW@+j#B65E-MUHc$PN`HGolGpxGEr+bub7GNgV^pRR&OZWQh!% ziL7|FuA?zZvJ9DUV!%qWqJf00jE*Z@^sK8pqQoO&+zDuEAeF0QJjsrjGP4!0?%nt1 z(e&%->82TG0=RS+-Cuw2d*A!sZ{FAMf0LQ>R3i!;Pr)?>{@#Yat?>6(C>H$y?g+x; zW9T1w3><$(X!ve~{(Afo&mR#*;I!Y=*XY{PA)FCaf14}Y?rYBl$4Rj^AmX?TBasx4E)wMNS9CPDcY=$>DU6=lMe|0;?1Kr!YQjh_%re zv9`kowQ=X=Fdi-WtQq4^w;^<`h^xC+gwUtk=5bMvfTkzD<+ML-gd_@%i2|4X*bMP8XmaX&4;xy8541s zkZ~=lId*eF!xPVczR&Kh9B57161A4C7?H@~*W||dv8R(aVN7z4P=h7Mh|q-rgBKx# z*Wkr?@s}^{#F(H5p>QRVn>mCkO$`>xA+Z89y^hQ9@)I%>e3}-2y;-y^0ik|K3n63X zkbKsr74nsaJ>^x2aaMYwI&OK+XF8JOON7$3EMs*#H_UnAFK`;Xacx2|lysv>zSr(>ZOz?v%ls|-kwzED+ytPb&@!mcA_G5hSJC~ls_`@@~XA#Ohd+%BB z_k9&dFXZ7^>ONSB?X}(t{ z{zReu9E?qs#joA6Unq4Bi#z9<#mpj%90>zD(!UKa!CL@613-A$|IR=N@?|T74_Mtt56y ztN+xJ){$k<|B`=O)xFBO%6Wgc z%lU`W-OOn z&m?aBZ{3LI9s{X&q&`eIg=w!nw6Zl+uBOk^Wqt#_U~+uZtjnZSs4I&Ni=31%#9lhI zDI0p%DTj0jU2j|aHpYMN*bk#-k2e>>^@;V(3F7*f;D<4-omcigkpn({y%YT1;O&Gu z^t-YZUlN+U0TvH#J%n*wfR4NV$9FN_khe?AdM@L?P`{r|Y;q$cSQa^|J)bXidRu$G zyk03zEQ&N9D?>TAJlBeTpk3C~Rr`*e!;+JwidPfzPiyLl6wc&uZSSRmz#z-l;yd_;SiA1{LKk3N^44Cl*DTDl5a=fl%U} zOM@8Sd^fHQp-p@8uhaUM)WwEQw%#Q5uT3NPotv|63 z8-OE1`R_g)M>Pm~+Vlu*SI8M}X}I?x-0e=8bo_i%d|SC-R! zRk!g4EActng7%J`2`VcVuRbP~maw3!#3!xe9IJV8QDIhBT0<8%9OwPfzZ_dz8VfZE z4TW}ioBpt&8~Q>seMoU)QKZ(fGQ7P`$5VO7-nqZPQPf~rma#jpazMbZbAU&I$1x^# zx3j!WW_j5)>%<8mWV+-B%|1SFX@3Y)r=egh=y%?pixt4YkP>EmsQ#=YC!?N;(z zK1~)Isl8N+l@a1)X)3|XApg+H?a@~p1$x*zj8NzB&2EH}p@%1U+;Stvq`yI0$gSxJ z?b08D8kukqvS~hsdVIOD(nP#iY6Hu$1!BDd^ATiBnAW_}seehTO)7pNY8{IcYcI>^ zk)!t(-`@N-J@v*)Q(0_9NsXha_VP2`S-*O^`0t8W-CxWxt+vhFL)z<2k2Q~7&=2Rq zsUKeTzWc4s7jnkwap!=20OS7Q&)-03F zL-|7@pA97^jTv1IwM#h-d70CG|EV?EkJK!_x*>h7~}Y^CRx4&{1^+NI_y zXUp%atCC+XUu1kzo5$C|UTFO`iSV;5H@0fVOwNh+%B7-J1@Hv*snzPN*;@8d!llk& z{8-FbTF#P4@>xWdDD<&eIb~YTIu1rBUM?UWTK6{b$GCt$jvaL}{!3cOhqcRLq?({g z>RBSs(?qf`D}EDlB1(r^U{2Neu|!rE=%@;NyiVAkz?~AMX|8w&IgxgG+1IX zp2}PNW%b~({^RG4pZnv1mkKVDapm#TZa$(rOX}+h4og|hR%jCg2S)hGK~s^Vr8Y#9 z)98A=I-2@1UfFu*gB!KiQg+4`RChJ+Z|-XDa%{_~O(1Q+36uce!`jUzijo|Tq;E$K zsl9T1sbpk0{QTP$&nHD1h55IsrzXuEto-cp!Fmxb`e6pf1^oq3le)T}-6`(d=5o8B zrY?i=d!e<=*3s0j<#3YY^S(Uwd??4D>G4-(*~o;p`245tGA5ldTqol&oVWi%m35-@ zK{>RWH)!vxZR$JW;%r9@J7dr3lQ<}!K^`rKlN>)XwoA3Jvu|I)?>?PFt?fhjwbHwP z0j-$8NP^W{wS&d4!P2YGDIW?LLRQFDly6A%>d&Xc7`@p!(F5jx@zD3_vkcu?hI+gk7!SfZ{eJ5P^ z)h;aElbWT06UGyij?k$_gR6G_Ez)T>x_Z(dy}-dpOx$4dMNQcywjXR+nBh$w3X$YN z|1D2SkK6UY>C5if(Z^Lg|0Z}7$(G=Wd?r~RVMAG(m!P{De`9klN2`DT5e=vP3$nB84S_cxv}E3C;78p9@4-dJ^@-7(wUEohRQYP> z-*}&8^#}Wi7(do)q%`5Y*?|xlOCWPe{b$%(7~@LQ&k|``(zvV*EKMcluB>F_Xtnci zYEl&AH+hT}Uv~Z@_4%X~Nb2BMMXf;dIsM#N+yZE`fikw|V?y(SOV1R7v0Ca%rN zv|t)6Nk(t#Y?wI`fUhIvAyO7r}Of`%K?i z^r|#|sz(1*-+x5sEst)+Z+AHQtNUHfXRE~?oM-wEtxKmOBxSPkPHI~g=e1+yV%Q)hQ8kRLxi;9dYL9q7~Kd5)~aCq?H{#!lM3 zoOmt?YGb?ErXjl=XYWDFjQFZ#E$czbe!)tz8d*NC0oMG$j0P!vwEmsA!isV>E~WWc zLI}%|(rhdtPGl(Y_$hsgjAr#(hVc9Oy(yx)W1=OP#NGMea|-LS)u%H1CBu9Fk$k<` zQKkvZ7){{D_eJdH9&KaP_8v?h(<>hS{d~(aoi`2f8XiCDL9A_rb2`MR7nMP1>BxJq zyMg#Gt$!!{7w{zellhvL^-Wg4lvXb(jXM<%Lj2yaEzp~vN=&INkDoLI-6 zY_Dj8S})_ioM+l-cp#!PtMXP%J>>OjaosCl2H6nSJ6Kwpz7YDq-y-xp2nZaOCc6NH z`d945@9D&2sjLQ?qLd@GBs!e5k zOS?X%cqnwlS;Y09igy2_JERAb?*}|xx?3B%{)KwjGMc_Ad-k_s4*He*>a34QX;KjQ z`h$jsDjJQWUwljXWYzEqXqWU=FN3cJ9MO?kUD9S@J(toL=bC;2wX<-@>6co?O0u+| zD-x8)U(;u;`wG^ZOivq+pS+fun;P(7kKgGSNqsNXlDbj1N7trbWQ4L8v_6Ax|B*Xc z(GlMwuXW}^$k_8|&ASaG=a%g0j$f(CN6ObHMw36XY~8!{-kLnvyB|PK0XvH0My*ve z4x=WeXv=u~jV>eX??Wi3ywSCEXtMOwdxun#*ZpS4*S|uj6!t=6yi5P;3;cQvf|9t+ zEO1D@yhq1t5bko`!t&)U5%h#hH9&jsjt2>T%SzoYz84a%w#no9PZ_hbG;R8Iu!Dn? zJGcl0j#DAR*^5!FL7v=gxh$%-AE$pw) z%B^gDII&%CCGR=0x0033@T~*c+LyGVEsKoji=zJvv-VC-`?ehz-xqceR>vENM&6<@28k|xl>y9G(;M2&3udJV<|KUODAUCAC^UK)$F zJW}*6&vbWrit%IZYR_M-Av@WUj5f^?_$q?SHoqG}fE$<2bUCgY|OD*Xgs*e<@}|xY0#= zZteMvt|1jLvi`!-Y*f}?2wm6%>onl&1f(YAcMA%hTMvG^WEm~H=YEJ#)y@^rhg=s} zCrQdF@%r8rx+hDTqLia#2^$s}dSxrMoLqy~EJh{;jIVfJF^rPlEq^lpTV?L7sy*@Y zvfnH~XnkVU-~99+Fn*@>=Z61DS;tM(DVB}eM`3(nHXgc6OLn(=yYH5#qTHB0JqzhC zA=NR2<692FdiwYD*U}fkj^2s=&46Q-*=PE~{l)q>mgcTK;BNl#|4w6kblds#K+Ad@ z=Sui0)@=PYYfd@e>+qja-v7aR3Z+@32uF+`D^KRh--O=o!qU~Ss_MVAS7A^6xNn*t z{+ z{7rZNhZsLOo3{H3`#!9GIPn~54Z^wH*ipjve&SnR9tpQX?>BE2dN0kb_$rs@ z$n(kXc7%Lg2fj>{%U!Q(bUioH;_G&Eb^l3rdoX9O{?+W+)^;X%OlRhj^%p6&tiQ05 zEFa@0H}PetBVgt?&-5XTUtOrmEn&Z?Lwr0Y10i8&s8|C@ndQi(#mY#novWO*k(#~* znditCZ{S^5W#&wICXQ|Q!A`;6l!U-nmS=AsBQ<|Xa;Wb8$70d#UX!_73tt%{xUr`> z&or8TSi2_Eq~hBQtj6z~RzH8qdO>JfjGxq-Xx_y9w2=y^ZTILtNhe>PB;VFZG7{RW z|2UQX?hPAD4kM`y}_4AkN@d!t9JJh}YQzu+0JxhmXV{I#!r|{-4S&xwO5th%=QcKuSN>dq@ugsB# zO5;k?jVx#S^OupeXKrYty%7FNb_KPBz1Ae$_ut$=Dzud}&-@kRSlDSBT2h%yVuiww z^&?g@OH<8iBv~2O9#)$gnvFX>THFi4SZ@n|7kViCrf1!J?0E#jMS%4qsSdeN%9mbQ z4RUc=neU4};bPD4E7jX49lqw6?A;}nQ+lG6qTFE9pEb_k_+5gMc@&7?jUO#Wa zt}?oUQuuP&MR8jXD1nY2;fDjG7=whckAm!9&L zvNlqhy{gZLdaIB#-Z)*Sls&WdUY-Ih8#+LJ0mM@nMt4*Lor5mh4 zjZAPHHP2Kpf0d7+CVe$B@+pKLq9$E6GT~SdJpU%AgQlThKOj+xYaSf9F>o(7XKlgPF8(vRuxjZQ``UUw<%J9&gw1;P>Bj z)*sxi7|rJ^dI+c;KaHLRb6d08@zc4T%jj9JcKkGY7R+tUYR6CKb}pl5z1s29=vgqg XHLD#zo!hyLruFK^PortUT+#jiNDDTP literal 0 HcmV?d00001 diff --git a/examples/QR_Blinka_CircuitPythonOrg.bmp.license b/examples/QR_Blinka_CircuitPythonOrg.bmp.license new file mode 100644 index 0000000..1a8072c --- /dev/null +++ b/examples/QR_Blinka_CircuitPythonOrg.bmp.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: CC-BY-SA-4.0 diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py new file mode 100644 index 0000000..3433207 --- /dev/null +++ b/examples/pybadger_pygamer_asyncio.py @@ -0,0 +1,88 @@ +# SPDX-FileCopyrightText: 2022 Jeff Epler for Adafruit Industries +# SPDX-License-Identifier: MIT + +# pylint: disable=consider-using-with + +import asyncio +from displayio import TileGrid, OnDiskBitmap, Group +from rainbowio import colorwheel +from adafruit_pybadger import pybadger + +# If you choose to enter a pronoun it's shown on the "business card" page +pronoun = "" +custom_line1 = "FIRST" +custom_line2 = "LAST" # also a great place to show a pronoun + +# Set up the custom image +qr_image = OnDiskBitmap(open("/QR_Blinka_CircuitPythonOrg.bmp", "rb")) +qr_tg = TileGrid(qr_image, pixel_shader=qr_image.pixel_shader) +qr_gp = Group() +qr_gp.append(qr_tg) + +pybadger.badge_background( + background_color=pybadger.WHITE, + rectangle_color=pybadger.PURPLE, + rectangle_drop=0.25, + rectangle_height=0.55, +) + +pybadger.badge_line( + text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1 +) +pybadger.badge_line(text=custom_line1, color=pybadger.WHITE, scale=6, padding_above=1) +pybadger.badge_line( + text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25 +) + +# Start with the custom badge page +pybadger.show_custom_badge() + +# This task responds to buttons and changes the visible page +async def ui_task(): + while True: + if pybadger.button.a: + pybadger.show_business_card( + image_name="Blinka.bmp", + name_string="Jeff Epler", + name_scale=2, + email_string_one="jeff@adafruit.com", + email_string_two=pronoun, + ) + elif pybadger.button.b: + pybadger.show(qr_gp) + elif pybadger.button.start: + pybadger.show_custom_badge() + elif pybadger.button.select: + pybadger.activity() + else: + pybadger.auto_dim_display( + delay=0.5 + ) # Remove or comment out this line if you have the PyBadge LC + await asyncio.sleep(0.02) + + +# This task animates the LEDs +async def led_task(): + pixels = pybadger.pixels + pixels.auto_write = False + num_pixels = len(pixels) + j = 0 + while True: + bright = pybadger.display.brightness > 0.5 + j = (j + (7 if bright else 3)) & 255 + b = 31 / 255.0 if bright else 5 / 255.0 + if pixels.brightness != b: + pixels.brightness = b + for i in range(num_pixels): + rc_index = i * 97 + j + pixels[i] = colorwheel(rc_index & 255) + pixels.show() + await asyncio.sleep(0.02) + + +# Run both tasks via asyncio! +async def main(): + await asyncio.gather(ui_task(), led_task()) + + +asyncio.run(main()) From a62d6756efbf41b9f3a0b213efdef24bdc7865f8 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:48:53 -0400 Subject: [PATCH 38/76] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 29230db..0a91a11 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string,duplicate-code exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From ea29c45ad44d33ecb7500b9409aab6be17e5b48e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 39/76] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index cfd1c41..f006a4a 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 57c4d700f1694becb6656759d4bf079f9fb29b9c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 40/76] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index f006a4a..f772971 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From 5222e19869dd788ce468d20788e50c2a2843d01e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 41/76] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index f541e09..19f2771 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -75,7 +75,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. From fad6b605e624410ffd892ddf2824d59d8eb2bc52 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:50 -0400 Subject: [PATCH 42/76] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 5ce0d37..817fe4a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From be01f4235543c71f777cd5f00e007605ab4bf149 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Jul 2022 14:34:32 -0400 Subject: [PATCH 43/76] Prepared for adding to PyPI --- setup.py | 59 +++++++++++++++++++++++++++++++++++++++++++++++ setup.py.disabled | 7 ------ 2 files changed, 59 insertions(+), 7 deletions(-) create mode 100644 setup.py delete mode 100644 setup.py.disabled diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..d5ffeb7 --- /dev/null +++ b/setup.py @@ -0,0 +1,59 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +# Always prefer setuptools over distutils +from setuptools import setup, find_packages + +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, "README.rst"), encoding="utf-8") as f: + long_description = f.read() + +setup( + name="adafruit-circuitpython-pybadger", + use_scm_version=True, + setup_requires=["setuptools_scm"], + description="Badge-focused CircuitPython helper library for PyBadge, " + "PyBadge LC, PyGamer and CLUE", + long_description=long_description, + long_description_content_type="text/x-rst", + # The project's main homepage. + url="https://github.com/adafruit/Adafruit_CircuitPython_REPLACE", + # Author details + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=[ + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + ], + # Choose your license + license="MIT", + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + ], + # What does your project relate to? + keywords="adafruit pybadge pygamer clue display hardware micropython" + "circuitpython", + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + packages=["adafruit_pybadger"], +) diff --git a/setup.py.disabled b/setup.py.disabled deleted file mode 100644 index 79220aa..0000000 --- a/setup.py.disabled +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT -""" -This library is not deployed to PyPI. It is either a board-specific helper library, or -does not make sense for use on or is incompatible with single board computers and Linux. -""" From aea959d2e53f9b02e91f40ee7f127ee387eac909 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:12 -0400 Subject: [PATCH 44/76] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7bd2813..8d278e6 100644 --- a/README.rst +++ b/README.rst @@ -46,8 +46,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-pybadger Usage Example From 1d4aa7ce77965d1e71e78e3fd1e3eb17806b41cb Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:57 -0400 Subject: [PATCH 45/76] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 8d278e6..135e307 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag. From d4d62e35f244126482efaec4d1d4fc66663a8bb2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:55 -0400 Subject: [PATCH 46/76] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++----- .github/workflows/release.yml | 17 +++++----- optional_requirements.txt | 3 ++ pyproject.toml | 45 ++++++++++++++++++++++++++ requirements.txt | 10 +++--- setup.py | 59 ----------------------------------- 6 files changed, 73 insertions(+), 79 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..43a615b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-pybadger" +description = "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE" +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"} +keywords = [ + "adafruit", + "pybadge", + "pygamer", + "clue", + "display", + "hardware", + "micropythoncircuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_pybadger"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 6e1974a..92bd3f5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,13 +1,13 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka adafruit-circuitpython-bitmap-font -adafruit-circuitpython-display-shapes -adafruit-circuitpython-display-text -adafruit-circuitpython-gizmo -adafruit-circuitpython-lis3dh adafruit-circuitpython-lsm6ds +adafruit-circuitpython-display-text adafruit-circuitpython-miniqr adafruit-circuitpython-neopixel +adafruit-circuitpython-gizmo +adafruit-circuitpython-lis3dh +adafruit-circuitpython-display-shapes diff --git a/setup.py b/setup.py deleted file mode 100644 index d5ffeb7..0000000 --- a/setup.py +++ /dev/null @@ -1,59 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-pybadger", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Badge-focused CircuitPython helper library for PyBadge, " - "PyBadge LC, PyGamer and CLUE", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_REPLACE", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit pybadge pygamer clue display hardware micropython" - "circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - packages=["adafruit_pybadger"], -) From 3db064b67010fbd967a0b3a4110e15b02f7b60c9 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 47/76] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 43a615b..4e87ac3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 86de3352e51c48ef1a76920a2d27fdbefd68b44c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:16 -0400 Subject: [PATCH 48/76] Update version string --- adafruit_pybadger/clue.py | 2 +- adafruit_pybadger/cpb_gizmo.py | 2 +- adafruit_pybadger/magtag.py | 2 +- adafruit_pybadger/pewpewm4.py | 2 +- adafruit_pybadger/pybadge.py | 2 +- adafruit_pybadger/pybadger_base.py | 2 +- adafruit_pybadger/pygamer.py | 2 +- adafruit_pybadger/pyportal.py | 2 +- pyproject.toml | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index e49180b..02cf08f 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -33,7 +33,7 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 5d205c7..eae0f9b 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -43,7 +43,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 77415bb..d0da196 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -35,7 +35,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b c d") diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 6fa95fc..11825a7 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -36,7 +36,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", ("o", "x", "z", "right", "down", "up", "left")) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index a90b3e1..195c3f5 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -45,7 +45,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index c7d280c..10994ac 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -71,7 +71,7 @@ from neopixel import NeoPixel -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index faf5ca0..8f69e19 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -40,7 +40,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 83e9604..1345183 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -30,7 +30,7 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" diff --git a/pyproject.toml b/pyproject.toml index 4e87ac3..71f1f03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-pybadger" description = "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 86262484f8dd2bf54930056c3d5952e98e927330 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:16 -0400 Subject: [PATCH 49/76] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From f0e851185b0725b2358c4cb8d538932ff8983177 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:33 -0400 Subject: [PATCH 50/76] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 19f2771..539329b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) sys.path.insert(0, os.path.abspath("mocks")) @@ -58,7 +59,8 @@ # General information about the project. project = "Adafruit PyBadger Library" -copyright = "2019 Kattni Rembor" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for From e9331b7847823b55656c6d54f61ab4637373f199 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:22 -0400 Subject: [PATCH 51/76] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 539329b..b029445 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,8 +59,14 @@ # General information about the project. project = "Adafruit PyBadger Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Kattni Rembor" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for From a6151154ca1461474ddb44ba523eda87268d632f Mon Sep 17 00:00:00 2001 From: BlitzCityDIY Date: Tue, 13 Sep 2022 14:19:44 -0400 Subject: [PATCH 52/76] Updating padding for CLUE badge example I uploaded the example to a CLUE running CP8 and the text was not lining up as shown in the guide (https://learn.adafruit.com/clue-custom-circuit-python-badge/clue-badge). Adjusted the padding to match it and PR-ing since this code will be used for an upcoming PyLeap project. --- examples/pybadger_clue_custom_badge.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/pybadger_clue_custom_badge.py b/examples/pybadger_clue_custom_badge.py index 280555e..e322dcb 100644 --- a/examples/pybadger_clue_custom_badge.py +++ b/examples/pybadger_clue_custom_badge.py @@ -14,12 +14,12 @@ pybadger.badge_line( text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2 ) -pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) +pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=6) pybadger.badge_line( text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 ) pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=4 + text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7 ) pybadger.show_custom_badge() From af8a756286e8ccf33e712cb189ce811da2881235 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 13 Sep 2022 19:44:40 -0400 Subject: [PATCH 53/76] Update .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From d91c9a11ddf5b2d5b8b4a628be5df56e4b16f771 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:50 -0400 Subject: [PATCH 54/76] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 3324c876f7e303e268158c7a0371d07a83df33e1 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:00 -0400 Subject: [PATCH 55/76] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0a91a11..e6ddf7c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 4b364a5645ba15ce2ce679f91ce065d342218d11 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:21 -0400 Subject: [PATCH 56/76] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e6ddf7c..6996f9c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From cebe5bea189ebeaa555834155076a9938168c17f Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:46 -0400 Subject: [PATCH 57/76] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From 4d079da911aced0168b4558dcea8f15ba7fec7a3 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:33 -0400 Subject: [PATCH 58/76] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index f772971..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ From e684757d1100228217892ca0828ff62686296456 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 7 Nov 2022 22:28:58 -0500 Subject: [PATCH 59/76] Fix pylint errors --- adafruit_pybadger/pybadger_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 10994ac..0059c09 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -399,10 +399,10 @@ def _check_for_movement(self, movement_threshold: int = 10) -> bool: self._last_accelerometer = current_accelerometer return False acceleration_delta = sum( - [ + ( abs(self._last_accelerometer[n] - current_accelerometer[n]) for n in range(3) - ] + ) ) self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold From a42b3157280894f65b2aca2e6436a6a00f76dbd5 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Dec 2022 00:32:08 -0500 Subject: [PATCH 60/76] Update namedtuple type annotations --- adafruit_pybadger/clue.py | 7 +------ adafruit_pybadger/cpb_gizmo.py | 6 +----- adafruit_pybadger/magtag.py | 6 +----- adafruit_pybadger/pewpewm4.py | 6 +----- adafruit_pybadger/pybadge.py | 6 +----- adafruit_pybadger/pygamer.py | 4 ++-- 6 files changed, 7 insertions(+), 28 deletions(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 02cf08f..9b8528b 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -38,11 +38,6 @@ Buttons = namedtuple("Buttons", "a b") -try: - from typing import Type -except ImportError: - pass - class Clue(PyBadgerBase): """Class that represents a single CLUE.""" @@ -69,7 +64,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index eae0f9b..82f6c29 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -38,10 +38,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -79,7 +75,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.LIGHT) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index d0da196..46237ee 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -30,10 +30,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -55,7 +51,7 @@ def __init__(self) -> None: ) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 11825a7..c9cdf21 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -31,10 +31,6 @@ import keypad from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -68,7 +64,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index 195c3f5..dc93377 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -40,10 +40,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -105,7 +101,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index 8f69e19..bccdb76 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -36,7 +36,7 @@ from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates try: - from typing import Type, Tuple + from typing import Tuple except ImportError: pass @@ -85,7 +85,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: From 9b80c68047c96a2806b4351482ab50d2a85132e2 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 61/76] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From 813cbafff36fdbee80287de010aac11d9c0f0fca Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 62/76] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6996f9c..179cf07 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 29a33003218d110b6f9a24929a4354271e168ca1 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:42:01 -0400 Subject: [PATCH 63/76] Run pre-commit --- examples/pybadger_magtag_simpletest.py | 1 - examples/pybadger_pygamer_asyncio.py | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index 504c7c7..5c68c23 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -55,7 +55,6 @@ def try_refresh(): pybadger.pixels.fill(0x000022) while True: - cur_a = btn_a.value cur_b = btn_b.value cur_c = btn_c.value diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index 3433207..6f44731 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -37,6 +37,7 @@ # Start with the custom badge page pybadger.show_custom_badge() + # This task responds to buttons and changes the visible page async def ui_task(): while True: From b6d6cb73fd2df6c1de9e46b4a61113483f13fcf6 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 64/76] Update .pylintrc, fix jQuery for docs Signed-off-by: Tekktrik --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index b029445..fd5d21b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,6 +18,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 9f1d4fb24d7e295d4a63972efae7dfab13f19a6f Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:18:12 -0500 Subject: [PATCH 65/76] "fix rtd theme " --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fd5d21b..7ea32e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,19 +116,10 @@ # 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" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # 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, From 4fde7fb9441703568f8555e6afc1ac7187999d7a Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Mon, 25 Sep 2023 19:44:57 -0400 Subject: [PATCH 66/76] fix doc API build --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 7ea32e1..eaff827 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = [ "audioio", + "bitmaptools", "displayio", "neopixel", "analogio", From 5752d3ec4a419f1a429713a78e9236fa56700f6f Mon Sep 17 00:00:00 2001 From: RetiredWizard Date: Fri, 3 Nov 2023 17:50:57 -0400 Subject: [PATCH 67/76] Replace depreciated .show() --- adafruit_pybadger/pybadger_base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 0059c09..9c55081 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -652,7 +652,7 @@ def show(self, group) -> None: """Show the given group, refreshing the screen immediately""" self.activity() self.display.auto_refresh = False - self.display.show(group) + self.display.root_group = group self.display.refresh() self.display.auto_refresh = True From 9a6b39cd0621ef6e4ef0af35e9f01772970ed8f6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 68/76] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From af60fede3d48b72fc5465b3d72e673dafac9162b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Mar 2024 20:51:05 -0500 Subject: [PATCH 69/76] change badgerbase.show to root_group --- adafruit_pybadger/pybadger_base.py | 20 +++++++++++++------- examples/pybadger_pygamer_asyncio.py | 2 +- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 9c55081..8242bc8 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -165,7 +165,7 @@ def _create_badge_background(self) -> None: if self._background_group is None: self._background_group = displayio.Group() - self.show(self._background_group) + self.root_group = self._background_group if self._background_image_filename: file_handle = open( # pylint: disable=consider-using-with @@ -359,7 +359,7 @@ def show_custom_badge(self) -> None: if not self._created_background: self._create_badge_background() - self.show(self._background_group) + self.root_group = self._background_group # pylint: disable=too-many-arguments def _create_label_group( @@ -561,7 +561,7 @@ def show_business_card( business_card_splash.append(face_image) for group in business_card_label_groups: business_card_splash.append(group) - self.show(business_card_splash) + self.root_group = business_card_splash # pylint: disable=too-many-locals def show_badge( @@ -646,9 +646,15 @@ def show_badge( group.append(hello_group) group.append(my_name_is_group) group.append(name_group) - self.show(group) + self.root_group = group - def show(self, group) -> None: + @property + def root_group(self): + """The currently showing Group""" + return self.display.root_group + + @root_group.setter + def root_group(self, group): """Show the given group, refreshing the screen immediately""" self.activity() self.display.auto_refresh = False @@ -658,7 +664,7 @@ def show(self, group) -> None: def show_terminal(self) -> None: """Revert to terminalio screen.""" - self.show(None) + self.root_group = displayio.CIRCUITPYTHON_TERMINAL @staticmethod def bitmap_qr(matrix: adafruit_miniqr.QRBitMatrix) -> displayio.Bitmap: @@ -710,7 +716,7 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: ) qr_code = displayio.Group(scale=qr_code_scale) qr_code.append(qr_img) - self.show(qr_code) + self.root_group = qr_code @staticmethod def _sine_sample(length: int) -> Generator[int, None, None]: diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index 6f44731..d264101 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -50,7 +50,7 @@ async def ui_task(): email_string_two=pronoun, ) elif pybadger.button.b: - pybadger.show(qr_gp) + pybadger.root_group = qr_gp elif pybadger.button.start: pybadger.show_custom_badge() elif pybadger.button.select: From 0c1766e738f4c3dce7c3c494b34d26db219c4933 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 70/76] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index eaff827..6eac243 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -120,7 +120,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # 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, From 443c5ed798a2e21b833ef5387e3aa836e0cf72d6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 71/76] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 4fa8c96cc4ba453aff7dc801633b9c75b75e159e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 1 Apr 2025 09:52:52 -0500 Subject: [PATCH 72/76] attempt new accelerometer init if first one fails --- adafruit_pybadger/clue.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 9b8528b..2504086 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -30,6 +30,7 @@ import audiopwmio import keypad import adafruit_lsm6ds.lsm6ds33 +import adafruit_lsm6ds.lsm6ds3trc import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates @@ -51,7 +52,10 @@ def __init__(self) -> None: i2c = board.I2C() if i2c is not None: - self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + try: + self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + except RuntimeError: + self._accelerometer = adafruit_lsm6ds.lsm6ds3trc.LSM6DS3TRC(i2c) # NeoPixels self._neopixels = neopixel.NeoPixel( From 6043a1fa3ffef2f194e74b9faf83a9b3037714bc Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 21 May 2025 11:11:09 -0500 Subject: [PATCH 73/76] use ruff, correct homepage url in pyproject.toml --- .gitattributes | 11 ++ .pre-commit-config.yaml | 43 ++------ README.rst | 6 +- adafruit_pybadger/clue.py | 16 +-- adafruit_pybadger/cpb_gizmo.py | 19 ++-- adafruit_pybadger/magtag.py | 5 +- adafruit_pybadger/pewpewm4.py | 11 +- adafruit_pybadger/pybadge.py | 21 ++-- adafruit_pybadger/pybadger_base.py | 88 ++++++--------- adafruit_pybadger/pygamer.py | 22 ++-- adafruit_pybadger/pyportal.py | 6 +- docs/api.rst | 3 + docs/conf.py | 8 +- docs/mocks/keypad.py | 2 +- examples/pybadger_button_debouncing.py | 1 + examples/pybadger_clue_custom_badge.py | 13 +-- examples/pybadger_clue_custom_image_badge.py | 5 +- examples/pybadger_custom_badge.py | 13 +-- examples/pybadger_magtag_simpletest.py | 9 +- examples/pybadger_pewpewm4_simpletest.py | 11 +- examples/pybadger_pygamer_asyncio.py | 13 +-- examples/pybadger_pyportal_touchscreen.py | 14 +-- examples/pybadger_simpletest.py | 8 +- pyproject.toml | 2 +- ruff.toml | 108 +++++++++++++++++++ 25 files changed, 251 insertions(+), 207 deletions(-) create mode 100644 .gitattributes create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 179cf07..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +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: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string,duplicate-code - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/README.rst b/README.rst index 135e307..811883b 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/actions/ :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 Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag. diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 2504086..f99e14a 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -26,13 +26,15 @@ """ from collections import namedtuple -import board + +import adafruit_lsm6ds.lsm6ds3trc +import adafruit_lsm6ds.lsm6ds33 import audiopwmio +import board import keypad -import adafruit_lsm6ds.lsm6ds33 -import adafruit_lsm6ds.lsm6ds3trc import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates + +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -84,9 +86,7 @@ def button(self) -> Buttons: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -101,5 +101,5 @@ def _unsupported(self): light = _unsupported -clue = Clue() # pylint: disable=invalid-name +clue = Clue() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 82f6c29..dffdab7 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -27,17 +27,18 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio -import busio import audiopwmio +import board +import busio +import digitalio import keypad -from adafruit_gizmo import tft_gizmo -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_gizmo import tft_gizmo +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -91,9 +92,7 @@ def button(self) -> Buttons: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -106,5 +105,5 @@ def _unsupported(self): # NotImplementedError raised in the property above. -cpb_gizmo = CPB_Gizmo() # pylint: disable=invalid-name +cpb_gizmo = CPB_Gizmo() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 46237ee..0f3251c 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -26,10 +26,11 @@ """ from collections import namedtuple + import board import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -81,5 +82,5 @@ def _unsupported(self): button = _unsupported -magtag = MagTag() # pylint: disable=invalid-name +magtag = MagTag() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index c9cdf21..cd8f3cd 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -26,11 +26,12 @@ """ from collections import namedtuple -import board + import audioio +import board import keypad -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -80,9 +81,7 @@ def button(self) -> Buttons: print("Button O") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -106,5 +105,5 @@ def _unsupported(self): pixels = _unsupported -pewpewm4 = PewPewM4() # pylint: disable=invalid-name +pewpewm4 = PewPewM4() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index dc93377..312750a 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -31,15 +31,16 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio import audioio +import board +import digitalio import keypad -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -75,12 +76,10 @@ def __init__(self) -> None: break # PyBadge LC doesn't have accelerometer - if int(0x18) in _i2c_devices or int(0x19) in _i2c_devices: + if 0x18 in _i2c_devices or 0x19 in _i2c_devices: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -122,9 +121,7 @@ def button(self) -> Buttons: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -137,5 +134,5 @@ def button(self) -> Buttons: ) -pybadge = PyBadge() # pylint: disable=invalid-name +pybadge = PyBadge() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 8242bc8..2dd32ae 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -29,19 +29,19 @@ from __future__ import annotations - -import time import array import math +import time + +import adafruit_miniqr import board -from micropython import const import digitalio -from adafruit_bitmap_font import bitmap_font import displayio +import terminalio +from adafruit_bitmap_font import bitmap_font from adafruit_display_shapes.rect import Rect from adafruit_display_text import bitmap_label as label -import terminalio -import adafruit_miniqr +from micropython import const AUDIO_ENABLED = False try: @@ -63,9 +63,10 @@ TYPE_CHECKING = const(0) if TYPE_CHECKING: - from typing import Union, Tuple, Optional, Generator - from adafruit_bitmap_font.bdf import BDF # pylint: disable=ungrouped-imports - from adafruit_bitmap_font.pcf import PCF # pylint: disable=ungrouped-imports + from typing import Generator, Optional, Union + + from adafruit_bitmap_font.bdf import BDF + from adafruit_bitmap_font.pcf import PCF from fontio import BuiltinFont from keypad import Keys, ShiftRegisterKeys from neopixel import NeoPixel @@ -87,7 +88,6 @@ def load_font(fontname: str, text: str) -> Union[BDF, PCF]: return font -# pylint: disable=too-many-instance-attributes class PyBadgerBase: """PyBadger base class.""" @@ -168,9 +168,7 @@ def _create_badge_background(self) -> None: self.root_group = self._background_group if self._background_image_filename: - file_handle = open( # pylint: disable=consider-using-with - self._background_image_filename, "rb" - ) + file_handle = open(self._background_image_filename, "rb") on_disk_bitmap = displayio.OnDiskBitmap(file_handle) background_image = displayio.TileGrid( on_disk_bitmap, @@ -182,8 +180,8 @@ def _create_badge_background(self) -> None: def badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -219,8 +217,8 @@ def badge_background( def _badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -231,9 +229,7 @@ def _badge_background( color_palette = displayio.Palette(1) color_palette[0] = background_color - bg_sprite = displayio.TileGrid( - color_bitmap, pixel_shader=color_palette, x=0, y=0 - ) + bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) background_group.append(bg_sprite) rectangle = Rect( @@ -263,11 +259,10 @@ def image_background(self, image_name: Optional[str] = None) -> None: """ self._background_image_filename = image_name - # pylint: disable=too-many-arguments def badge_line( self, text: str = " ", - color: Tuple[int, int, int] = BLACK, + color: tuple[int, int, int] = BLACK, scale: int = 1, font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, left_justify: bool = False, @@ -361,7 +356,6 @@ def show_custom_badge(self) -> None: self.root_group = self._background_group - # pylint: disable=too-many-arguments def _create_label_group( self, text: str, @@ -399,10 +393,7 @@ def _check_for_movement(self, movement_threshold: int = 10) -> bool: self._last_accelerometer = current_accelerometer return False acceleration_delta = sum( - ( - abs(self._last_accelerometer[n] - current_accelerometer[n]) - for n in range(3) - ) + abs(self._last_accelerometer[n] - current_accelerometer[n]) for n in range(3) ) self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold @@ -449,13 +440,9 @@ def light(self) -> bool: return self._light_sensor.value @property - def acceleration(self) -> Tuple[int, int, int]: + def acceleration(self) -> tuple[int, int, int]: """Accelerometer data, +/- 2G sensitivity.""" - return ( - self._accelerometer.acceleration - if self._accelerometer is not None - else (0, 0, 0) - ) + return self._accelerometer.acceleration if self._accelerometer is not None else (0, 0, 0) @property def brightness(self) -> float: @@ -467,7 +454,6 @@ def brightness(self, value: float) -> None: self._display_brightness = value self.display.brightness = value - # pylint: disable=too-many-locals def show_business_card( self, *, @@ -553,24 +539,21 @@ def show_business_card( business_card_label_groups.append(email_two_group) business_card_splash = displayio.Group() - image_file = open(image_name, "rb") # pylint: disable=consider-using-with + image_file = open(image_name, "rb") on_disk_bitmap = displayio.OnDiskBitmap(image_file) - face_image = displayio.TileGrid( - on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader - ) + face_image = displayio.TileGrid(on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader) business_card_splash.append(face_image) for group in business_card_label_groups: business_card_splash.append(group) self.root_group = business_card_splash - # pylint: disable=too-many-locals def show_badge( self, *, - background_color: Tuple[int, int, int] = RED, - foreground_color: Tuple[int, int, int] = WHITE, - background_text_color: Tuple[int, int, int] = WHITE, - foreground_text_color: Tuple[int, int, int] = BLACK, + background_color: tuple[int, int, int] = RED, + foreground_color: tuple[int, int, int] = WHITE, + background_text_color: tuple[int, int, int] = WHITE, + foreground_text_color: tuple[int, int, int] = BLACK, hello_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, hello_scale: int = 1, hello_string: str = "HELLO", @@ -705,12 +688,8 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: self.display.width // qr_bitmap.width, self.display.height // qr_bitmap.height, ) - qr_position_x = int( - ((self.display.width / qr_code_scale) - qr_bitmap.width) / 2 - ) - qr_position_y = int( - ((self.display.height / qr_code_scale) - qr_bitmap.height) / 2 - ) + qr_position_x = int(((self.display.width / qr_code_scale) - qr_bitmap.width) / 2) + qr_position_y = int(((self.display.height / qr_code_scale) - qr_bitmap.height) / 2) qr_img = displayio.TileGrid( qr_bitmap, pixel_shader=palette, x=qr_position_x, y=qr_position_y ) @@ -730,10 +709,7 @@ def _generate_sample(self, length: int = 100) -> None: if self._sample is not None: return self._sine_wave = array.array("H", PyBadgerBase._sine_sample(length)) - # pylint: disable=not-callable - self._sample = self._audio_out( - board.SPEAKER - ) # pylint: disable=not-callable + self._sample = self._audio_out(board.SPEAKER) self._sine_wave_sample = audiocore.RawSample(self._sine_wave) else: print("Required audio modules were missing") @@ -791,10 +767,8 @@ def play_file(self, file_name: str) -> None: # Play a specified file. self.stop_tone() self._enable_speaker(enable=True) - with self._audio_out(board.SPEAKER) as audio: # pylint: disable=not-callable - wavefile = audiocore.WaveFile( - open(file_name, "rb") # pylint: disable=consider-using-with - ) + with self._audio_out(board.SPEAKER) as audio: + wavefile = audiocore.WaveFile(open(file_name, "rb")) audio.play(wavefile) while audio.playing: pass diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index bccdb76..c22d2c8 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -26,14 +26,16 @@ """ from collections import namedtuple -import board + +import adafruit_lis3dh import analogio -import digitalio import audioio -import neopixel +import board +import digitalio import keypad -import adafruit_lis3dh -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +import neopixel + +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase try: from typing import Tuple @@ -59,9 +61,7 @@ def __init__(self) -> None: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -106,9 +106,7 @@ def button(self) -> Buttons: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) x, y = self.joystick return Buttons( button_values[0], @@ -129,5 +127,5 @@ def joystick(self) -> Tuple[int, int]: return x, y -pygamer = PyGamer() # pylint: disable=invalid-name +pygamer = PyGamer() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 1345183..38790a0 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -24,10 +24,12 @@ https://github.com/adafruit/circuitpython/releases """ -import board + import analogio import audioio +import board import neopixel + from adafruit_pybadger.pybadger_base import PyBadgerBase __version__ = "0.0.0+auto.0" @@ -62,5 +64,5 @@ def _unsupported(self): auto_dim_display = _unsupported -pyportal = PyPortal() # pylint: disable=invalid-name +pyportal = PyPortal() """Object that is automatically created on import.""" diff --git a/docs/api.rst b/docs/api.rst index a50522d..8db5080 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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:: adafruit_pybadger.pybadger_base :members: diff --git a/docs/conf.py b/docs/conf.py index 6eac243..2892cc5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) sys.path.insert(0, os.path.abspath("mocks")) @@ -64,9 +62,7 @@ creation_year = "2019" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py index 5fcd12a..5226b76 100644 --- a/docs/mocks/keypad.py +++ b/docs/mocks/keypad.py @@ -26,7 +26,7 @@ def __init__( key_count, value_when_pressed, interval=0.020, - max_events=64 + max_events=64, ): self.key_count = 123 self.events = EventQueue() diff --git a/examples/pybadger_button_debouncing.py b/examples/pybadger_button_debouncing.py index 9e13756..4617dee 100644 --- a/examples/pybadger_button_debouncing.py +++ b/examples/pybadger_button_debouncing.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT from adafruit_debouncer import Debouncer + from adafruit_pybadger import pybadger b_btn = Debouncer(lambda: pybadger.button.b == 0) diff --git a/examples/pybadger_clue_custom_badge.py b/examples/pybadger_clue_custom_badge.py index e322dcb..db16e69 100644 --- a/examples/pybadger_clue_custom_badge.py +++ b/examples/pybadger_clue_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=6) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7) pybadger.show_custom_badge() diff --git a/examples/pybadger_clue_custom_image_badge.py b/examples/pybadger_clue_custom_image_badge.py index c7bab34..777831d 100644 --- a/examples/pybadger_clue_custom_image_badge.py +++ b/examples/pybadger_clue_custom_image_badge.py @@ -2,15 +2,14 @@ # SPDX-License-Identifier: MIT """Custom image badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.image_background("Blinka_CLUE.bmp") pybadger.badge_line(text="@circuitpython", color=pybadger.SKY, scale=2, padding_above=2) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) pybadger.badge_line(text="she/her", color=pybadger.SKY, scale=4, padding_above=4) while True: diff --git a/examples/pybadger_custom_badge.py b/examples/pybadger_custom_badge.py index 070c191..1ccfed7 100644 --- a/examples/pybadger_custom_badge.py +++ b/examples/pybadger_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge for PyBadge or PyGamer.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=3, padding_above=2) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2) while True: pybadger.show_custom_badge() diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index 5c68c23..a92db0f 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -2,10 +2,13 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Mag Tag. - Use the A, B, and C buttons to change between examples.""" +Use the A, B, and C buttons to change between examples.""" + import time + import board import digitalio + from adafruit_pybadger import pybadger @@ -44,9 +47,7 @@ def try_refresh(): SHOWING = "badge" -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) try_refresh() diff --git a/examples/pybadger_pewpewm4_simpletest.py b/examples/pybadger_pewpewm4_simpletest.py index 1094d42..0c71069 100644 --- a/examples/pybadger_pewpewm4_simpletest.py +++ b/examples/pybadger_pewpewm4_simpletest.py @@ -2,12 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Pew Pew M4. - Use the O, X, and Z buttons to change between examples.""" +Use the O, X, and Z buttons to change between examples.""" + from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 -) +pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) while True: if pybadger.button.o: @@ -23,6 +22,4 @@ elif pybadger.button.x: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.z: - pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index d264101..c3ac367 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2022 Jeff Epler for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=consider-using-with import asyncio -from displayio import TileGrid, OnDiskBitmap, Group + +from displayio import Group, OnDiskBitmap, TileGrid from rainbowio import colorwheel + from adafruit_pybadger import pybadger # If you choose to enter a pronoun it's shown on the "business card" page @@ -26,13 +27,9 @@ rectangle_height=0.55, ) -pybadger.badge_line( - text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1 -) +pybadger.badge_line(text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1) pybadger.badge_line(text=custom_line1, color=pybadger.WHITE, scale=6, padding_above=1) -pybadger.badge_line( - text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25 -) +pybadger.badge_line(text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25) # Start with the custom badge page pybadger.show_custom_badge() diff --git a/examples/pybadger_pyportal_touchscreen.py b/examples/pybadger_pyportal_touchscreen.py index 10ce9c4..7633b26 100644 --- a/examples/pybadger_pyportal_touchscreen.py +++ b/examples/pybadger_pyportal_touchscreen.py @@ -2,11 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using Adafruit PyPortal. Uses the touchscreen to advance between examples.""" -import board + import adafruit_touchscreen -from adafruit_pybadger import pybadger +import board -# pylint: disable=invalid-name +from adafruit_pybadger import pybadger # These pins are used as both analog and digital! XL, XR and YU must be analog # and digital capable. YD just need to be digital @@ -19,9 +19,7 @@ size=(320, 240), ) -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) cur_example = 0 prev_touch = None @@ -45,6 +43,4 @@ elif cur_example == 1: pybadger.show_qr_code(data="https://circuitpython.org") elif cur_example == 2: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) diff --git a/examples/pybadger_simpletest.py b/examples/pybadger_simpletest.py index a720208..dd3657b 100644 --- a/examples/pybadger_simpletest.py +++ b/examples/pybadger_simpletest.py @@ -3,9 +3,7 @@ from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) while True: pybadger.auto_dim_display( @@ -22,6 +20,4 @@ elif pybadger.button.b: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.start: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) diff --git a/pyproject.toml b/pyproject.toml index 71f1f03..8d4a8b1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} ] -urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"} +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger"} keywords = [ "adafruit", "pybadge", diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..b485fab --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "UP007", # x | y type annotation +] + +[format] +line-ending = "lf" From f319370927ed9d0644cf20c54a3229b25966be48 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 21 May 2025 11:13:31 -0500 Subject: [PATCH 74/76] delete pylintrc --- .pylintrc | 399 ------------------------------------------------------ 1 file changed, 399 deletions(-) delete mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception From bb6a1fd7ed61698d8732ec4dd642015db8523021 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 75/76] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" From 436015ecdc4aaabbc228d0b17f9f878145143fab Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 27 Jun 2025 13:14:36 -0500 Subject: [PATCH 76/76] use new OnDiskBitmap API --- adafruit_pybadger/pybadger_base.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 2dd32ae..67f4443 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -168,8 +168,7 @@ def _create_badge_background(self) -> None: self.root_group = self._background_group if self._background_image_filename: - file_handle = open(self._background_image_filename, "rb") - on_disk_bitmap = displayio.OnDiskBitmap(file_handle) + on_disk_bitmap = displayio.OnDiskBitmap(self._background_image_filename) background_image = displayio.TileGrid( on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader,