From 12afa4bfd6782e0cc861e7385bd73be2481521ea Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 09:55:17 -0700
Subject: [PATCH 01/14] Working on adding type annotations

---
 adafruit_avrprog.py | 71 +++++++++++++++++++++++++++++++--------------
 1 file changed, 49 insertions(+), 22 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 704a258..028d408 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -32,10 +32,19 @@
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
-from digitalio import Direction, DigitalInOut
+try:
+    from io import TextIOWrapper
+    from typing import Any, Dict, Optional
 
-_SLOW_CLOCK = 100000
-_FAST_CLOCK = 1000000
+    from _typeshed import FileDescriptorOrPath
+    from busio import SPI
+except ImportError:
+    pass
+
+from digitalio import DigitalInOut, Direction
+
+_SLOW_CLOCK: int = 100000
+_FAST_CLOCK: int = 1000000
 
 
 class AVRprog:
@@ -86,10 +95,10 @@ class Boards:
             "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F),
         }
 
-    _spi = None
-    _rst = None
+    _spi: SPI = None
+    _rst: DigitalInOut = None
 
-    def init(self, spi_bus, rst_pin):
+    def init(self, spi_bus: SPI, rst_pin) -> None:
         """
         Initialize the programmer with an SPI port that will be used to
         communicate with the chip. Make sure your SPI supports 'write_readinto'
@@ -100,7 +109,7 @@ def init(self, spi_bus, rst_pin):
         self._rst.direction = Direction.OUTPUT
         self._rst.value = True
 
-    def verify_sig(self, chip, verbose=False):
+    def verify_sig(self, chip: Dict[str, Any], verbose: bool = False) -> bool:
         """
         Verify that the chip is connected properly, responds to commands,
         and has the correct signature. Returns True/False based on success
@@ -115,7 +124,13 @@ def verify_sig(self, chip, verbose=False):
         return True
 
     # pylint: disable=too-many-branches
-    def program_file(self, chip, file_name, verbose=False, verify=True):
+    def program_file(
+        self,
+        chip: Dict[str, Any],
+        file_name: FileDescriptorOrPath,
+        verbose: bool = False,
+        verify: bool = True,
+    ) -> bool:
         """
         Perform a chip erase and program from a file that
         contains Intel HEX data. Returns true on verify-success, False on
@@ -132,10 +147,8 @@ def program_file(self, chip, file_name, verbose=False, verify=True):
         self.begin(clock=clock_speed)
 
         # create a file state dictionary
-        file_state = {"line": 0, "ext_addr": 0, "eof": False}
-        with open(file_name, "r") as file_state[  # pylint: disable=unspecified-encoding
-            "f"
-        ]:
+        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper}
+        with open(file_name, "r") as file_state["f"]:
             page_size = chip["page_size"]
 
             for page_addr in range(0, chip["flash_size"], page_size):
@@ -183,7 +196,9 @@ def program_file(self, chip, file_name, verbose=False, verify=True):
         self.end()
         return True
 
-    def verify_file(self, chip, file_name, verbose=False):
+    def verify_file(
+        self, chip: Dict[str, Any], file_name: FileDescriptorOrPath, verbose=False
+    ):
         """
         Perform a chip full-flash verification from a file that
         contains Intel HEX data. Returns True/False on success/fail.
@@ -192,10 +207,8 @@ def verify_file(self, chip, file_name, verbose=False):
             raise RuntimeError("Signature read failure")
 
         # create a file state dictionary
-        file_state = {"line": 0, "ext_addr": 0, "eof": False}
-        with open(file_name, "r") as file_name[  # pylint: disable=unspecified-encoding
-            "f"
-        ]:
+        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper}
+        with open(file_name, "r") as file_name["f"]:
             page_size = chip["page_size"]
             clock_speed = chip.get("clock_speed", _FAST_CLOCK)
             self.begin(clock=clock_speed)
@@ -230,9 +243,9 @@ def verify_file(self, chip, file_name, verbose=False):
         self.end()
         return True
 
-    def read_fuses(self, chip):
+    def read_fuses(self, chip: Dict[str, Any]) -> tuple:
         """
-        Read the 4 fuses and return them in a list (low, high, ext, lock)
+        Read the 4 fuses and return them in a tuple (low, high, ext, lock)
         Each fuse is bitwise-&'s with the chip's fuse mask for simplicity
         """
         mask = chip["fuse_mask"]
@@ -245,7 +258,14 @@ def read_fuses(self, chip):
         return (low, high, ext, lock)
 
     # pylint: disable=unused-argument,too-many-arguments
-    def write_fuses(self, chip, low=None, high=None, ext=None, lock=None):
+    def write_fuses(
+        self,
+        chip: Dict[str, Any],
+        low: Optional[int] = None,
+        high: Optional[int] = None,
+        ext: Optional[int] = None,
+        lock: Optional[int] = None,
+    ) -> None:
         """
         Write any of the 4 fuses. If the kwarg low/high/ext/lock is not
         passed in or is None, that fuse is skipped
@@ -260,7 +280,14 @@ def write_fuses(self, chip, low=None, high=None, ext=None, lock=None):
         self.end()
 
     # pylint: disable=too-many-arguments
-    def verify_fuses(self, chip, low=None, high=None, ext=None, lock=None):
+    def verify_fuses(
+        self,
+        chip: Dict[str, Any],
+        low: Optional[int] = None,
+        high: Optional[int] = None,
+        ext: Optional[int] = None,
+        lock: Optional[int] = None,
+    ) -> bool:
         """
         Verify the 4 fuses. If the kwarg low/high/ext/lock is not
         passed in or is None, that fuse is not checked.
@@ -286,7 +313,7 @@ def erase_chip(self):
 
     #################### Mid level
 
-    def begin(self, clock=_FAST_CLOCK):
+    def begin(self, clock: int = _FAST_CLOCK) -> None:
         """
         Begin programming mode: pull reset pin low, initialize SPI, and
         send the initialization command to get the AVR's attention.

From 907ab2da5613f57563f5df11083659a81e1610b8 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 09:56:43 -0700
Subject: [PATCH 02/14] Suspected bug fix where file_name was being assigned as
 textio during open operation rather than a field in file_state dictionary

---
 adafruit_avrprog.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 028d408..91f0580 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -208,7 +208,7 @@ def verify_file(
 
         # create a file state dictionary
         file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper}
-        with open(file_name, "r") as file_name["f"]:
+        with open(file_name, "r") as file_state["f"]:
             page_size = chip["page_size"]
             clock_speed = chip.get("clock_speed", _FAST_CLOCK)
             self.begin(clock=clock_speed)

From bfe4c39f7501f7fefa6ea895724247f8fbbe79e0 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 12:05:52 -0700
Subject: [PATCH 03/14] Completing type annotations

---
 adafruit_avrprog.py | 36 +++++++++++++++++++++---------------
 1 file changed, 21 insertions(+), 15 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 91f0580..b881d03 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -34,13 +34,15 @@
 
 try:
     from io import TextIOWrapper
-    from typing import Any, Dict, Optional
+    from typing import Any, Dict, Optional, Tuple
 
     from _typeshed import FileDescriptorOrPath
     from busio import SPI
 except ImportError:
     pass
 
+from math import floor
+
 from digitalio import DigitalInOut, Direction
 
 _SLOW_CLOCK: int = 100000
@@ -324,14 +326,14 @@ def begin(self, clock: int = _FAST_CLOCK) -> None:
         self._spi.configure(baudrate=clock)
         self._transaction((0xAC, 0x53, 0, 0))
 
-    def end(self):
+    def end(self) -> None:
         """
         End programming mode: SPI is released, and reset pin set high.
         """
         self._spi.unlock()
         self._rst.value = True
 
-    def read_signature(self):
+    def read_signature(self) -> list:
         """
         Read and return the signature of the chip as two bytes in an array.
         Requires calling begin() beforehand to put in programming mode.
@@ -342,7 +344,7 @@ def read_signature(self):
             sig.append(self._transaction((0x30, 0, i, 0))[2])
         return sig
 
-    def read(self, addr, read_buffer):
+    def read(self, addr: int, read_buffer: bytearray) -> None:
         """
         Read a chunk of memory from address 'addr'. The amount read is the
         same as the size of the bytearray 'read_buffer'. Data read is placed
@@ -366,13 +368,15 @@ def read(self, addr, read_buffer):
             last_addr = read_addr
 
     #################### Low level
-    def _flash_word(self, addr, low, high):
+    def _flash_word(self, addr: int, low: int, high: int) -> None:
         self._transaction((0x40, addr >> 8, addr, low))
         self._transaction((0x48, addr >> 8, addr, high))
 
-    def _flash_page(self, page_buffer, page_addr, page_size):
+    def _flash_page(
+        self, page_buffer: bytearray, page_addr: int, page_size: int
+    ) -> None:
         page_addr //= 2  # address is by 'words' not bytes!
-        for i in range(page_size / 2):  # page indexed by words, not bytes
+        for i in range(floor(page_size / 2)):  # page indexed by words, not bytes
             lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2]
             self._flash_word(i, lo_byte, hi_byte)
 
@@ -384,23 +388,25 @@ def _flash_page(self, page_buffer, page_addr, page_size):
             raise RuntimeError("Failed to commit page to flash")
         self._busy_wait()
 
-    def _transaction(self, command):
+    def _transaction(self, command: Tuple[int, int, int, int]) -> bytes:
         reply = bytearray(4)
-        command = bytearray([i & 0xFF for i in command])
+        command_bytes = bytearray([i & 0xFF for i in command])
 
-        self._spi.write_readinto(command, reply)
-        # s = [hex(i) for i in command]
-        # print("Sending %s reply %s" % ([hex(i) for i in command], [hex(i) for i in reply]))
-        if reply[2] != command[1]:
+        self._spi.write_readinto(command_bytes, reply)
+        # s = [hex(i) for i in command_bytes]
+        # print("Sending %s reply %s" % ([hex(i) for i in command_bytes], [hex(i) for i in reply]))
+        if reply[2] != command_bytes[1]:
             raise RuntimeError("SPI transaction failed")
         return reply[1:]  # first byte is ignored
 
-    def _busy_wait(self):
+    def _busy_wait(self) -> None:
         while self._transaction((0xF0, 0, 0, 0))[2] & 0x01:
             pass
 
 
-def read_hex_page(file_state, page_addr, page_size, page_buffer):
+def read_hex_page(
+    file_state: Dict[str, Any], page_addr: int, page_size: int, page_buffer: bytearray
+) -> bool:
     # pylint: disable=too-many-branches
     """
     Helper function that does the Intel Hex parsing. Takes in a dictionary

