From aea959d2e53f9b02e91f40ee7f127ee387eac909 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:12 -0400 Subject: [PATCH 01/33] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 7bd2813..8d278e6 100644 --- a/README.rst +++ b/README.rst @@ -46,8 +46,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-pybadger Usage Example From 1d4aa7ce77965d1e71e78e3fd1e3eb17806b41cb Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:57 -0400 Subject: [PATCH 02/33] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 8d278e6..135e307 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag. From d4d62e35f244126482efaec4d1d4fc66663a8bb2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:55 -0400 Subject: [PATCH 03/33] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++----- .github/workflows/release.yml | 17 +++++----- optional_requirements.txt | 3 ++ pyproject.toml | 45 ++++++++++++++++++++++++++ requirements.txt | 10 +++--- setup.py | 59 ----------------------------------- 6 files changed, 73 insertions(+), 79 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..43a615b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-pybadger" +description = "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE" +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"} +keywords = [ + "adafruit", + "pybadge", + "pygamer", + "clue", + "display", + "hardware", + "micropythoncircuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_pybadger"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 6e1974a..92bd3f5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,13 +1,13 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka adafruit-circuitpython-bitmap-font -adafruit-circuitpython-display-shapes -adafruit-circuitpython-display-text -adafruit-circuitpython-gizmo -adafruit-circuitpython-lis3dh adafruit-circuitpython-lsm6ds +adafruit-circuitpython-display-text adafruit-circuitpython-miniqr adafruit-circuitpython-neopixel +adafruit-circuitpython-gizmo +adafruit-circuitpython-lis3dh +adafruit-circuitpython-display-shapes diff --git a/setup.py b/setup.py deleted file mode 100644 index d5ffeb7..0000000 --- a/setup.py +++ /dev/null @@ -1,59 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-pybadger", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Badge-focused CircuitPython helper library for PyBadge, " - "PyBadge LC, PyGamer and CLUE", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_REPLACE", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit pybadge pygamer clue display hardware micropython" - "circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - packages=["adafruit_pybadger"], -) From 3db064b67010fbd967a0b3a4110e15b02f7b60c9 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 04/33] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 43a615b..4e87ac3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 86de3352e51c48ef1a76920a2d27fdbefd68b44c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:16 -0400 Subject: [PATCH 05/33] Update version string --- adafruit_pybadger/clue.py | 2 +- adafruit_pybadger/cpb_gizmo.py | 2 +- adafruit_pybadger/magtag.py | 2 +- adafruit_pybadger/pewpewm4.py | 2 +- adafruit_pybadger/pybadge.py | 2 +- adafruit_pybadger/pybadger_base.py | 2 +- adafruit_pybadger/pygamer.py | 2 +- adafruit_pybadger/pyportal.py | 2 +- pyproject.toml | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index e49180b..02cf08f 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -33,7 +33,7 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 5d205c7..eae0f9b 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -43,7 +43,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 77415bb..d0da196 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -35,7 +35,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b c d") diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 6fa95fc..11825a7 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -36,7 +36,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", ("o", "x", "z", "right", "down", "up", "left")) diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index a90b3e1..195c3f5 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -45,7 +45,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index c7d280c..10994ac 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -71,7 +71,7 @@ from neopixel import NeoPixel -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index faf5ca0..8f69e19 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -40,7 +40,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 83e9604..1345183 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -30,7 +30,7 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" diff --git a/pyproject.toml b/pyproject.toml index 4e87ac3..71f1f03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-pybadger" description = "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 86262484f8dd2bf54930056c3d5952e98e927330 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:16 -0400 Subject: [PATCH 06/33] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From f0e851185b0725b2358c4cb8d538932ff8983177 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:33 -0400 Subject: [PATCH 07/33] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 19f2771..539329b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) sys.path.insert(0, os.path.abspath("mocks")) @@ -58,7 +59,8 @@ # General information about the project. project = "Adafruit PyBadger Library" -copyright = "2019 Kattni Rembor" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for From e9331b7847823b55656c6d54f61ab4637373f199 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:22 -0400 Subject: [PATCH 08/33] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 539329b..b029445 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -59,8 +59,14 @@ # General information about the project. project = "Adafruit PyBadger Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Kattni Rembor" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for From a6151154ca1461474ddb44ba523eda87268d632f Mon Sep 17 00:00:00 2001 From: BlitzCityDIY Date: Tue, 13 Sep 2022 14:19:44 -0400 Subject: [PATCH 09/33] Updating padding for CLUE badge example I uploaded the example to a CLUE running CP8 and the text was not lining up as shown in the guide (https://learn.adafruit.com/clue-custom-circuit-python-badge/clue-badge). Adjusted the padding to match it and PR-ing since this code will be used for an upcoming PyLeap project. --- examples/pybadger_clue_custom_badge.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/pybadger_clue_custom_badge.py b/examples/pybadger_clue_custom_badge.py index 280555e..e322dcb 100644 --- a/examples/pybadger_clue_custom_badge.py +++ b/examples/pybadger_clue_custom_badge.py @@ -14,12 +14,12 @@ pybadger.badge_line( text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2 ) -pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) +pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=6) pybadger.badge_line( text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 ) pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=4 + text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7 ) pybadger.show_custom_badge() From af8a756286e8ccf33e712cb189ce811da2881235 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 13 Sep 2022 19:44:40 -0400 Subject: [PATCH 10/33] Update .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From d91c9a11ddf5b2d5b8b4a628be5df56e4b16f771 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:50 -0400 Subject: [PATCH 11/33] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 3324c876f7e303e268158c7a0371d07a83df33e1 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:00 -0400 Subject: [PATCH 12/33] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0a91a11..e6ddf7c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 4b364a5645ba15ce2ce679f91ce065d342218d11 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:21 -0400 Subject: [PATCH 13/33] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e6ddf7c..6996f9c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From cebe5bea189ebeaa555834155076a9938168c17f Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:46 -0400 Subject: [PATCH 14/33] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From 4d079da911aced0168b4558dcea8f15ba7fec7a3 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:33 -0400 Subject: [PATCH 15/33] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index f772971..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ From e684757d1100228217892ca0828ff62686296456 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Mon, 7 Nov 2022 22:28:58 -0500 Subject: [PATCH 16/33] Fix pylint errors --- adafruit_pybadger/pybadger_base.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 10994ac..0059c09 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -399,10 +399,10 @@ def _check_for_movement(self, movement_threshold: int = 10) -> bool: self._last_accelerometer = current_accelerometer return False acceleration_delta = sum( - [ + ( abs(self._last_accelerometer[n] - current_accelerometer[n]) for n in range(3) - ] + ) ) self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold From a42b3157280894f65b2aca2e6436a6a00f76dbd5 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Dec 2022 00:32:08 -0500 Subject: [PATCH 17/33] Update namedtuple type annotations --- adafruit_pybadger/clue.py | 7 +------ adafruit_pybadger/cpb_gizmo.py | 6 +----- adafruit_pybadger/magtag.py | 6 +----- adafruit_pybadger/pewpewm4.py | 6 +----- adafruit_pybadger/pybadge.py | 6 +----- adafruit_pybadger/pygamer.py | 4 ++-- 6 files changed, 7 insertions(+), 28 deletions(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 02cf08f..9b8528b 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -38,11 +38,6 @@ Buttons = namedtuple("Buttons", "a b") -try: - from typing import Type -except ImportError: - pass - class Clue(PyBadgerBase): """Class that represents a single CLUE.""" @@ -69,7 +64,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index eae0f9b..82f6c29 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -38,10 +38,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -79,7 +75,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.LIGHT) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index d0da196..46237ee 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -30,10 +30,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -55,7 +51,7 @@ def __init__(self) -> None: ) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 11825a7..c9cdf21 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -31,10 +31,6 @@ import keypad from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -68,7 +64,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index 195c3f5..dc93377 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -40,10 +40,6 @@ import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -105,7 +101,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index 8f69e19..bccdb76 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -36,7 +36,7 @@ from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates try: - from typing import Type, Tuple + from typing import Tuple except ImportError: pass @@ -85,7 +85,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: From 9b80c68047c96a2806b4351482ab50d2a85132e2 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 18/33] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From 813cbafff36fdbee80287de010aac11d9c0f0fca Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 19/33] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6996f9c..179cf07 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 29a33003218d110b6f9a24929a4354271e168ca1 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:42:01 -0400 Subject: [PATCH 20/33] Run pre-commit --- examples/pybadger_magtag_simpletest.py | 1 - examples/pybadger_pygamer_asyncio.py | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index 504c7c7..5c68c23 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -55,7 +55,6 @@ def try_refresh(): pybadger.pixels.fill(0x000022) while True: - cur_a = btn_a.value cur_b = btn_b.value cur_c = btn_c.value diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index 3433207..6f44731 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -37,6 +37,7 @@ # Start with the custom badge page pybadger.show_custom_badge() + # This task responds to buttons and changes the visible page async def ui_task(): while True: From b6d6cb73fd2df6c1de9e46b4a61113483f13fcf6 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 21/33] Update .pylintrc, fix jQuery for docs Signed-off-by: Tekktrik --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index b029445..fd5d21b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,6 +18,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 9f1d4fb24d7e295d4a63972efae7dfab13f19a6f Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:18:12 -0500 Subject: [PATCH 22/33] "fix rtd theme " --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fd5d21b..7ea32e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,19 +116,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 4fde7fb9441703568f8555e6afc1ac7187999d7a Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Mon, 25 Sep 2023 19:44:57 -0400 Subject: [PATCH 23/33] fix doc API build --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 7ea32e1..eaff827 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -30,6 +30,7 @@ # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = [ "audioio", + "bitmaptools", "displayio", "neopixel", "analogio", From 5752d3ec4a419f1a429713a78e9236fa56700f6f Mon Sep 17 00:00:00 2001 From: RetiredWizard Date: Fri, 3 Nov 2023 17:50:57 -0400 Subject: [PATCH 24/33] Replace depreciated .show() --- adafruit_pybadger/pybadger_base.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 0059c09..9c55081 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -652,7 +652,7 @@ def show(self, group) -> None: """Show the given group, refreshing the screen immediately""" self.activity() self.display.auto_refresh = False - self.display.show(group) + self.display.root_group = group self.display.refresh() self.display.auto_refresh = True From 9a6b39cd0621ef6e4ef0af35e9f01772970ed8f6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 25/33] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From af60fede3d48b72fc5465b3d72e673dafac9162b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Mar 2024 20:51:05 -0500 Subject: [PATCH 26/33] change badgerbase.show to root_group --- adafruit_pybadger/pybadger_base.py | 20 +++++++++++++------- examples/pybadger_pygamer_asyncio.py | 2 +- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 9c55081..8242bc8 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -165,7 +165,7 @@ def _create_badge_background(self) -> None: if self._background_group is None: self._background_group = displayio.Group() - self.show(self._background_group) + self.root_group = self._background_group if self._background_image_filename: file_handle = open( # pylint: disable=consider-using-with @@ -359,7 +359,7 @@ def show_custom_badge(self) -> None: if not self._created_background: self._create_badge_background() - self.show(self._background_group) + self.root_group = self._background_group # pylint: disable=too-many-arguments def _create_label_group( @@ -561,7 +561,7 @@ def show_business_card( business_card_splash.append(face_image) for group in business_card_label_groups: business_card_splash.append(group) - self.show(business_card_splash) + self.root_group = business_card_splash # pylint: disable=too-many-locals def show_badge( @@ -646,9 +646,15 @@ def show_badge( group.append(hello_group) group.append(my_name_is_group) group.append(name_group) - self.show(group) + self.root_group = group - def show(self, group) -> None: + @property + def root_group(self): + """The currently showing Group""" + return self.display.root_group + + @root_group.setter + def root_group(self, group): """Show the given group, refreshing the screen immediately""" self.activity() self.display.auto_refresh = False @@ -658,7 +664,7 @@ def show(self, group) -> None: def show_terminal(self) -> None: """Revert to terminalio screen.""" - self.show(None) + self.root_group = displayio.CIRCUITPYTHON_TERMINAL @staticmethod def bitmap_qr(matrix: adafruit_miniqr.QRBitMatrix) -> displayio.Bitmap: @@ -710,7 +716,7 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: ) qr_code = displayio.Group(scale=qr_code_scale) qr_code.append(qr_img) - self.show(qr_code) + self.root_group = qr_code @staticmethod def _sine_sample(length: int) -> Generator[int, None, None]: diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index 6f44731..d264101 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -50,7 +50,7 @@ async def ui_task(): email_string_two=pronoun, ) elif pybadger.button.b: - pybadger.show(qr_gp) + pybadger.root_group = qr_gp elif pybadger.button.start: pybadger.show_custom_badge() elif pybadger.button.select: From 0c1766e738f4c3dce7c3c494b34d26db219c4933 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 27/33] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index eaff827..6eac243 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -120,7 +120,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 443c5ed798a2e21b833ef5387e3aa836e0cf72d6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 28/33] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 4fa8c96cc4ba453aff7dc801633b9c75b75e159e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 1 Apr 2025 09:52:52 -0500 Subject: [PATCH 29/33] attempt new accelerometer init if first one fails --- adafruit_pybadger/clue.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 9b8528b..2504086 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -30,6 +30,7 @@ import audiopwmio import keypad import adafruit_lsm6ds.lsm6ds33 +import adafruit_lsm6ds.lsm6ds3trc import neopixel from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates @@ -51,7 +52,10 @@ def __init__(self) -> None: i2c = board.I2C() if i2c is not None: - self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + try: + self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + except RuntimeError: + self._accelerometer = adafruit_lsm6ds.lsm6ds3trc.LSM6DS3TRC(i2c) # NeoPixels self._neopixels = neopixel.NeoPixel( From 6043a1fa3ffef2f194e74b9faf83a9b3037714bc Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 21 May 2025 11:11:09 -0500 Subject: [PATCH 30/33] use ruff, correct homepage url in pyproject.toml --- .gitattributes | 11 ++ .pre-commit-config.yaml | 43 ++------ README.rst | 6 +- adafruit_pybadger/clue.py | 16 +-- adafruit_pybadger/cpb_gizmo.py | 19 ++-- adafruit_pybadger/magtag.py | 5 +- adafruit_pybadger/pewpewm4.py | 11 +- adafruit_pybadger/pybadge.py | 21 ++-- adafruit_pybadger/pybadger_base.py | 88 ++++++--------- adafruit_pybadger/pygamer.py | 22 ++-- adafruit_pybadger/pyportal.py | 6 +- docs/api.rst | 3 + docs/conf.py | 8 +- docs/mocks/keypad.py | 2 +- examples/pybadger_button_debouncing.py | 1 + examples/pybadger_clue_custom_badge.py | 13 +-- examples/pybadger_clue_custom_image_badge.py | 5 +- examples/pybadger_custom_badge.py | 13 +-- examples/pybadger_magtag_simpletest.py | 9 +- examples/pybadger_pewpewm4_simpletest.py | 11 +- examples/pybadger_pygamer_asyncio.py | 13 +-- examples/pybadger_pyportal_touchscreen.py | 14 +-- examples/pybadger_simpletest.py | 8 +- pyproject.toml | 2 +- ruff.toml | 108 +++++++++++++++++++ 25 files changed, 251 insertions(+), 207 deletions(-) create mode 100644 .gitattributes create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 179cf07..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string,duplicate-code - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/README.rst b/README.rst index 135e307..811883b 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag. diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index 2504086..f99e14a 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -26,13 +26,15 @@ """ from collections import namedtuple -import board + +import adafruit_lsm6ds.lsm6ds3trc +import adafruit_lsm6ds.lsm6ds33 import audiopwmio +import board import keypad -import adafruit_lsm6ds.lsm6ds33 -import adafruit_lsm6ds.lsm6ds3trc import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates + +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -84,9 +86,7 @@ def button(self) -> Buttons: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -101,5 +101,5 @@ def _unsupported(self): light = _unsupported -clue = Clue() # pylint: disable=invalid-name +clue = Clue() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 82f6c29..dffdab7 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -27,17 +27,18 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio -import busio import audiopwmio +import board +import busio +import digitalio import keypad -from adafruit_gizmo import tft_gizmo -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_gizmo import tft_gizmo +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -91,9 +92,7 @@ def button(self) -> Buttons: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -106,5 +105,5 @@ def _unsupported(self): # NotImplementedError raised in the property above. -cpb_gizmo = CPB_Gizmo() # pylint: disable=invalid-name +cpb_gizmo = CPB_Gizmo() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 46237ee..0f3251c 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -26,10 +26,11 @@ """ from collections import namedtuple + import board import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase +from adafruit_pybadger.pybadger_base import PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -81,5 +82,5 @@ def _unsupported(self): button = _unsupported -magtag = MagTag() # pylint: disable=invalid-name +magtag = MagTag() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index c9cdf21..cd8f3cd 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -26,11 +26,12 @@ """ from collections import namedtuple -import board + import audioio +import board import keypad -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -80,9 +81,7 @@ def button(self) -> Buttons: print("Button O") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -106,5 +105,5 @@ def _unsupported(self): pixels = _unsupported -pewpewm4 = PewPewM4() # pylint: disable=invalid-name +pewpewm4 = PewPewM4() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index dc93377..312750a 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -31,15 +31,16 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio import audioio +import board +import digitalio import keypad -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -75,12 +76,10 @@ def __init__(self) -> None: break # PyBadge LC doesn't have accelerometer - if int(0x18) in _i2c_devices or int(0x19) in _i2c_devices: + if 0x18 in _i2c_devices or 0x19 in _i2c_devices: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -122,9 +121,7 @@ def button(self) -> Buttons: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -137,5 +134,5 @@ def button(self) -> Buttons: ) -pybadge = PyBadge() # pylint: disable=invalid-name +pybadge = PyBadge() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 8242bc8..2dd32ae 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -29,19 +29,19 @@ from __future__ import annotations - -import time import array import math +import time + +import adafruit_miniqr import board -from micropython import const import digitalio -from adafruit_bitmap_font import bitmap_font import displayio +import terminalio +from adafruit_bitmap_font import bitmap_font from adafruit_display_shapes.rect import Rect from adafruit_display_text import bitmap_label as label -import terminalio -import adafruit_miniqr +from micropython import const AUDIO_ENABLED = False try: @@ -63,9 +63,10 @@ TYPE_CHECKING = const(0) if TYPE_CHECKING: - from typing import Union, Tuple, Optional, Generator - from adafruit_bitmap_font.bdf import BDF # pylint: disable=ungrouped-imports - from adafruit_bitmap_font.pcf import PCF # pylint: disable=ungrouped-imports + from typing import Generator, Optional, Union + + from adafruit_bitmap_font.bdf import BDF + from adafruit_bitmap_font.pcf import PCF from fontio import BuiltinFont from keypad import Keys, ShiftRegisterKeys from neopixel import NeoPixel @@ -87,7 +88,6 @@ def load_font(fontname: str, text: str) -> Union[BDF, PCF]: return font -# pylint: disable=too-many-instance-attributes class PyBadgerBase: """PyBadger base class.""" @@ -168,9 +168,7 @@ def _create_badge_background(self) -> None: self.root_group = self._background_group if self._background_image_filename: - file_handle = open( # pylint: disable=consider-using-with - self._background_image_filename, "rb" - ) + file_handle = open(self._background_image_filename, "rb") on_disk_bitmap = displayio.OnDiskBitmap(file_handle) background_image = displayio.TileGrid( on_disk_bitmap, @@ -182,8 +180,8 @@ def _create_badge_background(self) -> None: def badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -219,8 +217,8 @@ def badge_background( def _badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -231,9 +229,7 @@ def _badge_background( color_palette = displayio.Palette(1) color_palette[0] = background_color - bg_sprite = displayio.TileGrid( - color_bitmap, pixel_shader=color_palette, x=0, y=0 - ) + bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) background_group.append(bg_sprite) rectangle = Rect( @@ -263,11 +259,10 @@ def image_background(self, image_name: Optional[str] = None) -> None: """ self._background_image_filename = image_name - # pylint: disable=too-many-arguments def badge_line( self, text: str = " ", - color: Tuple[int, int, int] = BLACK, + color: tuple[int, int, int] = BLACK, scale: int = 1, font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, left_justify: bool = False, @@ -361,7 +356,6 @@ def show_custom_badge(self) -> None: self.root_group = self._background_group - # pylint: disable=too-many-arguments def _create_label_group( self, text: str, @@ -399,10 +393,7 @@ def _check_for_movement(self, movement_threshold: int = 10) -> bool: self._last_accelerometer = current_accelerometer return False acceleration_delta = sum( - ( - abs(self._last_accelerometer[n] - current_accelerometer[n]) - for n in range(3) - ) + abs(self._last_accelerometer[n] - current_accelerometer[n]) for n in range(3) ) self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold @@ -449,13 +440,9 @@ def light(self) -> bool: return self._light_sensor.value @property - def acceleration(self) -> Tuple[int, int, int]: + def acceleration(self) -> tuple[int, int, int]: """Accelerometer data, +/- 2G sensitivity.""" - return ( - self._accelerometer.acceleration - if self._accelerometer is not None - else (0, 0, 0) - ) + return self._accelerometer.acceleration if self._accelerometer is not None else (0, 0, 0) @property def brightness(self) -> float: @@ -467,7 +454,6 @@ def brightness(self, value: float) -> None: self._display_brightness = value self.display.brightness = value - # pylint: disable=too-many-locals def show_business_card( self, *, @@ -553,24 +539,21 @@ def show_business_card( business_card_label_groups.append(email_two_group) business_card_splash = displayio.Group() - image_file = open(image_name, "rb") # pylint: disable=consider-using-with + image_file = open(image_name, "rb") on_disk_bitmap = displayio.OnDiskBitmap(image_file) - face_image = displayio.TileGrid( - on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader - ) + face_image = displayio.TileGrid(on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader) business_card_splash.append(face_image) for group in business_card_label_groups: business_card_splash.append(group) self.root_group = business_card_splash - # pylint: disable=too-many-locals def show_badge( self, *, - background_color: Tuple[int, int, int] = RED, - foreground_color: Tuple[int, int, int] = WHITE, - background_text_color: Tuple[int, int, int] = WHITE, - foreground_text_color: Tuple[int, int, int] = BLACK, + background_color: tuple[int, int, int] = RED, + foreground_color: tuple[int, int, int] = WHITE, + background_text_color: tuple[int, int, int] = WHITE, + foreground_text_color: tuple[int, int, int] = BLACK, hello_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, hello_scale: int = 1, hello_string: str = "HELLO", @@ -705,12 +688,8 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: self.display.width // qr_bitmap.width, self.display.height // qr_bitmap.height, ) - qr_position_x = int( - ((self.display.width / qr_code_scale) - qr_bitmap.width) / 2 - ) - qr_position_y = int( - ((self.display.height / qr_code_scale) - qr_bitmap.height) / 2 - ) + qr_position_x = int(((self.display.width / qr_code_scale) - qr_bitmap.width) / 2) + qr_position_y = int(((self.display.height / qr_code_scale) - qr_bitmap.height) / 2) qr_img = displayio.TileGrid( qr_bitmap, pixel_shader=palette, x=qr_position_x, y=qr_position_y ) @@ -730,10 +709,7 @@ def _generate_sample(self, length: int = 100) -> None: if self._sample is not None: return self._sine_wave = array.array("H", PyBadgerBase._sine_sample(length)) - # pylint: disable=not-callable - self._sample = self._audio_out( - board.SPEAKER - ) # pylint: disable=not-callable + self._sample = self._audio_out(board.SPEAKER) self._sine_wave_sample = audiocore.RawSample(self._sine_wave) else: print("Required audio modules were missing") @@ -791,10 +767,8 @@ def play_file(self, file_name: str) -> None: # Play a specified file. self.stop_tone() self._enable_speaker(enable=True) - with self._audio_out(board.SPEAKER) as audio: # pylint: disable=not-callable - wavefile = audiocore.WaveFile( - open(file_name, "rb") # pylint: disable=consider-using-with - ) + with self._audio_out(board.SPEAKER) as audio: + wavefile = audiocore.WaveFile(open(file_name, "rb")) audio.play(wavefile) while audio.playing: pass diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index bccdb76..c22d2c8 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -26,14 +26,16 @@ """ from collections import namedtuple -import board + +import adafruit_lis3dh import analogio -import digitalio import audioio -import neopixel +import board +import digitalio import keypad -import adafruit_lis3dh -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +import neopixel + +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase try: from typing import Tuple @@ -59,9 +61,7 @@ def __init__(self) -> None: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -106,9 +106,7 @@ def button(self) -> Buttons: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) x, y = self.joystick return Buttons( button_values[0], @@ -129,5 +127,5 @@ def joystick(self) -> Tuple[int, int]: return x, y -pygamer = PyGamer() # pylint: disable=invalid-name +pygamer = PyGamer() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 1345183..38790a0 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -24,10 +24,12 @@ https://github.com/adafruit/circuitpython/releases """ -import board + import analogio import audioio +import board import neopixel + from adafruit_pybadger.pybadger_base import PyBadgerBase __version__ = "0.0.0+auto.0" @@ -62,5 +64,5 @@ def _unsupported(self): auto_dim_display = _unsupported -pyportal = PyPortal() # pylint: disable=invalid-name +pyportal = PyPortal() """Object that is automatically created on import.""" diff --git a/docs/api.rst b/docs/api.rst index a50522d..8db5080 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_pybadger.pybadger_base :members: diff --git a/docs/conf.py b/docs/conf.py index 6eac243..2892cc5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) sys.path.insert(0, os.path.abspath("mocks")) @@ -64,9 +62,7 @@ creation_year = "2019" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py index 5fcd12a..5226b76 100644 --- a/docs/mocks/keypad.py +++ b/docs/mocks/keypad.py @@ -26,7 +26,7 @@ def __init__( key_count, value_when_pressed, interval=0.020, - max_events=64 + max_events=64, ): self.key_count = 123 self.events = EventQueue() diff --git a/examples/pybadger_button_debouncing.py b/examples/pybadger_button_debouncing.py index 9e13756..4617dee 100644 --- a/examples/pybadger_button_debouncing.py +++ b/examples/pybadger_button_debouncing.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT from adafruit_debouncer import Debouncer + from adafruit_pybadger import pybadger b_btn = Debouncer(lambda: pybadger.button.b == 0) diff --git a/examples/pybadger_clue_custom_badge.py b/examples/pybadger_clue_custom_badge.py index e322dcb..db16e69 100644 --- a/examples/pybadger_clue_custom_badge.py +++ b/examples/pybadger_clue_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=6) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7) pybadger.show_custom_badge() diff --git a/examples/pybadger_clue_custom_image_badge.py b/examples/pybadger_clue_custom_image_badge.py index c7bab34..777831d 100644 --- a/examples/pybadger_clue_custom_image_badge.py +++ b/examples/pybadger_clue_custom_image_badge.py @@ -2,15 +2,14 @@ # SPDX-License-Identifier: MIT """Custom image badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.image_background("Blinka_CLUE.bmp") pybadger.badge_line(text="@circuitpython", color=pybadger.SKY, scale=2, padding_above=2) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) pybadger.badge_line(text="she/her", color=pybadger.SKY, scale=4, padding_above=4) while True: diff --git a/examples/pybadger_custom_badge.py b/examples/pybadger_custom_badge.py index 070c191..1ccfed7 100644 --- a/examples/pybadger_custom_badge.py +++ b/examples/pybadger_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge for PyBadge or PyGamer.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=3, padding_above=2) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2) while True: pybadger.show_custom_badge() diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index 5c68c23..a92db0f 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -2,10 +2,13 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Mag Tag. - Use the A, B, and C buttons to change between examples.""" +Use the A, B, and C buttons to change between examples.""" + import time + import board import digitalio + from adafruit_pybadger import pybadger @@ -44,9 +47,7 @@ def try_refresh(): SHOWING = "badge" -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) try_refresh() diff --git a/examples/pybadger_pewpewm4_simpletest.py b/examples/pybadger_pewpewm4_simpletest.py index 1094d42..0c71069 100644 --- a/examples/pybadger_pewpewm4_simpletest.py +++ b/examples/pybadger_pewpewm4_simpletest.py @@ -2,12 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Pew Pew M4. - Use the O, X, and Z buttons to change between examples.""" +Use the O, X, and Z buttons to change between examples.""" + from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 -) +pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) while True: if pybadger.button.o: @@ -23,6 +22,4 @@ elif pybadger.button.x: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.z: - pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index d264101..c3ac367 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2022 Jeff Epler for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=consider-using-with import asyncio -from displayio import TileGrid, OnDiskBitmap, Group + +from displayio import Group, OnDiskBitmap, TileGrid from rainbowio import colorwheel + from adafruit_pybadger import pybadger # If you choose to enter a pronoun it's shown on the "business card" page @@ -26,13 +27,9 @@ rectangle_height=0.55, ) -pybadger.badge_line( - text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1 -) +pybadger.badge_line(text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1) pybadger.badge_line(text=custom_line1, color=pybadger.WHITE, scale=6, padding_above=1) -pybadger.badge_line( - text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25 -) +pybadger.badge_line(text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25) # Start with the custom badge page pybadger.show_custom_badge() diff --git a/examples/pybadger_pyportal_touchscreen.py b/examples/pybadger_pyportal_touchscreen.py index 10ce9c4..7633b26 100644 --- a/examples/pybadger_pyportal_touchscreen.py +++ b/examples/pybadger_pyportal_touchscreen.py @@ -2,11 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using Adafruit PyPortal. Uses the touchscreen to advance between examples.""" -import board + import adafruit_touchscreen -from adafruit_pybadger import pybadger +import board -# pylint: disable=invalid-name +from adafruit_pybadger import pybadger # These pins are used as both analog and digital! XL, XR and YU must be analog # and digital capable. YD just need to be digital @@ -19,9 +19,7 @@ size=(320, 240), ) -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) cur_example = 0 prev_touch = None @@ -45,6 +43,4 @@ elif cur_example == 1: pybadger.show_qr_code(data="https://circuitpython.org") elif cur_example == 2: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) diff --git a/examples/pybadger_simpletest.py b/examples/pybadger_simpletest.py index a720208..dd3657b 100644 --- a/examples/pybadger_simpletest.py +++ b/examples/pybadger_simpletest.py @@ -3,9 +3,7 @@ from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) while True: pybadger.auto_dim_display( @@ -22,6 +20,4 @@ elif pybadger.button.b: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.start: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) diff --git a/pyproject.toml b/pyproject.toml index 71f1f03..8d4a8b1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,7 +17,7 @@ readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} ] -urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_REPLACE"} +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger"} keywords = [ "adafruit", "pybadge", diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..b485fab --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "UP007", # x | y type annotation +] + +[format] +line-ending = "lf" From f319370927ed9d0644cf20c54a3229b25966be48 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 21 May 2025 11:13:31 -0500 Subject: [PATCH 31/33] delete pylintrc --- .pylintrc | 399 ------------------------------------------------------ 1 file changed, 399 deletions(-) delete mode 100644 .pylintrc diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception From bb6a1fd7ed61698d8732ec4dd642015db8523021 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 32/33] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" From 436015ecdc4aaabbc228d0b17f9f878145143fab Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 27 Jun 2025 13:14:36 -0500 Subject: [PATCH 33/33] use new OnDiskBitmap API --- adafruit_pybadger/pybadger_base.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index 2dd32ae..67f4443 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -168,8 +168,7 @@ def _create_badge_background(self) -> None: self.root_group = self._background_group if self._background_image_filename: - file_handle = open(self._background_image_filename, "rb") - on_disk_bitmap = displayio.OnDiskBitmap(file_handle) + on_disk_bitmap = displayio.OnDiskBitmap(self._background_image_filename) background_image = displayio.TileGrid( on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader, pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy