From ee4660eceefb745a442fbb2a133466e072264f4d Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Mon, 22 Aug 2022 21:36:33 -0400
Subject: [PATCH 01/24] 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 a252455..cc92102 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(".."))
 
@@ -37,7 +38,8 @@
 
 # General information about the project.
 project = "Adafruit CircuitPython SimpleIO Library"
-copyright = "2017 Scott Shawcroft"
+current_year = str(datetime.datetime.now().year)
+copyright = current_year + " Scott Shawcroft"
 author = "Scott Shawcroft"
 
 # The version info for the project you're documenting, acts as replacement for

From 0a8fcbfc92060eb298ea52d5e88587b37347a0be Mon Sep 17 00:00:00 2001
From: Alec Delaney <tekktik@gmail.com>
Date: Tue, 23 Aug 2022 17:26:23 -0400
Subject: [PATCH 02/24] 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 cc92102..0d59988 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -38,8 +38,14 @@
 
 # General information about the project.
 project = "Adafruit CircuitPython SimpleIO Library"
+creation_year = "2017"
 current_year = str(datetime.datetime.now().year)
-copyright = current_year + " Scott Shawcroft"
+year_duration = (
+    current_year
+    if current_year == creation_year
+    else creation_year + " - " + current_year
+)
+copyright = year_duration + " Scott Shawcroft"
 author = "Scott Shawcroft"
 
 # The version info for the project you're documenting, acts as replacement for

From 2453b466fba4d08f84168cae9454d54b68fd5611 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 03/24] 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 b5c9ff1e50dbbd5f522dea809c62e9e2a6c97ea6 Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Fri, 4 Nov 2022 00:47:01 -0400
Subject: [PATCH 04/24] 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 3343606..4c43710 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 8d27b664a7e13904964f8daebe5728e1d56da32e 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 05/24] 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 4c43710..0e5fccc 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 d57d1087dcc9bd8f3a8b3b428415188697b022f6 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 06/24] 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 59b04c1d20b7067ed2b6d0215955432d8f2ae959 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 07/24] 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 72b5fda9b09e1af00a1b40095084bb9f726e849e Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Mon, 7 Nov 2022 22:11:32 -0500
Subject: [PATCH 08/24] Fix pylint errors

---
 simpleio.py | 7 ++-----
 1 file changed, 2 insertions(+), 5 deletions(-)

diff --git a/simpleio.py b/simpleio.py
index 5fa48d7..ca3f7d1 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -171,12 +171,9 @@ def shift_out(data_pin, clock, value, msb_first=True, bitcount=8):
     if bitcount < 0 or bitcount > 32:
         raise ValueError("bitcount must be in range 0..32 inclusive")
 
-    if msb_first:
-        bitsequence = lambda: range(bitcount - 1, -1, -1)
-    else:
-        bitsequence = lambda: range(0, bitcount)
+    bitsequence = range(bitcount - 1, -1, -1) if msb_first else range(bitcount)
 
-    for i in bitsequence():
+    for i in bitsequence:
         tmpval = bool(value & (1 << i))
         data_pin.value = tmpval
         # toggle clock pin True/False

From 3364371c789ec67d2f30f1db1a8ed967fddee581 Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Thu, 1 Sep 2022 20:16:31 -0400
Subject: [PATCH 09/24] Add .venv to .gitignore

Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
---
 .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 252d3d0ea44a9e5d43c91de604f152e7d3099380 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 10/24] 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 a61aad7af2b66f960098407e9320507216d559f5 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Mon, 24 Apr 2023 10:43:09 -0700
Subject: [PATCH 11/24] Adding type annotations. Had to include some math.floor
 to coerce floats to integers.

---
 simpleio.py | 51 ++++++++++++++++++++++++++++++++-------------------
 1 file changed, 32 insertions(+), 19 deletions(-)

diff --git a/simpleio.py b/simpleio.py
index ca3f7d1..a0153fa 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -10,9 +10,18 @@
 
 * Author(s): Scott Shawcroft
 """
-import time
-import sys
+try:
+    from typing import Any
+
+    from microcontroller import Pin
+except:
+    pass
+
 import array
+import sys
+import time
+from math import floor
+
 import digitalio
 import pwmio
 
@@ -34,13 +43,13 @@
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO.git"
 
 
-def tone(pin, frequency, duration=1, length=100):
+def tone(pin: Pin, frequency: float, duration: int = 1, length: float = 100) -> None:
     """
     Generates a square wave of the specified frequency on a pin
 
     :param ~microcontroller.Pin pin: Pin on which to output the tone
     :param float frequency: Frequency of tone in Hz
-    :param int length: Variable size buffer (optional)
+    :param float length: Variable size buffer (optional)
     :param int duration: Duration of tone in seconds (optional)
     """
     if length * frequency > 350000:
@@ -48,17 +57,15 @@ def tone(pin, frequency, duration=1, length=100):
     try:
         # pin with PWM
         # pylint: disable=no-member
-        with pwmio.PWMOut(
-            pin, frequency=int(frequency), variable_frequency=False
-        ) as pwm:
+        with pwmio.PWMOut(pin, frequency=int(frequency), variable_frequency=False) as pwm:
             pwm.duty_cycle = 0x8000
             time.sleep(duration)
         # pylint: enable=no-member
     except ValueError:
         # pin without PWM
-        sample_length = length
+        sample_length = floor(length)
         square_wave = array.array("H", [0] * sample_length)
-        for i in range(sample_length / 2):
+        for i in range(floor(sample_length / 2)):
             square_wave[i] = 0xFFFF
         square_wave_sample = audiocore.RawSample(square_wave)
         square_wave_sample.sample_rate = int(len(square_wave) * frequency)
@@ -69,7 +76,7 @@ def tone(pin, frequency, duration=1, length=100):
             dac.stop()
 
 
-def bitWrite(x, n, b):  # pylint: disable-msg=invalid-name
+def bitWrite(x: int, n: int, b: int) -> int:  # pylint: disable-msg=invalid-name
     """
     Based on the Arduino bitWrite function, changes a specific bit of a value to 0 or 1.
     The return value is the original value with the changed bit.
@@ -86,7 +93,7 @@ def bitWrite(x, n, b):  # pylint: disable-msg=invalid-name
     return x
 
 
-def shift_in(data_pin, clock, msb_first=True):
+def shift_in(data_pin: digitalio.DigitalInOut, clock: digitalio.DigitalInOut, msb_first: bool = True) -> int:
     """
     Shifts in a byte of data one bit at a time. Starts from either the LSB or
     MSB.
@@ -116,7 +123,13 @@ def shift_in(data_pin, clock, msb_first=True):
     return value
 
 
-def shift_out(data_pin, clock, value, msb_first=True, bitcount=8):
+def shift_out(
+    data_pin: digitalio.DigitalInOut,
+    clock: digitalio.DigitalInOut,
+    value: int,
+    msb_first: bool = True,
+    bitcount: int = 8,
+) -> None:
     """
     Shifts out a byte of data one bit at a time. Data gets written to a data
     pin. Then, the clock pulses hi then low
@@ -190,17 +203,17 @@ class DigitalOut:
       :param drive_mode digitalio.DriveMode: drive mode for the output
     """
 
-    def __init__(self, pin, **kwargs):
+    def __init__(self, pin: Pin, **kwargs: Any) -> None:
         self.iopin = digitalio.DigitalInOut(pin)
         self.iopin.switch_to_output(**kwargs)
 
     @property
-    def value(self):
+    def value(self) -> Any:
         """The digital logic level of the output pin."""
         return self.iopin.value
 
     @value.setter
-    def value(self, value):
+    def value(self, value: bool) -> None:
         self.iopin.value = value
 
 
@@ -212,21 +225,21 @@ class DigitalIn:
       :param pull digitalio.Pull: pull configuration for the input
     """
 
-    def __init__(self, pin, **kwargs):
+    def __init__(self, pin: Pin, **kwargs: Any) -> None:
         self.iopin = digitalio.DigitalInOut(pin)
         self.iopin.switch_to_input(**kwargs)
 
     @property
-    def value(self):
+    def value(self) -> Any:
         """The digital logic level of the input pin."""
         return self.iopin.value
 
     @value.setter
-    def value(self, value):  # pylint: disable-msg=no-self-use, unused-argument
+    def value(self, value: Any) -> None:  # pylint: disable-msg=no-self-use, unused-argument
         raise AttributeError("Cannot set the value on a digital input.")
 
 
-def map_range(x, in_min, in_max, out_min, out_max):
+def map_range(x: float, in_min: float, in_max: float, out_min: float, out_max: float) -> float:
     """
     Maps a number from one range to another.
     Note: This implementation handles values < in_min differently than arduino's map function does.

From 4b37794ab9430eae79ef8be566ce1fc534bbfca8 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Mon, 24 Apr 2023 10:59:37 -0700
Subject: [PATCH 12/24] Changes to fix CI errors on PR

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

diff --git a/simpleio.py b/simpleio.py
index a0153fa..c8172e8 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -14,7 +14,7 @@
     from typing import Any
 
     from microcontroller import Pin
-except:
+except ImportError:
     pass
 
 import array

From 5dfe90fb211b2ac869e7bfb996826417124a9d9e Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Mon, 24 Apr 2023 11:09:38 -0700
Subject: [PATCH 13/24] Working on linting errors

---
 simpleio.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/simpleio.py b/simpleio.py
index c8172e8..2400929 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -93,7 +93,9 @@ def bitWrite(x: int, n: int, b: int) -> int:  # pylint: disable-msg=invalid-name
     return x
 
 
-def shift_in(data_pin: digitalio.DigitalInOut, clock: digitalio.DigitalInOut, msb_first: bool = True) -> int:
+def shift_in(
+    data_pin: digitalio.DigitalInOut, clock: digitalio.DigitalInOut, msb_first: bool = True
+) -> int:
     """
     Shifts in a byte of data one bit at a time. Starts from either the LSB or
     MSB.

From 89d7a06c429e9dd25959bcae5bbd9c89deaefdff Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Mon, 24 Apr 2023 11:32:49 -0700
Subject: [PATCH 14/24] Linting for CI

---
 simpleio.py | 14 ++++++++++----
 1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/simpleio.py b/simpleio.py
index 2400929..aa98db1 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -57,7 +57,9 @@ def tone(pin: Pin, frequency: float, duration: int = 1, length: float = 100) ->
     try:
         # pin with PWM
         # pylint: disable=no-member
-        with pwmio.PWMOut(pin, frequency=int(frequency), variable_frequency=False) as pwm:
+        with pwmio.PWMOut(
+            pin, frequency=int(frequency), variable_frequency=False
+        ) as pwm:
             pwm.duty_cycle = 0x8000
             time.sleep(duration)
         # pylint: enable=no-member
@@ -94,7 +96,9 @@ def bitWrite(x: int, n: int, b: int) -> int:  # pylint: disable-msg=invalid-name
 
 
 def shift_in(
-    data_pin: digitalio.DigitalInOut, clock: digitalio.DigitalInOut, msb_first: bool = True
+    data_pin: digitalio.DigitalInOut,
+    clock: digitalio.DigitalInOut,
+    msb_first: bool = True,
 ) -> int:
     """
     Shifts in a byte of data one bit at a time. Starts from either the LSB or
@@ -237,11 +241,13 @@ def value(self) -> Any:
         return self.iopin.value
 
     @value.setter
-    def value(self, value: Any) -> None:  # pylint: disable-msg=no-self-use, unused-argument
+    def value(self, value: Any) -> None:  # pylint: disable=no-self-use, unused-argument
         raise AttributeError("Cannot set the value on a digital input.")
 
 
-def map_range(x: float, in_min: float, in_max: float, out_min: float, out_max: float) -> float:
+def map_range(
+    x: float, in_min: float, in_max: float, out_min: float, out_max: float
+) -> float:
     """
     Maps a number from one range to another.
     Note: This implementation handles values < in_min differently than arduino's map function does.

From a1ecde6586674db938c57720fcccf2f7a5b4a33d Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Wed, 26 Apr 2023 19:58:41 -0700
Subject: [PATCH 15/24] Making return type changes as requested by review

---
 simpleio.py | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/simpleio.py b/simpleio.py
index aa98db1..1f5829f 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -214,7 +214,7 @@ def __init__(self, pin: Pin, **kwargs: Any) -> None:
         self.iopin.switch_to_output(**kwargs)
 
     @property
-    def value(self) -> Any:
+    def value(self) -> bool:
         """The digital logic level of the output pin."""
         return self.iopin.value
 
@@ -236,12 +236,14 @@ def __init__(self, pin: Pin, **kwargs: Any) -> None:
         self.iopin.switch_to_input(**kwargs)
 
     @property
-    def value(self) -> Any:
+    def value(self) -> bool:
         """The digital logic level of the input pin."""
         return self.iopin.value
 
     @value.setter
-    def value(self, value: Any) -> None:  # pylint: disable=no-self-use, unused-argument
+    def value(
+        self, value: bool
+    ) -> None:  # pylint: disable=no-self-use, unused-argument
         raise AttributeError("Cannot set the value on a digital input.")
 
 

From 8f24c08ea014e7e20967e8014598c270b169232e Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Wed, 26 Apr 2023 20:06:07 -0700
Subject: [PATCH 16/24] Fixing pylint issue

---
 simpleio.py | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/simpleio.py b/simpleio.py
index 1f5829f..88cc381 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -241,9 +241,7 @@ def value(self) -> bool:
         return self.iopin.value
 
     @value.setter
-    def value(
-        self, value: bool
-    ) -> None:  # pylint: disable=no-self-use, unused-argument
+    def value(self, value: bool) -> None: # pylint: disable=no-self-use
         raise AttributeError("Cannot set the value on a digital input.")
 
 

From 409c013966d1813982b06eaf99121284c6041c41 Mon Sep 17 00:00:00 2001
From: Ross Kukard <75049118+RossK1@users.noreply.github.com>
Date: Wed, 26 Apr 2023 20:09:51 -0700
Subject: [PATCH 17/24] Fixing black pre-commit

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

diff --git a/simpleio.py b/simpleio.py
index 88cc381..58f0b81 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -241,7 +241,7 @@ def value(self) -> bool:
         return self.iopin.value
 
     @value.setter
-    def value(self, value: bool) -> None: # pylint: disable=no-self-use
+    def value(self, value: bool) -> None:  # pylint: disable=no-self-use
         raise AttributeError("Cannot set the value on a digital input.")
 
 

From 20317088f6e7d2fbbf52496ac1223b24a4aeba29 Mon Sep 17 00:00:00 2001
From: Tekktrik <tekktrik@gmail.com>
Date: Tue, 9 May 2023 20:26:25 -0400
Subject: [PATCH 18/24] Update pre-commit hooks

Signed-off-by: Tekktrik <tekktrik@gmail.com>
---
 .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 0e5fccc..70ade69 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 6897d6ff21132e99111c72b2e60cf1d20223e9bb Mon Sep 17 00:00:00 2001
From: Alec Delaney <89490472+tekktrik@users.noreply.github.com>
Date: Tue, 23 May 2023 22:25:55 -0400
Subject: [PATCH 19/24] Update .pylintrc, fix jQuery for docs

---
 .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 0d59988..29d378b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,6 +17,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
 ]
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 c7272bb0c7defe979a5e024d411d659e91d57b7b Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 18 Sep 2023 16:19:17 -0500
Subject: [PATCH 20/24] "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 29d378b..2bbf428 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -94,19 +94,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 967a12a68c4b82048cb5efe99847408215188561 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 16 Oct 2023 14:30:31 -0500
Subject: [PATCH 21/24] unpin sphinx and add sphinx-rtd-theme to docs reqs

Signed-off-by: foamyguy <foamyguy@gmail.com>
---
 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 6a1a438b0b156cd672d7daf67df3b1bc1b497124 Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Mon, 7 Oct 2024 09:24:05 -0500
Subject: [PATCH 22/24] 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 2bbf428..1a225bf 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -97,7 +97,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 5770df8b88e66ea0690fa0fb04b16b01f96b6fbd Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Tue, 14 Jan 2025 11:32:34 -0600
Subject: [PATCH 23/24] 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 b79d18682f4fe72740c335fb45bd15560b9bb89b Mon Sep 17 00:00:00 2001
From: foamyguy <foamyguy@gmail.com>
Date: Fri, 16 May 2025 19:11:49 +0000
Subject: [PATCH 24/24] change to ruff

---
 .gitattributes                            |  11 +
 .pre-commit-config.yaml                   |  43 +--
 .pylintrc                                 | 399 ----------------------
 README.rst                                |   6 +-
 docs/api.rst                              |   3 +
 docs/conf.py                              |   8 +-
 examples/simpleio_map_range_simpletest.py |   2 +
 examples/simpleio_shift_in_out_demo.py    |   2 +
 examples/simpleio_tone_demo.py            |   4 +-
 ruff.toml                                 | 109 ++++++
 simpleio.py                               |  15 +-
 11 files changed, 151 insertions(+), 451 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 17dba1a..ea5fb1e 100644
--- a/README.rst
+++ b/README.rst
@@ -14,9 +14,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO/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
 
 SimpleIO features a number of helpers to simplify hardware interactions. Many
 of the functions and classes are inspired by Arduino APIs to make it easier to
diff --git a/docs/api.rst b/docs/api.rst
index 67c1b45..315e75b 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:: simpleio
    :members:
diff --git a/docs/conf.py b/docs/conf.py
index 1a225bf..76d1ee9 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(".."))
 
@@ -42,9 +40,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 + " Scott Shawcroft"
 author = "Scott Shawcroft"
diff --git a/examples/simpleio_map_range_simpletest.py b/examples/simpleio_map_range_simpletest.py
index dd2f72e..e03f944 100644
--- a/examples/simpleio_map_range_simpletest.py
+++ b/examples/simpleio_map_range_simpletest.py
@@ -7,7 +7,9 @@
 =================================================
 maps a number from one range to another
 """
+
 import time
+
 import simpleio
 
 while True:
diff --git a/examples/simpleio_shift_in_out_demo.py b/examples/simpleio_shift_in_out_demo.py
index 7a01f79..f73d727 100644
--- a/examples/simpleio_shift_in_out_demo.py
+++ b/examples/simpleio_shift_in_out_demo.py
@@ -9,8 +9,10 @@
 """
 
 import time
+
 import board
 import digitalio
+
 import simpleio
 
 # set up clock, data, and latch pins
diff --git a/examples/simpleio_tone_demo.py b/examples/simpleio_tone_demo.py
index 4c3a8b4..ae1c7dd 100644
--- a/examples/simpleio_tone_demo.py
+++ b/examples/simpleio_tone_demo.py
@@ -7,10 +7,12 @@
 =================================================
 a short piezo song using tone()
 """
+
 import time
+
 import board
-import simpleio
 
+import simpleio
 
 while True:
     for f in (262, 294, 330, 349, 392, 440, 494, 523):
diff --git a/ruff.toml b/ruff.toml
new file mode 100644
index 0000000..2e20813
--- /dev/null
+++ b/ruff.toml
@@ -0,0 +1,109 @@
+# 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
+    "PLC2701", # private import
+    "PLW2901", # loop var overwrite
+]
+
+[format]
+line-ending = "lf"
diff --git a/simpleio.py b/simpleio.py
index 58f0b81..3a5a488 100644
--- a/simpleio.py
+++ b/simpleio.py
@@ -10,6 +10,7 @@
 
 * Author(s): Scott Shawcroft
 """
+
 try:
     from typing import Any
 
@@ -56,13 +57,9 @@ def tone(pin: Pin, frequency: float, duration: int = 1, length: float = 100) ->
         length = 350000 // frequency
     try:
         # pin with PWM
-        # pylint: disable=no-member
-        with pwmio.PWMOut(
-            pin, frequency=int(frequency), variable_frequency=False
-        ) as pwm:
+        with pwmio.PWMOut(pin, frequency=int(frequency), variable_frequency=False) as pwm:
             pwm.duty_cycle = 0x8000
             time.sleep(duration)
-        # pylint: enable=no-member
     except ValueError:
         # pin without PWM
         sample_length = floor(length)
@@ -78,7 +75,7 @@ def tone(pin: Pin, frequency: float, duration: int = 1, length: float = 100) ->
             dac.stop()
 
 
-def bitWrite(x: int, n: int, b: int) -> int:  # pylint: disable-msg=invalid-name
+def bitWrite(x: int, n: int, b: int) -> int:
     """
     Based on the Arduino bitWrite function, changes a specific bit of a value to 0 or 1.
     The return value is the original value with the changed bit.
@@ -241,13 +238,11 @@ def value(self) -> bool:
         return self.iopin.value
 
     @value.setter
-    def value(self, value: bool) -> None:  # pylint: disable=no-self-use
+    def value(self, value: bool) -> None:
         raise AttributeError("Cannot set the value on a digital input.")
 
 
-def map_range(
-    x: float, in_min: float, in_max: float, out_min: float, out_max: float
-) -> float:
+def map_range(x: float, in_min: float, in_max: float, out_min: float, out_max: float) -> float:
     """
     Maps a number from one range to another.
     Note: This implementation handles values < in_min differently than arduino's map function does.