From 0b3e5f861d9f3146d149496c9b8d952efb58ebc6 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 12:15:07 -0700
Subject: [PATCH 04/14] Fixing optional import that was, actually, not
 optional.

---
 adafruit_avrprog.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index b881d03..b930689 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -37,12 +37,12 @@
     from typing import Any, Dict, Optional, Tuple
 
     from _typeshed import FileDescriptorOrPath
-    from busio import SPI
 except ImportError:
     pass
 
 from math import floor
 
+from busio import SPI
 from digitalio import DigitalInOut, Direction
 
 _SLOW_CLOCK: int = 100000

From 054823d5a6421983c5836e5cfa443c7ba7a10a1e Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 12:48:49 -0700
Subject: [PATCH 05/14] Working on optional imports

---
 adafruit_avrprog.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index b930689..80a09f9 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -33,15 +33,15 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
 try:
-    from io import TextIOWrapper
     from typing import Any, Dict, Optional, Tuple
 
-    from _typeshed import FileDescriptorOrPath
 except ImportError:
     pass
 
+from io import TextIOWrapper
 from math import floor
 
+from _typeshed import FileDescriptorOrPath
 from busio import SPI
 from digitalio import DigitalInOut, Direction
 

From 080462ebd57ec06a4ff5a9010549745076c73dd3 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 13:00:55 -0700
Subject: [PATCH 06/14] Working around missing _typeshed package

---
 adafruit_avrprog.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 80a09f9..bbd5762 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -33,15 +33,22 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
 try:
-    from typing import Any, Dict, Optional, Tuple
+    from os import PathLike
+    from typing import Any, Dict, Optional, Tuple, TypeAlias
+
+    # Technically this type should come from: from _typeshed import FileDescriptorOrPath
+    # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11
+    # Thus have to define a placeholder
+    FileDescriptorOrPath: TypeAlias = (
+        int | str | bytes | PathLike[str] | PathLike[bytes]
+    )
+    from io import TextIOWrapper
 
 except ImportError:
     pass
 
-from io import TextIOWrapper
 from math import floor
 
-from _typeshed import FileDescriptorOrPath
 from busio import SPI
 from digitalio import DigitalInOut, Direction
 

From f6d41b6236e0f570563294655b1f5dc151fe98a4 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Tue, 25 Apr 2023 13:34:41 -0700
Subject: [PATCH 07/14] finalizing (hopefully) all type hinting

---
 adafruit_avrprog.py | 23 +++++++++++++----------
 1 file changed, 13 insertions(+), 10 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index bbd5762..b0ed8fd 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -34,7 +34,7 @@
 
 try:
     from os import PathLike
-    from typing import Any, Dict, Optional, Tuple, TypeAlias
+    from typing import Any, Dict, List, Optional, Tuple, TypeAlias, Union
 
     # Technically this type should come from: from _typeshed import FileDescriptorOrPath
     # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11
@@ -49,7 +49,7 @@
 
 from math import floor
 
-from busio import SPI
+from busio import I2C, SPI
 from digitalio import DigitalInOut, Direction
 
 _SLOW_CLOCK: int = 100000
@@ -107,7 +107,7 @@ class Boards:
     _spi: SPI = None
     _rst: DigitalInOut = None
 
-    def init(self, spi_bus: SPI, rst_pin) -> None:
+    def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None:
         """
         Initialize the programmer with an SPI port that will be used to
         communicate with the chip. Make sure your SPI supports 'write_readinto'
@@ -206,8 +206,11 @@ def program_file(
         return True
 
     def verify_file(
-        self, chip: Dict[str, Any], file_name: FileDescriptorOrPath, verbose=False
-    ):
+        self,
+        chip: Dict[str, Any],
+        file_name: FileDescriptorOrPath,
+        verbose: bool = False,
+    ) -> bool:
         """
         Perform a chip full-flash verification from a file that
         contains Intel HEX data. Returns True/False on success/fail.
@@ -252,12 +255,12 @@ def verify_file(
         self.end()
         return True
 
-    def read_fuses(self, chip: Dict[str, Any]) -> tuple:
+    def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]:
         """
         Read the 4 fuses and return them in a tuple (low, high, ext, lock)
         Each fuse is bitwise-&'s with the chip's fuse mask for simplicity
         """
-        mask = chip["fuse_mask"]
+        mask: Tuple[int, int, int, int] = chip["fuse_mask"]
         self.begin(clock=_SLOW_CLOCK)
         low = self._transaction((0x50, 0, 0, 0))[2] & mask[0]
         high = self._transaction((0x58, 0x08, 0, 0))[2] & mask[1]
@@ -311,7 +314,7 @@ def verify_fuses(
                 return False
         return True
 
-    def erase_chip(self):
+    def erase_chip(self) -> None:
         """
         Fully erases the chip.
         """
@@ -340,7 +343,7 @@ def end(self) -> None:
         self._spi.unlock()
         self._rst.value = True
 
-    def read_signature(self) -> list:
+    def read_signature(self) -> List[int]:
         """
         Read and return the signature of the chip as two bytes in an array.
         Requires calling begin() beforehand to put in programming mode.
@@ -395,7 +398,7 @@ def _flash_page(
             raise RuntimeError("Failed to commit page to flash")
         self._busy_wait()
 
-    def _transaction(self, command: Tuple[int, int, int, int]) -> bytes:
+    def _transaction(self, command: Tuple[int, int, int, int]) -> bytearray:
         reply = bytearray(4)
         command_bytes = bytearray([i & 0xFF for i in command])
 

From ba6150fdafcc5333eac13b44c892e920397fa83e Mon Sep 17 00:00:00 2001
From: Danct12 <danct12@disroot.org>
Date: Sat, 20 Apr 2024 10:30:42 +0000
Subject: [PATCH 08/14] Add ATmega328PB to list of known chips

---
 adafruit_avrprog.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 704a258..58c1cfd 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -71,6 +71,13 @@ class Boards:
             "page_size": 128,
             "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F),
         }
+        ATmega328pb = {
+            "name": "ATmega328pb",
+            "sig": [0x1E, 0x95, 0x16],
+            "flash_size": 32768,
+            "page_size": 128,
+            "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F),
+        }
         ATmega644pa = {
             "name": "ATmega644pa",
             "sig": [0x1E, 0x96, 0x0A],

From 8e1213344e0095490aea9e4a46e73d22c4169b1a Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 6 May 2024 10:29:46 -0500
Subject: [PATCH 09/14] review feedback changes

---
 adafruit_avrprog.py | 50 +++++++++++++++++++++++++++++++++------------
 1 file changed, 37 insertions(+), 13 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index b0ed8fd..f78c815 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -33,23 +33,47 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
 try:
+    from typing import Any, Dict, List, Optional, Tuple, Union, TypedDict
+    from typing_extensions import TypeAlias
     from os import PathLike
-    from typing import Any, Dict, List, Optional, Tuple, TypeAlias, Union
+    from busio import SPI
+    from microcontroller import Pin
 
     # Technically this type should come from: from _typeshed import FileDescriptorOrPath
     # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11
     # Thus have to define a placeholder
-    FileDescriptorOrPath: TypeAlias = (
-        int | str | bytes | PathLike[str] | PathLike[bytes]
-    )
+    FileDescriptorOrPath: TypeAlias = Union[
+        int, str, bytes, PathLike[str], PathLike[bytes]
+    ]
+
     from io import TextIOWrapper
 
+    class ChipDictionary(TypedDict):
+        """
+        Dictionary representing a specific target chip type
+        """
+
+        name: str
+        sig: List[int]
+        flash_size: int
+        page_size: int
+        fuse_mask: Tuple[int]
+
+    class FileState(TypedDict):
+        """
+        Dictionary representing a File State
+        """
+
+        # pylint: disable=invalid-name
+        line: int
+        ext_addr: int
+        eof: bool
+        f: Optional[TextIOWrapper]
+
 except ImportError:
     pass
 
-from math import floor
 
-from busio import I2C, SPI
 from digitalio import DigitalInOut, Direction
 
 _SLOW_CLOCK: int = 100000
@@ -104,10 +128,10 @@ class Boards:
             "fuse_mask": (0xFF, 0xFF, 0x07, 0x3F),
         }
 
-    _spi: SPI = None
-    _rst: DigitalInOut = None
+    _spi: Optional[SPI] = None
+    _rst: Optional[DigitalInOut] = None
 
-    def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None:
+    def init(self, spi_bus: SPI, rst_pin: Pin) -> None:
         """
         Initialize the programmer with an SPI port that will be used to
         communicate with the chip. Make sure your SPI supports 'write_readinto'
@@ -118,7 +142,7 @@ def init(self, spi_bus: SPI, rst_pin: Union[SPI, I2C]) -> None:
         self._rst.direction = Direction.OUTPUT
         self._rst.value = True
 
-    def verify_sig(self, chip: Dict[str, Any], verbose: bool = False) -> bool:
+    def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool:
         """
         Verify that the chip is connected properly, responds to commands,
         and has the correct signature. Returns True/False based on success
@@ -156,7 +180,7 @@ def program_file(
         self.begin(clock=clock_speed)
 
         # create a file state dictionary
-        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper}
+        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None}
         with open(file_name, "r") as file_state["f"]:
             page_size = chip["page_size"]
 
@@ -219,7 +243,7 @@ def verify_file(
             raise RuntimeError("Signature read failure")
 
         # create a file state dictionary
-        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": TextIOWrapper}
+        file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None}
         with open(file_name, "r") as file_state["f"]:
             page_size = chip["page_size"]
             clock_speed = chip.get("clock_speed", _FAST_CLOCK)
@@ -386,7 +410,7 @@ def _flash_page(
         self, page_buffer: bytearray, page_addr: int, page_size: int
     ) -> None:
         page_addr //= 2  # address is by 'words' not bytes!
-        for i in range(floor(page_size / 2)):  # page indexed by words, not bytes
+        for i in range(page_size / 2):  # page indexed by words, not bytes
             lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2]
             self._flash_word(i, lo_byte, hi_byte)
 

From 1b12ff5c6375ea9d5df6132e0de6a86ad1f43e1b Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 6 May 2024 10:38:24 -0500
Subject: [PATCH 10/14] use TypedDict definitions for args

---
 adafruit_avrprog.py | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index f78c815..0ff7bc6 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -33,7 +33,7 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
 try:
-    from typing import Any, Dict, List, Optional, Tuple, Union, TypedDict
+    from typing import List, Optional, Tuple, Union, TypedDict
     from typing_extensions import TypeAlias
     from os import PathLike
     from busio import SPI
@@ -57,7 +57,7 @@ class ChipDictionary(TypedDict):
         sig: List[int]
         flash_size: int
         page_size: int
-        fuse_mask: Tuple[int]
+        fuse_mask: Tuple[int, int, int, int]
 
     class FileState(TypedDict):
         """
@@ -159,7 +159,7 @@ def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool:
     # pylint: disable=too-many-branches
     def program_file(
         self,
-        chip: Dict[str, Any],
+        chip: ChipDictionary,
         file_name: FileDescriptorOrPath,
         verbose: bool = False,
         verify: bool = True,
@@ -231,7 +231,7 @@ def program_file(
 
     def verify_file(
         self,
-        chip: Dict[str, Any],
+        chip: ChipDictionary,
         file_name: FileDescriptorOrPath,
         verbose: bool = False,
     ) -> bool:
@@ -279,7 +279,7 @@ def verify_file(
         self.end()
         return True
 
-    def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]:
+    def read_fuses(self, chip: ChipDictionary) -> Tuple[int, int, int, int]:
         """
         Read the 4 fuses and return them in a tuple (low, high, ext, lock)
         Each fuse is bitwise-&'s with the chip's fuse mask for simplicity
@@ -296,7 +296,7 @@ def read_fuses(self, chip: Dict[str, Any]) -> Tuple[int, int, int, int]:
     # pylint: disable=unused-argument,too-many-arguments
     def write_fuses(
         self,
-        chip: Dict[str, Any],
+        chip: ChipDictionary,
         low: Optional[int] = None,
         high: Optional[int] = None,
         ext: Optional[int] = None,
@@ -318,7 +318,7 @@ def write_fuses(
     # pylint: disable=too-many-arguments
     def verify_fuses(
         self,
-        chip: Dict[str, Any],
+        chip: ChipDictionary,
         low: Optional[int] = None,
         high: Optional[int] = None,
         ext: Optional[int] = None,
@@ -439,7 +439,7 @@ def _busy_wait(self) -> None:
 
 
 def read_hex_page(
-    file_state: Dict[str, Any], page_addr: int, page_size: int, page_buffer: bytearray
+    file_state: FileState, page_addr: int, page_size: int, page_buffer: bytearray
 ) -> bool:
     # pylint: disable=too-many-branches
     """

From 2493023c5506b1f8376f2bbd095a573351d69e61 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 6 May 2024 11:28:24 -0500
Subject: [PATCH 11/14] use int division

---
 adafruit_avrprog.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 0ff7bc6..656e104 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -410,7 +410,7 @@ def _flash_page(
         self, page_buffer: bytearray, page_addr: int, page_size: int
     ) -> None:
         page_addr //= 2  # address is by 'words' not bytes!
-        for i in range(page_size / 2):  # page indexed by words, not bytes
+        for i in range(page_size // 2):  # page indexed by words, not bytes
             lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2]
             self._flash_word(i, lo_byte, hi_byte)
 

From 61e05eff3c6a55ed048840d83b70c6b77c9f0d99 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 7 Oct 2024 09:24:05 -0500
Subject: [PATCH 12/14] remove deprecated get_html_theme_path() call

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 docs/conf.py | 1 -
 1 file changed, 1 deletion(-)

diff --git a/docs/conf.py b/docs/conf.py
index d47fbd4..43d74bd 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -100,7 +100,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 a6598ca0436de042741634e57c09616aea1eea36 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Tue, 14 Jan 2025 11:32:34 -0600
Subject: [PATCH 13/14] add sphinx configuration to rtd.yaml

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 .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 25d5071a1b76305476266899eed9a7c274100b9c Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Thu, 15 May 2025 20:05:10 +0000
Subject: [PATCH 14/14] change to ruff

---
 .gitattributes                                |  11 +
 .pre-commit-config.yaml                       |  43 +-
 .pylintrc                                     | 399 ------------------
 README.rst                                    |   6 +-
 adafruit_avrprog.py                           |  53 +--
 docs/api.rst                                  |   3 +
 docs/conf.py                                  |   8 +-
 examples/avrprog_program_mega2560.py          |  10 +-
 examples/avrprog_program_tiny13a.py           |   1 +
 examples/avrprog_program_trinket85.py         |   1 +
 examples/avrprog_program_uno328.py            |   8 +-
 examples/avrprog_read_signature_simpletest.py |   3 +-
 ruff.toml                                     | 108 +++++
 13 files changed, 161 insertions(+), 493 deletions(-)
 create mode 100644 .gitattributes
 delete mode 100644 .pylintrc
 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 70ade69..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
-        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/.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*(# )?<?https?://\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
diff --git a/README.rst b/README.rst
index 5da80bf..57c83da 100644
--- a/README.rst
+++ b/README.rst
@@ -14,9 +14,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_AVRprog/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
 
 Program your favorite AVR chips directly from CircuitPython with this handy helper class that will let you make stand-alone programmers right from your REPL. Should work with any/all AVR chips, via SPI programming. Tested with ATmega328, ATtiny85 and ATmega2560
 
diff --git a/adafruit_avrprog.py b/adafruit_avrprog.py
index 88353a0..1b1bfc2 100644
--- a/adafruit_avrprog.py
+++ b/adafruit_avrprog.py
@@ -33,18 +33,17 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AVRprog.git"
 
 try:
-    from typing import List, Optional, Tuple, Union, TypedDict
-    from typing_extensions import TypeAlias
     from os import PathLike
+    from typing import List, Optional, Tuple, TypedDict, Union
+
     from busio import SPI
     from microcontroller import Pin
+    from typing_extensions import TypeAlias
 
     # Technically this type should come from: from _typeshed import FileDescriptorOrPath
     # Unfortunately _typeshed is only in the standard library in newer releases of Python, e.g. 3.11
     # Thus have to define a placeholder
-    FileDescriptorOrPath: TypeAlias = Union[
-        int, str, bytes, PathLike[str], PathLike[bytes]
-    ]
+    FileDescriptorOrPath: TypeAlias = Union[int, str, bytes, PathLike[str], PathLike[bytes]]
 
     from io import TextIOWrapper
 
@@ -64,7 +63,6 @@ class FileState(TypedDict):
         Dictionary representing a File State
         """
 
-        # pylint: disable=invalid-name
         line: int
         ext_addr: int
         eof: bool
@@ -90,7 +88,6 @@ class Boards:
         Some well known board definitions.
         """
 
-        # pylint: disable=too-few-public-methods
         ATtiny13a = {
             "name": "ATtiny13a",
             "sig": [0x1E, 0x90, 0x07],
@@ -158,12 +155,11 @@ def verify_sig(self, chip: ChipDictionary, verbose: bool = False) -> bool:
         sig = self.read_signature()
         self.end()
         if verbose:
-            print("Found signature: %s" % [hex(i) for i in sig])
+            print(f"Found signature: {[hex(i) for i in sig]}")
         if sig != chip["sig"]:
             return False
         return True
 
-    # pylint: disable=too-many-branches
     def program_file(
         self,
         chip: ChipDictionary,
@@ -188,12 +184,12 @@ def program_file(
 
         # create a file state dictionary
         file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None}
-        with open(file_name, "r") as file_state["f"]:
+        with open(file_name) as file_state["f"]:
             page_size = chip["page_size"]
 
             for page_addr in range(0, chip["flash_size"], page_size):
                 if verbose:
-                    print("Programming page $%04X..." % page_addr, end="")
+                    print(f"Programming page ${page_addr:04X}...", end="")
                 page_buffer = bytearray(page_size)
                 for b in range(page_size):
                     page_buffer[b] = 0xFF  # make an empty page
@@ -214,19 +210,16 @@ def program_file(
                     continue
 
                 if verbose:
-                    print("Verifying page @ $%04X" % page_addr)
+                    print(f"Verifying page @ ${page_addr:04X}")
                 read_buffer = bytearray(page_size)
                 self.read(page_addr, read_buffer)
                 # print("From memory: ", read_buffer)
 
                 if page_buffer != read_buffer:
                     if verbose:
-                        # pylint: disable=line-too-long
                         print(
-                            "Verify fail at address %04X\nPage should be: %s\nBut contains: %s"
-                            % (page_addr, page_buffer, read_buffer)
+                            f"Verify fail at address {page_addr:04X}\nPage should be: {page_buffer}\nBut contains: {read_buffer}"
                         )
-                        # pylint: enable=line-too-long
                     self.end()
                     return False
 
@@ -251,7 +244,7 @@ def verify_file(
 
         # create a file state dictionary
         file_state = {"line": 0, "ext_addr": 0, "eof": False, "f": None}
-        with open(file_name, "r") as file_state["f"]:
+        with open(file_name) as file_state["f"]:
             page_size = chip["page_size"]
             clock_speed = chip.get("clock_speed", _FAST_CLOCK)
             self.begin(clock=clock_speed)
@@ -263,7 +256,7 @@ def verify_file(
                 read_hex_page(file_state, page_addr, page_size, page_buffer)
 
                 if verbose:
-                    print("Verifying page @ $%04X" % page_addr)
+                    print(f"Verifying page @ ${page_addr:04X}")
                 read_buffer = bytearray(page_size)
                 self.read(page_addr, read_buffer)
                 # print("From memory: ", read_buffer)
@@ -271,12 +264,9 @@ def verify_file(
 
                 if page_buffer != read_buffer:
                     if verbose:
-                        # pylint: disable=line-too-long
                         print(
-                            "Verify fail at address %04X\nPage should be: %s\nBut contains: %s"
-                            % (page_addr, page_buffer, read_buffer)
+                            f"Verify fail at address {page_addr:04X}\nPage should be: {page_buffer}\nBut contains: {read_buffer}"
                         )
-                        # pylint: enable=line-too-long
                     self.end()
                     return False
 
@@ -300,7 +290,6 @@ def read_fuses(self, chip: ChipDictionary) -> Tuple[int, int, int, int]:
         self.end()
         return (low, high, ext, lock)
 
-    # pylint: disable=unused-argument,too-many-arguments
     def write_fuses(
         self,
         chip: ChipDictionary,
@@ -322,7 +311,6 @@ def write_fuses(
             self._busy_wait()
         self.end()
 
-    # pylint: disable=too-many-arguments
     def verify_fuses(
         self,
         chip: ChipDictionary,
@@ -413,9 +401,7 @@ def _flash_word(self, addr: int, low: int, high: int) -> None:
         self._transaction((0x40, addr >> 8, addr, low))
         self._transaction((0x48, addr >> 8, addr, high))
 
-    def _flash_page(
-        self, page_buffer: bytearray, page_addr: int, page_size: int
-    ) -> None:
+    def _flash_page(self, page_buffer: bytearray, page_addr: int, page_size: int) -> None:
         page_addr //= 2  # address is by 'words' not bytes!
         for i in range(page_size // 2):  # page indexed by words, not bytes
             lo_byte, hi_byte = page_buffer[2 * i : 2 * i + 2]
@@ -448,7 +434,6 @@ def _busy_wait(self) -> None:
 def read_hex_page(
     file_state: FileState, page_addr: int, page_size: int, page_buffer: bytearray
 ) -> bool:
-    # pylint: disable=too-many-branches
     """
     Helper function that does the Intel Hex parsing. Takes in a dictionary
     that contains the file 'state'. The dictionary should have file_state['f']
@@ -486,9 +471,7 @@ def read_hex_page(
             file_state["line_addr"] = line_addr
             rec_type = int(line[7:9], 16)
         except ValueError as err:
-            raise RuntimeError(
-                "Could not parse HEX line %d addr" % file_state["line"]
-            ) from err
+            raise RuntimeError("Could not parse HEX line %d addr" % file_state["line"]) from err
 
         if file_state["ext_addr"]:
             line_addr += file_state["ext_addr"]
@@ -534,13 +517,7 @@ def read_hex_page(
             byte_buffer.append(int(line[9 + i * 2 : 11 + i * 2], 16))
 
         # check chksum now!
-        chksum = (
-            hex_len
-            + (line_addr >> 8)
-            + (line_addr & 0xFF)
-            + rec_type
-            + sum(byte_buffer)
-        )
+        chksum = hex_len + (line_addr >> 8) + (line_addr & 0xFF) + rec_type + sum(byte_buffer)
         # print("checksum: "+hex(chksum))
         if (chksum & 0xFF) != 0:
             raise RuntimeError("HEX Checksum fail")
diff --git a/docs/api.rst b/docs/api.rst
index a2550d7..3612fd1 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1,5 +1,8 @@
 
 .. If you created a package, create one automodule per module in the package.
 
+API Reference
+#############
+
 .. automodule:: adafruit_avrprog
    :members:
diff --git a/docs/conf.py b/docs/conf.py
index 43d74bd..72cd051 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(".."))
 
@@ -45,9 +43,7 @@
 creation_year = "2017"
 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 + " ladyada"
 author = "ladyada"
diff --git a/examples/avrprog_program_mega2560.py b/examples/avrprog_program_mega2560.py
index d3ace05..a4e240e 100644
--- a/examples/avrprog_program_mega2560.py
+++ b/examples/avrprog_program_mega2560.py
@@ -14,6 +14,7 @@
 
 import board
 import busio
+
 import adafruit_avrprog
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
@@ -54,15 +55,10 @@ def error(err):
 
 avrprog.write_fuses(atmega2560, low=0xFF, high=0xD8, ext=0x05, lock=0x3F)
 if not avrprog.verify_fuses(atmega2560, low=0xFF, high=0xD8, ext=0x05, lock=0x3F):
-    error(
-        "Failure programming fuses: "
-        + str([hex(i) for i in avrprog.read_fuses(atmega2560)])
-    )
+    error("Failure programming fuses: " + str([hex(i) for i in avrprog.read_fuses(atmega2560)]))
 
 print("Programming flash from file")
-avrprog.program_file(
-    atmega2560, "stk500boot_v2_mega2560.hex", verbose=True, verify=True
-)
+avrprog.program_file(atmega2560, "stk500boot_v2_mega2560.hex", verbose=True, verify=True)
 
 avrprog.write_fuses(atmega2560, lock=0x0F)
 if not avrprog.verify_fuses(atmega2560, lock=0x0F):
diff --git a/examples/avrprog_program_tiny13a.py b/examples/avrprog_program_tiny13a.py
index 4e8b5c5..df126ad 100644
--- a/examples/avrprog_program_tiny13a.py
+++ b/examples/avrprog_program_tiny13a.py
@@ -14,6 +14,7 @@
 
 import board
 import busio
+
 import adafruit_avrprog
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
diff --git a/examples/avrprog_program_trinket85.py b/examples/avrprog_program_trinket85.py
index c8b8007..9f95669 100644
--- a/examples/avrprog_program_trinket85.py
+++ b/examples/avrprog_program_trinket85.py
@@ -14,6 +14,7 @@
 
 import board
 import busio
+
 import adafruit_avrprog
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
diff --git a/examples/avrprog_program_uno328.py b/examples/avrprog_program_uno328.py
index 71e0051..447327a 100644
--- a/examples/avrprog_program_uno328.py
+++ b/examples/avrprog_program_uno328.py
@@ -15,16 +15,15 @@
 import board
 import busio
 import pwmio
+
 import adafruit_avrprog
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 avrprog = adafruit_avrprog.AVRprog()
 avrprog.init(spi, board.D5)
 
-# pylint: disable-msg=no-member
 # we can generate an 6 MHz clock for driving bare chips too!
 clock_pwm = pwmio.PWMOut(board.D9, frequency=6000000, duty_cycle=65536 // 2)
-# pylint: enable-msg=no-member
 
 # Each chip has to have a definition so the script knows how to find it
 atmega328p = avrprog.Boards.ATmega328p
@@ -50,10 +49,7 @@ def error(err):
 
 avrprog.write_fuses(atmega328p, low=0xFF, high=0xDE, ext=0x05, lock=0x3F)
 if not avrprog.verify_fuses(atmega328p, low=0xFF, high=0xDE, ext=0x05, lock=0x3F):
-    error(
-        "Failure programming fuses: "
-        + str([hex(i) for i in avrprog.read_fuses(atmega328p)])
-    )
+    error("Failure programming fuses: " + str([hex(i) for i in avrprog.read_fuses(atmega328p)]))
 
 print("Programming flash from file")
 avrprog.program_file(atmega328p, "optiboot_atmega328.hex", verbose=True, verify=True)
diff --git a/examples/avrprog_read_signature_simpletest.py b/examples/avrprog_read_signature_simpletest.py
index 52c1849..98e5af7 100644
--- a/examples/avrprog_read_signature_simpletest.py
+++ b/examples/avrprog_read_signature_simpletest.py
@@ -9,16 +9,15 @@
 import board
 import busio
 import pwmio
+
 import adafruit_avrprog
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 avrprog = adafruit_avrprog.AVRprog()
 avrprog.init(spi, board.D5)
 
-# pylint: disable-msg=no-member
 # we can generate an 6 MHz clock for driving bare chips too!
 clock_pwm = pwmio.PWMOut(board.D9, frequency=6000000, duty_cycle=65536 // 2)
-# pylint: enable-msg=no-member
 
 avrprog.begin()
 print("Signature bytes: ", [hex(i) for i in avrprog.read_signature()])
diff --git a/ruff.toml b/ruff.toml
new file mode 100644
index 0000000..6ff0123
--- /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
+    "E501", # line too long
+]
+
+[format]
+line-ending = "lf"