From f7477eab82bcffb5ee21f14e82e314aff28831a7 Mon Sep 17 00:00:00 2001 From: dherrada Date: Sun, 29 Dec 2019 23:44:49 -0500 Subject: [PATCH 01/99] Moved repository from Travis to GitHub Actions --- .github/workflows/build.yml | 13 ++++++++----- .github/workflows/release.yml | 19 +++++++++++++++---- .gitignore | 1 - 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 54c6663..66ce4db 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -25,15 +25,18 @@ jobs: - name: Versions run: | python3 --version - - uses: actions/checkout@v1 + - 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: | - sudo apt-get install -y gettext - pip install -r requirements.txt - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme - pip install --force-reinstall pylint==1.9.2 + source actions-ci/install.sh - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 83fc810..18efb9c 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -27,14 +27,18 @@ jobs: - name: Versions run: | python3 --version - - uses: actions/checkout@v1 + - 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: | - sudo apt-get install -y gettext - pip install -r requirements.txt - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + 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 @@ -53,15 +57,22 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 + - name: Check For setup.py + id: need-pypi + run: | + echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') uses: actions/setup-python@v1 with: python-version: '3.x' - name: Install dependencies + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') run: | python -m pip install --upgrade pip pip install setuptools wheel twine - name: Build and publish + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 55f127b..c83f8b7 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ __pycache__ _build *.pyc .env -build* bundles *.DS_Store .eggs From 49190f4e10723ba1b22b7df075def6483f52e07e Mon Sep 17 00:00:00 2001 From: sommersoft Date: Wed, 8 Jan 2020 21:09:22 -0600 Subject: [PATCH 02/99] update pylint examples directive Signed-off-by: sommersoft --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 66ce4db..11ce574 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,7 +42,7 @@ jobs: - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - name: Build docs From 95c365711497529a6b9ccadef997157127812bbc Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 3 Mar 2020 00:28:48 -0600 Subject: [PATCH 03/99] build.yml: move pylint, black, and Sphinx installs to each repo; add description to 'actions-ci/install.sh' Signed-off-by: sommersoft --- .github/workflows/build.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 11ce574..fff3aa9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -34,9 +34,13 @@ jobs: with: repository: adafruit/actions-ci-circuitpython-libs path: actions-ci - - name: Install deps + - 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 pylint, black, & Sphinx + run: | + pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint From 45cd0b43e9f7752ec3a13d5c45ba0052340a50da Mon Sep 17 00:00:00 2001 From: sommersoft Date: Thu, 5 Mar 2020 22:06:59 -0600 Subject: [PATCH 04/99] update pylintrc for black Signed-off-by: sommersoft --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 039eaec..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -52,7 +52,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error +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 # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From d0e416d9e8fd4f931ecb8f86e51416b4f39cc0db Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 12 Mar 2020 19:01:31 -0400 Subject: [PATCH 05/99] Ran black, updated to pylint 2.x --- .github/workflows/build.yml | 2 +- adafruit_rgbled.py | 16 ++--- docs/conf.py | 112 ++++++++++++++++++++-------------- examples/rgbled_blink.py | 10 +-- examples/rgbled_pca9685.py | 11 ++-- examples/rgbled_simpletest.py | 3 + setup.py | 52 +++++++--------- 7 files changed, 111 insertions(+), 95 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: source actions-ci/install.sh - name: Pip install pylint, black, & Sphinx run: | - pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 23632b1..3e58f9e 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -43,6 +43,7 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGBLED.git" + class RGBLED: """ Creates a RGBLED object given three physical pins or PWMOut objects. @@ -111,16 +112,17 @@ class RGBLED: rgb_led.color = (0, 255, 0) """ + def __init__(self, red_pin, green_pin, blue_pin, invert_pwm=False): self._rgb_led_pins = [red_pin, green_pin, blue_pin] for i in range(len(self._rgb_led_pins)): - if hasattr(self._rgb_led_pins[i], 'frequency'): + if hasattr(self._rgb_led_pins[i], "frequency"): self._rgb_led_pins[i].duty_cycle = 0 elif str(type(self._rgb_led_pins[i])) == "": self._rgb_led_pins[i] = PWMOut(self._rgb_led_pins[i]) self._rgb_led_pins[i].duty_cycle = 0 else: - raise TypeError('Must provide a pin, PWMOut, or PWMChannel.') + raise TypeError("Must provide a pin, PWMOut, or PWMChannel.") self._invert_pwm = invert_pwm self._current_color = (0, 0, 0) self.color = self._current_color @@ -134,7 +136,7 @@ def __exit__(self, exception_type, exception_value, traceback): def deinit(self): """Turn the LEDs off, deinit pwmout and release hardware resources.""" for pin in self._rgb_led_pins: - pin.deinit() #pylint: no-member + pin.deinit() # pylint: no-member self._current_color = (0, 0, 0) @property @@ -155,11 +157,11 @@ def color(self, value): color -= 65535 self._rgb_led_pins[i].duty_cycle = abs(color) elif isinstance(value, int): - if value>>24: + if value >> 24: raise ValueError("Only bits 0->23 valid for integer input") r = value >> 16 - g = (value >> 8) & 0xff - b = value & 0xff + g = (value >> 8) & 0xFF + b = value & 0xFF rgb = [r, g, b] for color in range(0, 3): rgb[color] = int(map_range(rgb[color], 0, 255, 0, 65535)) @@ -167,4 +169,4 @@ def color(self, value): rgb[color] -= 65535 self._rgb_led_pins[color].duty_cycle = abs(rgb[color]) else: - raise ValueError('Color must be a tuple or 24-bit integer value.') + raise ValueError("Color must be a tuple or 24-bit integer value.") diff --git a/docs/conf.py b/docs/conf.py index 00bd13a..1fbbfd2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,32 @@ autodoc_mock_imports = ["pulseio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", None), + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), +} # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit RGBLED Library' -copyright = u'2019 Brent Rubell' -author = u'Brent Rubell' +project = "Adafruit RGBLED Library" +copyright = "2019 Brent Rubell" +author = "Brent Rubell" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'1.0' +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -57,7 +61,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -69,7 +73,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +88,62 @@ # 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' +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(), '.'] + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] except: - html_theme = 'default' - html_theme_path = ['.'] + html_theme = "default" + html_theme_path = ["."] else: - html_theme_path = ['.'] + 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # -html_favicon = '_static/favicon.ico' +html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitRgbledLibrarydoc' +htmlhelp_basename = "AdafruitRgbledLibrarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'AdafruitRGBLEDLibrary.tex', u'AdafruitRGBLED Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitRGBLEDLibrary.tex", + "AdafruitRGBLED Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitRGBLEDlibrary', u'Adafruit RGBLED Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitRGBLEDlibrary", + "Adafruit RGBLED Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitRGBLEDLibrary', u'Adafruit RGBLED Library Documentation', - author, 'AdafruitRGBLEDLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitRGBLEDLibrary", + "Adafruit RGBLED Library Documentation", + author, + "AdafruitRGBLEDLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/rgbled_blink.py b/examples/rgbled_blink.py index 27d3f9e..700e5c3 100755 --- a/examples/rgbled_blink.py +++ b/examples/rgbled_blink.py @@ -5,12 +5,12 @@ import adafruit_rgbled # Configure the setup -RED_LED = board.D5 # Pin the Red LED is connected to -GREEN_LED = board.D6 # Pin the Green LED is connected to -BLUE_LED = board.D7 # Pin the Blue LED is connected to +RED_LED = board.D5 # Pin the Red LED is connected to +GREEN_LED = board.D6 # Pin the Green LED is connected to +BLUE_LED = board.D7 # Pin the Blue LED is connected to COLOR = (100, 50, 150) # color to blink -CLEAR = (0, 0, 0) # clear (or second color) -DELAY = 0.25 # blink rate in seconds +CLEAR = (0, 0, 0) # clear (or second color) +DELAY = 0.25 # blink rate in seconds # Create the RGB LED object led = adafruit_rgbled.RGBLED(RED_LED, GREEN_LED, BLUE_LED) diff --git a/examples/rgbled_pca9685.py b/examples/rgbled_pca9685.py index 87d5c05..3a27889 100644 --- a/examples/rgbled_pca9685.py +++ b/examples/rgbled_pca9685.py @@ -7,7 +7,7 @@ # PCA9685 Initialization i2c = busio.I2C(board.SCL, board.SDA) pca = adafruit_pca9685.PCA9685(i2c) -pca.frequency=60 +pca.frequency = 60 # PCA9685 LED Channels RED_LED = pca.channels[0] @@ -20,6 +20,7 @@ # Optionally, you can also create the RGB LED object with inverted PWM # led = adafruit_rgbled.RGBLED(RED_LED, GREEN_LED, BLUE_LED, invert_pwm=True) + def wheel(pos): # Input a value 0 to 255 to get a color value. # The colours are a transition r - g - b - back to r. @@ -33,23 +34,25 @@ def wheel(pos): pos -= 170 return int(pos * 3), 0, int(255 - (pos * 3)) + def rainbow_cycle(wait): for i in range(255): i = (i + 1) % 256 led.color = wheel(i) time.sleep(wait) + while True: # setting RGB LED color to RGB Tuples (R, G, B) - print('setting color 1') + print("setting color 1") led.color = (255, 0, 0) time.sleep(1) - print('setting color 2') + print("setting color 2") led.color = (0, 255, 0) time.sleep(1) - print('setting color 3') + print("setting color 3") led.color = (0, 0, 255) time.sleep(1) diff --git a/examples/rgbled_simpletest.py b/examples/rgbled_simpletest.py index f4cd4ee..aa8d192 100644 --- a/examples/rgbled_simpletest.py +++ b/examples/rgbled_simpletest.py @@ -17,6 +17,7 @@ # Optionally, you can also create the RGB LED object with inverted PWM # led = adafruit_rgbled.RGBLED(RED_LED, GREEN_LED, BLUE_LED, invert_pwm=True) + def wheel(pos): # Input a value 0 to 255 to get a color value. # The colours are a transition r - g - b - back to r. @@ -30,12 +31,14 @@ def wheel(pos): pos -= 170 return int(pos * 3), 0, int(255 - (pos * 3)) + def rainbow_cycle(wait): for i in range(255): i = (i + 1) % 256 led.color = wheel(i) time.sleep(wait) + while True: # setting RGB LED color to RGB Tuples (R, G, B) led.color = (255, 0, 0) diff --git a/setup.py b/setup.py index 5276bfa..a4ffc1e 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,51 +14,40 @@ 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: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-rgbled', - + name="adafruit-circuitpython-rgbled", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython driver for RGB LEDs', + setup_requires=["setuptools_scm"], + description="CircuitPython driver for RGB LEDs", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_RGBLED', - + url="https://github.com/adafruit/Adafruit_CircuitPython_RGBLED", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=[ - 'Adafruit-Blinka' - ], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # Choose your license - license='MIT', - + 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', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", ], - # What does your project relate to? - keywords='adafruit blinka circuitpython micropython rgbled rgb, led, driver, pwm', - + keywords="adafruit blinka circuitpython micropython rgbled rgb, led, driver, pwm", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_rgbled'], + py_modules=["adafruit_rgbled"], ) From 7132931d0c2077171e5b9fb50905f3417b3d3841 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Fri, 13 Mar 2020 13:25:59 -0500 Subject: [PATCH 06/99] update code of conduct --- CODE_OF_CONDUCT.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7ca3a1d..d79c514 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -34,6 +34,8 @@ Examples of unacceptable behavior by participants include: * Excessive or unwelcome helping; answering outside the scope of the question asked * Trolling, insulting/derogatory comments, and personal or political attacks +* Promoting or spreading disinformation, lies, or conspiracy theories against + a person, group, organisation, project, or community * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission @@ -41,7 +43,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -72,10 +74,10 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Helpers by tagging @community moderators. You may also send an +to all Community Helpers by tagging @community helpers. You may also send an open message from any channel, or a direct message to @kattni#1507, -@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or -@Andon#8175. +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, +@Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. From 952c3ecb70846a60a428f6367187a3d472517553 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sun, 15 Mar 2020 11:49:22 -0500 Subject: [PATCH 07/99] update code of coduct: discord moderation contact section Signed-off-by: sommersoft --- CODE_OF_CONDUCT.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d79c514..134d510 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -74,10 +74,10 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Helpers by tagging @community helpers. You may also send an -open message from any channel, or a direct message to @kattni#1507, -@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, -@Mr. Certainly#0472 or @Andon#8175. +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. From 00e6342b909f5f331d200f42d1124ebd00485f3b Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 7 Apr 2020 15:02:31 -0500 Subject: [PATCH 08/99] build.yml: add black formatting check Signed-off-by: sommersoft --- .github/workflows/build.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1dad804..b6977a9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,6 +43,9 @@ jobs: pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags + - name: Check formatting + run: | + black --check --target-version=py35 . - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) From 2b3e5048143668dd28b6fba435dc2065f2324e7d Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 8 Jul 2020 16:49:05 -0400 Subject: [PATCH 09/99] Fixed discord invite link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index bcb0d67..baf22aa 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ CircuitPython_RGBLED :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg - :target: https://discord.gg/nBQh6qu + :target: https://adafru.it/discord :alt: Discord .. image:: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/workflows/Build%20CI/badge.svg From 747ad0ab6ffa71d460025875d0bd59f376d2ce56 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 9 Jul 2020 12:26:20 -0400 Subject: [PATCH 10/99] Should fix pylint failure --- adafruit_rgbled.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 3e58f9e..9bd9c59 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -136,7 +136,7 @@ def __exit__(self, exception_type, exception_value, traceback): def deinit(self): """Turn the LEDs off, deinit pwmout and release hardware resources.""" for pin in self._rgb_led_pins: - pin.deinit() # pylint: no-member + pin.deinit() # pylint: disable=no-member self._current_color = (0, 0, 0) @property From 715e97130e79e3dbd4919ed11debd43c16873253 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 15:06:44 -0500 Subject: [PATCH 11/99] Added pre-commit and SPDX copyright Signed-off-by: dherrada --- .github/workflows/build.yml | 28 ++++++++++++++++++++++++---- .github/workflows/release.yml | 4 ++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6977a9..59baa53 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Build CI on: [pull_request, push] @@ -38,20 +42,36 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, black, & Sphinx + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - - name: Check formatting + - name: Pre-commit hooks run: | - black --check --target-version=py35 . + pre-commit run --all-files - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - 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 setup.py + id: need-pypi + run: | + echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + run: | + pip install --upgrade setuptools wheel twine readme_renderer testresources + python setup.py sdist + python setup.py bdist_wheel --universal + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18efb9c..6d0015a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Release Actions on: From 0e9a6182049ac72b2acc9e59802d1afb7401ba0a Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 16:06:47 -0500 Subject: [PATCH 12/99] Added pre-commit-config file Signed-off-by: dherrada --- .pre-commit-config.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..aab5f1c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- repo: https://github.com/python/black + rev: stable + hooks: + - id: black +- repo: https://github.com/fsfe/reuse-tool + rev: latest + hooks: + - id: reuse +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace From 01c8f8fae9c296ba4d7259a2b61995d476495d7c Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 12 Jan 2021 13:08:35 -0500 Subject: [PATCH 13/99] Ran pre-commit, added licenses --- .gitignore | 6 +- .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 14 +- LICENSES/CC-BY-4.0.txt | 324 +++++++++++++++++++++++++++++++ LICENSES/MIT.txt | 19 ++ LICENSES/Unlicense.txt | 20 ++ README.rst | 4 +- README.rst.license | 3 + adafruit_rgbled.py | 23 +-- docs/_static/favicon.ico.license | 3 + docs/api.rst.license | 3 + docs/conf.py | 4 + docs/examples.rst.license | 3 + docs/index.rst.license | 3 + examples/rgbled_blink.py | 3 + examples/rgbled_pca9685.py | 3 + examples/rgbled_simpletest.py | 3 + requirements.txt | 6 +- setup.py | 4 + 20 files changed, 428 insertions(+), 28 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt create mode 100644 README.rst.license create mode 100644 docs/_static/favicon.ico.license create mode 100644 docs/api.rst.license create mode 100644 docs/examples.rst.license create mode 100644 docs/index.rst.license diff --git a/.gitignore b/.gitignore index c83f8b7..9647e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ @@ -8,4 +12,4 @@ bundles *.DS_Store .eggs dist -**/*.egg-info \ No newline at end of file +**/*.egg-info diff --git a/.pylintrc b/.pylintrc index d8f0ee8..5c31f66 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst b/README.rst index baf22aa..4af8bd9 100644 --- a/README.rst +++ b/README.rst @@ -72,7 +72,7 @@ Initialize a common-cathode RGB LED with three PWM-capable pins. # Create a RGB LED object led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) -Initialize a common-anode RGB LED with three PWM-capable pins +Initialize a common-anode RGB LED with three PWM-capable pins .. code-block:: python @@ -100,7 +100,7 @@ Set the RGB LED's color to a RGB Tuple (Red, Green, Blue). Set the RGB LED's color to a 24-bit integer (in hex syntax), 0x100000. .. code-block:: python - + led.color = 0x100000 Setting a common-anode RGB LED using a ContextManager: diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 9bd9c59..5cafe21 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Brent Rubell for Adafruit Industries # -# Copyright (c) 2019 Brent Rubell for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_rgbled` ================================================================================ diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 1fbbfd2..e34b856 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/examples/rgbled_blink.py b/examples/rgbled_blink.py index 700e5c3..c099cb5 100755 --- a/examples/rgbled_blink.py +++ b/examples/rgbled_blink.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + # This example shows how to create a single RGB LED with a specific color channel # order and blink it. import time diff --git a/examples/rgbled_pca9685.py b/examples/rgbled_pca9685.py index 3a27889..9f40b91 100644 --- a/examples/rgbled_pca9685.py +++ b/examples/rgbled_pca9685.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import time import board import busio diff --git a/examples/rgbled_simpletest.py b/examples/rgbled_simpletest.py index aa8d192..afd8baf 100644 --- a/examples/rgbled_simpletest.py +++ b/examples/rgbled_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import time import board import adafruit_rgbled diff --git a/requirements.txt b/requirements.txt index 3e78577..2a9ee0f 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka -adafruit-circuitpython-simpleio \ No newline at end of file +adafruit-circuitpython-simpleio diff --git a/setup.py b/setup.py index a4ffc1e..b4d770d 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: From 9f7bc012a40171186ce199b6975d001d735d78bb Mon Sep 17 00:00:00 2001 From: Dylan Herrada <33632497+dherrada@users.noreply.github.com> Date: Wed, 27 Jan 2021 19:04:08 -0500 Subject: [PATCH 14/99] Moved from pulseio.PWMOut to pwmio.PWMOut --- adafruit_rgbled.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 5cafe21..cb46dd0 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -20,7 +20,7 @@ * Adafruit's SimpleIO library: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO """ -from pulseio import PWMOut +from pwmio import PWMOut from simpleio import map_range __version__ = "0.0.0-auto.0" @@ -33,15 +33,15 @@ class RGBLED: :param red_pin: The physical pin connected to a red LED anode. :type ~microcontroller.Pin: Microcontroller's red_pin. - :type pulseio.PWMOut: PWMOut object associated with red_pin. + :type pwmio.PWMOut: PWMOut object associated with red_pin. :type PWMChannel: PCA9685 PWM channel associated with red_pin. :param green_pin: The physical pin connected to a green LED anode. :type ~microcontroller.Pin: Microcontroller's green_pin. - :type pulseio.PWMOut: PWMOut object associated with green_pin. + :type pwmio.PWMOut: PWMOut object associated with green_pin. :type PWMChannel: PCA9685 PWM channel associated with green_pin. :param blue_pin: The physical pin connected to a blue LED anode. :type ~microcontroller.Pin: Microcontroller's blue_pin. - :type pulseio.PWMOut: PWMOut object associated with blue_pin. + :type pwmio.PWMOut: PWMOut object associated with blue_pin. :type PWMChannel: PCA9685 PWM channel associated with blue_pin. :param bool invert_pwm: False if the RGB LED is common cathode, true if the RGB LED is common anode. From 556a7c85667908b66329a734b88c9021c35632cb Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Feb 2021 16:38:51 -0500 Subject: [PATCH 15/99] Hardcoded Black and REUSE versions Signed-off-by: dherrada --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aab5f1c..07f886c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,11 +4,11 @@ repos: - repo: https://github.com/python/black - rev: stable + rev: 20.8b1 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: latest + rev: v0.12.1 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks From 5c6ef4f7f8acbaa206b245396570cd5832978f4c Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 16:46:17 -0500 Subject: [PATCH 16/99] Removed pylint process from github workflow Signed-off-by: dherrada --- .github/workflows/build.yml | 8 ++------ .pre-commit-config.yaml | 15 +++++++++++++++ .pylintrc | 2 +- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 59baa53..621d5ef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,18 +42,14 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks run: | pre-commit run --all-files - - name: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - name: Archive bundles diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 07f886c..354c761 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,3 +17,18 @@ repos: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace +- repo: https://github.com/pycqa/pylint + rev: pylint-2.7.1 + hooks: + - id: pylint + name: pylint (library code) + types: [python] + exclude: "^(docs/|examples/|setup.py$)" +- repo: local + hooks: + - id: pylint_examples + name: pylint (examples code) + description: Run pylint rules on "examples/*.py" files + entry: /usr/bin/env bash -c + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + language: system diff --git a/.pylintrc b/.pylintrc index 5c31f66..9ed669e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -250,7 +250,7 @@ ignore-comments=yes ignore-docstrings=yes # Ignore imports when computing similarities. -ignore-imports=no +ignore-imports=yes # Minimum lines number of a similarity. min-similarity-lines=4 From c3f980529a186fe446954581599101c88eff7cea Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 17:17:50 -0500 Subject: [PATCH 17/99] Re-added pylint install to build.yml Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 621d5ef..3baf502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (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 + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks From dbbde2ba4d2633bbbd1324de379e6b4440f74cfc Mon Sep 17 00:00:00 2001 From: Dylan Herrada <33632497+dherrada@users.noreply.github.com> Date: Wed, 27 Jan 2021 19:04:08 -0500 Subject: [PATCH 18/99] Moved from pulseio.PWMOut to pwmio.PWMOut --- adafruit_rgbled.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 5cafe21..cb46dd0 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -20,7 +20,7 @@ * Adafruit's SimpleIO library: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO """ -from pulseio import PWMOut +from pwmio import PWMOut from simpleio import map_range __version__ = "0.0.0-auto.0" @@ -33,15 +33,15 @@ class RGBLED: :param red_pin: The physical pin connected to a red LED anode. :type ~microcontroller.Pin: Microcontroller's red_pin. - :type pulseio.PWMOut: PWMOut object associated with red_pin. + :type pwmio.PWMOut: PWMOut object associated with red_pin. :type PWMChannel: PCA9685 PWM channel associated with red_pin. :param green_pin: The physical pin connected to a green LED anode. :type ~microcontroller.Pin: Microcontroller's green_pin. - :type pulseio.PWMOut: PWMOut object associated with green_pin. + :type pwmio.PWMOut: PWMOut object associated with green_pin. :type PWMChannel: PCA9685 PWM channel associated with green_pin. :param blue_pin: The physical pin connected to a blue LED anode. :type ~microcontroller.Pin: Microcontroller's blue_pin. - :type pulseio.PWMOut: PWMOut object associated with blue_pin. + :type pwmio.PWMOut: PWMOut object associated with blue_pin. :type PWMChannel: PCA9685 PWM channel associated with blue_pin. :param bool invert_pwm: False if the RGB LED is common cathode, true if the RGB LED is common anode. From e8f42635469cfff0a9989002c1e597ece0bb60bf Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 19 Mar 2021 13:48:10 -0400 Subject: [PATCH 19/99] "Increase duplicate code check threshold " --- .pylintrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.pylintrc b/.pylintrc index 9ed669e..0238b90 100644 --- a/.pylintrc +++ b/.pylintrc @@ -22,8 +22,7 @@ ignore-patterns= #init-hook= # Use multiple processes to speed up Pylint. -# jobs=1 -jobs=2 +jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. @@ -253,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From eb5dc3472f29ec07403b26933945d9667f64a70d Mon Sep 17 00:00:00 2001 From: Kattni Date: Tue, 6 Apr 2021 14:59:25 -0400 Subject: [PATCH 20/99] Update conf.py --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e34b856..c73f9b6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,7 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["pulseio"] +autodoc_mock_imports = ["pwmio"] intersphinx_mapping = { From cdff5ec665d1f32477ac8006ded5caba3bded8b2 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:32:42 -0400 Subject: [PATCH 21/99] Added pull request template Signed-off-by: dherrada --- .../adafruit_circuitpython_pr.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md new file mode 100644 index 0000000..71ef8f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +Thank you for contributing! Before you submit a pull request, please read the following. + +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html + +If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. From 5293ee533fc9f3b988d8315d6140e519fb827fbd Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:35:18 -0400 Subject: [PATCH 22/99] Added help text and problem matcher Signed-off-by: dherrada --- .github/workflows/build.yml | 2 ++ .github/workflows/failure-help-text.yml | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .github/workflows/failure-help-text.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3baf502..0ab7182 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,3 +71,5 @@ jobs: python setup.py sdist python setup.py bdist_wheel --universal twine check dist/* + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 From 5a9e8acf95e72a39fdbcca5121d0fe708f44db4d Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 May 2021 09:54:31 -0400 Subject: [PATCH 23/99] Moved CI to Python 3.7 Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0ab7182..c4c975d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 + - name: Set up Python 3.7 uses: actions/setup-python@v1 with: - python-version: 3.6 + python-version: 3.7 - name: Versions run: | python3 --version From c31f90355172a45ba58a1fbcf3d44e4781bbb96c Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 7 Jun 2021 14:21:16 -0400 Subject: [PATCH 24/99] Moved default branch to main --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4af8bd9..9fcb7f1 100644 --- a/README.rst +++ b/README.rst @@ -116,7 +116,7 @@ Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Documentation From 64276b5e746fb8fa92fc9ead481a0b2df55c96d5 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 23 Sep 2021 14:32:08 -0400 Subject: [PATCH 25/99] Update examples to use rainbowio --- examples/rgbled_pca9685.py | 17 ++--------------- examples/rgbled_simpletest.py | 17 ++--------------- 2 files changed, 4 insertions(+), 30 deletions(-) diff --git a/examples/rgbled_pca9685.py b/examples/rgbled_pca9685.py index 9f40b91..425e801 100644 --- a/examples/rgbled_pca9685.py +++ b/examples/rgbled_pca9685.py @@ -4,6 +4,7 @@ import time import board import busio +from rainbowio import colorwheel import adafruit_pca9685 import adafruit_rgbled @@ -24,24 +25,10 @@ # led = adafruit_rgbled.RGBLED(RED_LED, GREEN_LED, BLUE_LED, invert_pwm=True) -def wheel(pos): - # Input a value 0 to 255 to get a color value. - # The colours are a transition r - g - b - back to r. - if pos < 0 or pos > 255: - return 0, 0, 0 - if pos < 85: - return int(255 - pos * 3), int(pos * 3), 0 - if pos < 170: - pos -= 85 - return 0, int(255 - pos * 3), int(pos * 3) - pos -= 170 - return int(pos * 3), 0, int(255 - (pos * 3)) - - def rainbow_cycle(wait): for i in range(255): i = (i + 1) % 256 - led.color = wheel(i) + led.color = colorwheel(i) time.sleep(wait) diff --git a/examples/rgbled_simpletest.py b/examples/rgbled_simpletest.py index afd8baf..7d3ae63 100644 --- a/examples/rgbled_simpletest.py +++ b/examples/rgbled_simpletest.py @@ -3,6 +3,7 @@ import time import board +from rainbowio import colorwheel import adafruit_rgbled # Pin the Red LED is connected to @@ -21,24 +22,10 @@ # led = adafruit_rgbled.RGBLED(RED_LED, GREEN_LED, BLUE_LED, invert_pwm=True) -def wheel(pos): - # Input a value 0 to 255 to get a color value. - # The colours are a transition r - g - b - back to r. - if pos < 0 or pos > 255: - return 0, 0, 0 - if pos < 85: - return int(255 - pos * 3), int(pos * 3), 0 - if pos < 170: - pos -= 85 - return 0, int(255 - pos * 3), int(pos * 3) - pos -= 170 - return int(pos * 3), 0, int(255 - (pos * 3)) - - def rainbow_cycle(wait): for i in range(255): i = (i + 1) % 256 - led.color = wheel(i) + led.color = colorwheel(i) time.sleep(wait) From 7e51d858af304cd1d4213a3dc43e156a14c770e1 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 23 Sep 2021 17:52:55 -0400 Subject: [PATCH 26/99] Globally disabled consider-using-f-string pylint check Signed-off-by: dherrada --- .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 354c761..8810708 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,5 +30,5 @@ repos: name: pylint (examples code) description: Run pylint rules on "examples/*.py" files entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] language: system From 764022c0859a778ed5a3a65a82000a6b1b65f0e2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 25 Oct 2021 11:30:31 -0500 Subject: [PATCH 27/99] add docs link to readme --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 9fcb7f1..3312d70 100644 --- a/README.rst +++ b/README.rst @@ -112,6 +112,11 @@ Setting a common-anode RGB LED using a ContextManager: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm = True) as rgb_led: rgb_led.color = (0, 255, 0) +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + Contributing ============ From 7ba5f429cd3744a64781e2dc71ba8129e563b4de Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Nov 2021 14:40:16 -0400 Subject: [PATCH 28/99] PATCH Pylint and readthedocs patch test Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- .pre-commit-config.yaml | 26 +++++++++++++++++--------- .pylintrc | 2 +- .readthedocs.yml | 2 +- docs/requirements.txt | 5 +++++ 5 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c4c975d..ca35544 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8810708..1b9fadc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,17 +18,25 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 + rev: v2.11.1 hooks: - id: pylint name: pylint (library code) types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) + args: + - --disable=consider-using-f-string + exclude: "^(docs/|examples/|tests/|setup.py$)" + - id: pylint + name: pylint (example code) description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] - language: system + 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 diff --git a/.pylintrc b/.pylintrc index 0238b90..e78bad2 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=12 +min-similarity-lines=4 [BASIC] diff --git a/.readthedocs.yml b/.readthedocs.yml index ffa84c4..49dcab3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,4 +4,4 @@ python: version: 3 -requirements_file: requirements.txt +requirements_file: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..88e6733 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx>=4.0.0 From 15d70331ee80266c8836864c97488e0a1e754cc8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 29/99] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index e78bad2..cfd1c41 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From dc6266fb69ac132d17016ed5332ee4166aa8ecff Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 30/99] Updated readthedocs file Signed-off-by: dherrada --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From f0f7bb7847dbf19269294c7cadac4e519ae3009f Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 15 Nov 2021 15:44:34 -0500 Subject: [PATCH 31/99] Linted --- adafruit_rgbled.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index cb46dd0..a8e9271 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -98,7 +98,9 @@ class RGBLED: def __init__(self, red_pin, green_pin, blue_pin, invert_pwm=False): self._rgb_led_pins = [red_pin, green_pin, blue_pin] - for i in range(len(self._rgb_led_pins)): + for i in range( # pylint: disable=consider-using-enumerate + len(self._rgb_led_pins) + ): if hasattr(self._rgb_led_pins[i], "frequency"): self._rgb_led_pins[i].duty_cycle = 0 elif str(type(self._rgb_led_pins[i])) == "": From b18c2ca480560da7afeb46d072139490832a3c0c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:16:16 -0600 Subject: [PATCH 32/99] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From b2935173324355e4d8adb0639f2329c734986b65 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 33/99] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..474520d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From cb62700a3760c070dd32752d1a97180cc399aacc Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 34/99] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 4 ++-- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 3312d70..2b7477f 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ CircuitPython_RGBLED ==================== .. image:: https://readthedocs.org/projects/adafruit-circuitpython-rgbled/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/rgbled/en/latest/ + :target: https://docs.circuitpython.org/projects/rgbled/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -115,7 +115,7 @@ Setting a common-anode RGB LED using a ContextManager: Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index c73f9b6..dfebd1a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,8 +29,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 1435e6d..fab19d5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index b4d770d..5768cd7 100644 --- a/setup.py +++ b/setup.py @@ -44,8 +44,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit blinka circuitpython micropython rgbled rgb, led, driver, pwm", From cb9b340f5aea50e9e4e616fb9a79f24f4f5fc47e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 10 Feb 2022 10:16:18 -0500 Subject: [PATCH 35/99] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 2b7477f..fbb7287 100644 --- a/README.rst +++ b/README.rst @@ -117,14 +117,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From 5eca924a584f7bd543d8640cea5a762ee7a4e9f7 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 36/99] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 3e4b1c639f4dd1662437c2f427d03ace49fd531a Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 37/99] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 7ae7129e3797172606d24a46a25bb4f888c39273 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 38/99] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From 88ba3d1be78d7b28ae038bde29732a79ca8f8d89 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:13 -0400 Subject: [PATCH 39/99] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index fbb7287..61b74aa 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ CircuitPython_RGBLED :target: https://docs.circuitpython.org/projects/rgbled/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 9a460ccf6c250b27b4e8f7b49e26822ee886fa16 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 14:06:03 -0500 Subject: [PATCH 40/99] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 61b74aa..b36b3a2 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ CircuitPython_RGBLED :target: https://docs.circuitpython.org/projects/rgbled/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 7f4bd3ee469149b879a073830b695f53b9bbb477 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:48:54 -0400 Subject: [PATCH 41/99] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From 77dfd1308595eb72d54b489e6f3ea7851a8e0919 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 42/99] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index cfd1c41..f006a4a 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 1caa80504579beb1c444bae3ef7b0d256aa0d106 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 43/99] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index f006a4a..f772971 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From 526a996803058f0698925cbdc0d7755f5da8d3da Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 44/99] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index dfebd1a..700bf7f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From 02bb04a76bc93b0e6f0b6a069b45036fdb7a8c9a Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:53 -0400 Subject: [PATCH 45/99] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index fab19d5..0835802 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,7 +29,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From bee28f58d2f542d48164edadab292b13cde59891 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Sat, 9 Jul 2022 12:37:26 -0400 Subject: [PATCH 46/99] Fix RTD docs badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b36b3a2..034aafb 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ CircuitPython_RGBLED ==================== -.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rgbled/badge/?version=latest +.. image:: https://readthedocs.org/projects/rgbled/badge/?version=latest :target: https://docs.circuitpython.org/projects/rgbled/en/latest/ :alt: Documentation Status From d7069478ba662e726522701f6b9d08b1a4225901 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:15 -0400 Subject: [PATCH 47/99] 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 034aafb..4f81033 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-rgbled Usage Example From 57fbedf8c9baffe2265a6b7e2334486d51bc1b8e Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:01:00 -0400 Subject: [PATCH 48/99] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 4f81033..297f952 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,10 @@ CircuitPython_RGBLED :target: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/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 + CircuitPython driver for RGB LEDs. Works with native microcontroller pins, `Adafruit Blinka `_, or the `PCA9685 PWM driver `_. From 010adef940c4da03f0c7eaa8d4d4ab15f0d80772 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:55 -0400 Subject: [PATCH 49/99] Switched to pyproject.toml --- .github/workflows/build.yml | 18 +++++++----- .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 47 ++++++++++++++++++++++++++++++ requirements.txt | 2 +- setup.py | 55 ----------------------------------- 6 files changed, 71 insertions(+), 71 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..e7433ad --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-rgbled" +description = "CircuitPython driver for RGB LEDs" +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_RGBLED"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "rgbled", + "rgb,", + "led,", + "driver,", + "pwm", +] +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] +py-modules = ["adafruit_rgbled"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 2a9ee0f..0e9fd8b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index 5768cd7..0000000 --- a/setup.py +++ /dev/null @@ -1,55 +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 -""" - -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-rgbled", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython driver for RGB LEDs", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_RGBLED", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka"], - # 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 blinka circuitpython micropython rgbled rgb, led, driver, pwm", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_rgbled"], -) From 88d35b426c4f9e35ae5e3db69a200700d6e23c6a Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 50/99] 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 e7433ad..b88b7bb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 8ef2ffb435e0b7816624df1ba4fe0fa7c93ebea7 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:16 -0400 Subject: [PATCH 51/99] Update version string --- adafruit_rgbled.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index a8e9271..3a59ab0 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -23,7 +23,7 @@ from pwmio import PWMOut from simpleio import map_range -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGBLED.git" diff --git a/pyproject.toml b/pyproject.toml index b88b7bb..7031bf2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-rgbled" description = "CircuitPython driver for RGB LEDs" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From b9e4b66f709a204dfe08e3d01cf9308400fed89d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:16 -0400 Subject: [PATCH 52/99] 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 9a5422c98a2b8db50061c3d0d74cb48714b55223 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:33 -0400 Subject: [PATCH 53/99] 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 700bf7f..bd744b1 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("..")) @@ -43,7 +44,8 @@ # General information about the project. project = "Adafruit RGBLED Library" -copyright = "2019 Brent Rubell" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Brent Rubell" author = "Brent Rubell" # The version info for the project you're documenting, acts as replacement for From 8887d976a7fb2a9cd8d8dd0f0e4a3ac50d0339bb Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:23 -0400 Subject: [PATCH 54/99] 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 bd744b1..b6c69ed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,14 @@ # General information about the project. project = "Adafruit RGBLED Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Brent Rubell" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Brent Rubell" author = "Brent Rubell" # The version info for the project you're documenting, acts as replacement for From e9fb497f9eb580706b7c88bef07b6fdcb2674bde 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 55/99] 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 02e40f84afb90cf9faaf3be780435c7ae25d50a6 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:01 -0400 Subject: [PATCH 56/99] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From bb8e3ad5d4eb6d47631602c48d0bf5378db92b53 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 57/99] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From 452531b3846b201abd6c00b25b6cafa577aea8c6 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 58/99] 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 142fcee1e58fb885147312231816a023fe38740d 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 59/99] 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 aa85e7b742dd47e55ed64f94b355627491176c88 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 60/99] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From dbdff9bac9f144190e58aee76d88867aea6a741d Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 61/99] 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 5a2ca6c0292950a4f88e78d4a1f9abd99ef53e17 Mon Sep 17 00:00:00 2001 From: Neradoc Date: Sat, 18 Mar 2023 06:11:11 +0100 Subject: [PATCH 62/99] Remove dependency to simpleio --- adafruit_rgbled.py | 7 +++---- requirements.txt | 1 - 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 3a59ab0..e3c21c8 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -21,7 +21,6 @@ * Adafruit's SimpleIO library: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO """ from pwmio import PWMOut -from simpleio import map_range __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGBLED.git" @@ -137,19 +136,19 @@ def color(self, value): self._current_color = value if isinstance(value, tuple): for i in range(0, 3): - color = int(map_range(value[i], 0, 255, 0, 65535)) + color = int(max(0, min(65535, value[i] * 257))) if self._invert_pwm: color -= 65535 self._rgb_led_pins[i].duty_cycle = abs(color) elif isinstance(value, int): - if value >> 24: + if value > 0xFFFFFF: raise ValueError("Only bits 0->23 valid for integer input") r = value >> 16 g = (value >> 8) & 0xFF b = value & 0xFF rgb = [r, g, b] for color in range(0, 3): - rgb[color] = int(map_range(rgb[color], 0, 255, 0, 65535)) + rgb[color] = max(0, min(65535, rgb[color] * 257)) if self._invert_pwm: rgb[color] -= 65535 self._rgb_led_pins[color].duty_cycle = abs(rgb[color]) diff --git a/requirements.txt b/requirements.txt index 0e9fd8b..7a984a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,3 @@ # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-simpleio From ebe6dce5c314148991318489930d5e3511eb4e0d Mon Sep 17 00:00:00 2001 From: Neradoc Date: Sun, 19 Mar 2023 05:31:33 +0100 Subject: [PATCH 63/99] Remove more simpleio --- README.rst | 1 - adafruit_rgbled.py | 2 -- 2 files changed, 3 deletions(-) diff --git a/README.rst b/README.rst index 297f952..a2e3817 100644 --- a/README.rst +++ b/README.rst @@ -24,7 +24,6 @@ Dependencies This driver depends on: * `Adafruit CircuitPython `_ -* `SimpleIO Library `_ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index e3c21c8..8a1bf56 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -17,8 +17,6 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases - -* Adafruit's SimpleIO library: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO """ from pwmio import PWMOut From 962c75c01b03d95fcecb330973203ed758cea5d2 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 08:00:27 +0700 Subject: [PATCH 64/99] Made the typing of the pins more explicit, so it's clear where they come from. --- adafruit_rgbled.py | 64 +++++++++++++++++++++++++++++----------------- 1 file changed, 40 insertions(+), 24 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 3a59ab0..61e95ac 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -20,6 +20,14 @@ * Adafruit's SimpleIO library: https://github.com/adafruit/Adafruit_CircuitPython_SimpleIO """ +try: + from typing import Union + import adafruit_pca9685 as pca9685 + import pwmio + import microcontroller +except ImportError: + pass + from pwmio import PWMOut from simpleio import map_range @@ -31,21 +39,6 @@ class RGBLED: """ Creates a RGBLED object given three physical pins or PWMOut objects. - :param red_pin: The physical pin connected to a red LED anode. - :type ~microcontroller.Pin: Microcontroller's red_pin. - :type pwmio.PWMOut: PWMOut object associated with red_pin. - :type PWMChannel: PCA9685 PWM channel associated with red_pin. - :param green_pin: The physical pin connected to a green LED anode. - :type ~microcontroller.Pin: Microcontroller's green_pin. - :type pwmio.PWMOut: PWMOut object associated with green_pin. - :type PWMChannel: PCA9685 PWM channel associated with green_pin. - :param blue_pin: The physical pin connected to a blue LED anode. - :type ~microcontroller.Pin: Microcontroller's blue_pin. - :type pwmio.PWMOut: PWMOut object associated with blue_pin. - :type PWMChannel: PCA9685 PWM channel associated with blue_pin. - :param bool invert_pwm: False if the RGB LED is common cathode, - true if the RGB LED is common anode. - Example for setting a RGB LED using a RGB Tuple (Red, Green, Blue): .. code-block:: python @@ -96,7 +89,23 @@ class RGBLED: """ - def __init__(self, red_pin, green_pin, blue_pin, invert_pwm=False): + def __init__( + self, + red_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], + green_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], + blue_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], + invert_pwm: bool = False, + ) -> None: + """ + :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] red_pin: + The connection to the red LED. + :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] green_pin: + The connection to the green LED. + :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] blue_pin: + The connection to the blue LED. + :param bool invert_pwm: False if the RGB LED is common cathode, + True if the RGB LED is common anode. + """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] for i in range( # pylint: disable=consider-using-enumerate len(self._rgb_led_pins) @@ -112,27 +121,34 @@ def __init__(self, red_pin, green_pin, blue_pin, invert_pwm=False): self._current_color = (0, 0, 0) self.color = self._current_color - def __enter__(self): + def __enter__(self) -> "RGBLED": return self - def __exit__(self, exception_type, exception_value, traceback): + def __exit__(self, exception_type, exception_value, traceback) -> None: self.deinit() - def deinit(self): + def deinit(self) -> None: """Turn the LEDs off, deinit pwmout and release hardware resources.""" for pin in self._rgb_led_pins: pin.deinit() # pylint: disable=no-member self._current_color = (0, 0, 0) @property - def color(self): - """Returns the RGB LED's current color.""" + def color(self) -> Union[int, tuple]: + """Return the RGB LED's current color. + + :return Union[int, tuple]: The currently set color. + """ return self._current_color @color.setter - def color(self, value): + def color(self, value: Union[int, tuple]): """Sets the RGB LED to a desired color. - :param type value: RGB LED desired value - can be a RGB tuple or a 24-bit integer. + :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values + 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. + + :raises ValueError: If the input is an int > 0xffffff. + :raises TypeError: If the input is not an integer or a tuple. """ self._current_color = value if isinstance(value, tuple): @@ -154,4 +170,4 @@ def color(self, value): rgb[color] -= 65535 self._rgb_led_pins[color].duty_cycle = abs(rgb[color]) else: - raise ValueError("Color must be a tuple or 24-bit integer value.") + raise TypeError("Color must be a tuple or 24-bit integer value.") From 0790d550e749c196d6499e4124aaaa58f9633771 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 08:09:47 +0700 Subject: [PATCH 65/99] Removed extra copy of doc string from color property. --- adafruit_rgbled.py | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 61e95ac..94ccd42 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -86,7 +86,6 @@ class RGBLED: import adafruit_rgbled with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - """ def __init__( @@ -135,21 +134,18 @@ def deinit(self) -> None: @property def color(self) -> Union[int, tuple]: - """Return the RGB LED's current color. - - :return Union[int, tuple]: The currently set color. """ - return self._current_color - - @color.setter - def color(self, value: Union[int, tuple]): - """Sets the RGB LED to a desired color. + Sets the RGB LED to a desired color. :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. :raises ValueError: If the input is an int > 0xffffff. :raises TypeError: If the input is not an integer or a tuple. """ + return self._current_color + + @color.setter + def color(self, value: Union[int, tuple]): self._current_color = value if isinstance(value, tuple): for i in range(0, 3): From b0044a6c28dcf537a9cf948f41007633acdaa5f2 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 13:50:56 +0700 Subject: [PATCH 66/99] Refactored color.setter to give helpful errors if incorrect inputs are given --- adafruit_rgbled.py | 45 +++++++++++++++++++++++++-------------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 18fbbca..55e2e90 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -143,24 +143,29 @@ def color(self) -> Union[int, tuple]: @color.setter def color(self, value: Union[int, tuple]): - self._current_color = value - if isinstance(value, tuple): - for i in range(0, 3): - color = int(max(0, min(65535, value[i] * 257))) - if self._invert_pwm: - color -= 65535 - self._rgb_led_pins[i].duty_cycle = abs(color) - elif isinstance(value, int): - if value > 0xFFFFFF: - raise ValueError("Only bits 0->23 valid for integer input") - r = value >> 16 - g = (value >> 8) & 0xFF - b = value & 0xFF - rgb = [r, g, b] - for color in range(0, 3): - rgb[color] = max(0, min(65535, rgb[color] * 257)) - if self._invert_pwm: - rgb[color] -= 65535 - self._rgb_led_pins[color].duty_cycle = abs(rgb[color]) + old_color = self._current_color + if isinstance(value, int): + try: + rgb = value.to_bytes(3, "big", signed=False) + except OverflowError as exc: + raise ValueError("Only bits 0->23 valid for integer input") from exc + elif isinstance(value, tuple): + try: + rgb = bytes(value) + except (ValueError, TypeError) as exc: + raise ValueError( + "Only a tuple of 3 integers of 0 - 255 for tuple input." + ) from exc else: - raise TypeError("Color must be a tuple or 24-bit integer value.") + raise TypeError( + "Color must be a tuple of 3 integers or 24-bit integer value." + ) + try: + for color, intensity in enumerate(rgb): + self._rgb_led_pins[color].duty_cycle = abs( + intensity * 257 - 65535 * self._invert_pwm + ) + except IndexError as exc: + self.color = old_color + raise ValueError("Tuple must be 3 integers.") from exc + self._current_color = value From 45d0e99746239587b90d0e5bd06c60a420b417fc Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 13:53:22 +0700 Subject: [PATCH 67/99] Updated docstring for color to reflect new exceptions. --- adafruit_rgbled.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 55e2e90..c0d9276 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -136,7 +136,8 @@ def color(self) -> Union[int, tuple]: :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. - :raises ValueError: If the input is an int > 0xffffff. + :raises ValueError: If the input is an int > 0xffffff or is not a tuple of 3 integers + 0 - 255. :raises TypeError: If the input is not an integer or a tuple. """ return self._current_color @@ -167,5 +168,5 @@ def color(self, value: Union[int, tuple]): ) except IndexError as exc: self.color = old_color - raise ValueError("Tuple must be 3 integers.") from exc + raise ValueError("Tuple must contain 3 integers.") from exc self._current_color = value From 44bc38c16bb7fa109fe859c19f144cc60d4c2085 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 19:22:25 +0700 Subject: [PATCH 68/99] Simplified error checking for length of tuple. --- adafruit_rgbled.py | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index c0d9276..dccb72b 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -144,7 +144,6 @@ def color(self) -> Union[int, tuple]: @color.setter def color(self, value: Union[int, tuple]): - old_color = self._current_color if isinstance(value, int): try: rgb = value.to_bytes(3, "big", signed=False) @@ -153,6 +152,8 @@ def color(self, value: Union[int, tuple]): elif isinstance(value, tuple): try: rgb = bytes(value) + if len(rgb) != 3: + raise ValueError except (ValueError, TypeError) as exc: raise ValueError( "Only a tuple of 3 integers of 0 - 255 for tuple input." @@ -161,12 +162,8 @@ def color(self, value: Union[int, tuple]): raise TypeError( "Color must be a tuple of 3 integers or 24-bit integer value." ) - try: - for color, intensity in enumerate(rgb): - self._rgb_led_pins[color].duty_cycle = abs( - intensity * 257 - 65535 * self._invert_pwm - ) - except IndexError as exc: - self.color = old_color - raise ValueError("Tuple must contain 3 integers.") from exc + for color, intensity in enumerate(rgb): + self._rgb_led_pins[color].duty_cycle = abs( + intensity * 257 - 65535 * self._invert_pwm + ) self._current_color = value From f5a3e0c1d6fcaf852102f46c77177f33ab57b40f Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Mon, 20 Mar 2023 19:26:10 +0700 Subject: [PATCH 69/99] Fixed some docstring indentation errors. --- adafruit_rgbled.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index dccb72b..83d63e5 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -136,8 +136,8 @@ def color(self) -> Union[int, tuple]: :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. - :raises ValueError: If the input is an int > 0xffffff or is not a tuple of 3 integers - 0 - 255. + :raises ValueError: If the input is an int > 0xffffff or is a tuple that does not + contain 3 integers of 0 - 255. :raises TypeError: If the input is not an integer or a tuple. """ return self._current_color From ec15648292e6aab4fbf809696a6edea7ad5cd608 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Tue, 21 Mar 2023 12:20:09 +0700 Subject: [PATCH 70/99] Rolled back changes to Sphinx and moved to types in string quotes. --- adafruit_rgbled.py | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 18fbbca..c7f123a 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -20,9 +20,6 @@ """ try: from typing import Union - import adafruit_pca9685 as pca9685 - import pwmio - import microcontroller except ImportError: pass @@ -87,20 +84,20 @@ class RGBLED: def __init__( self, - red_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], - green_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], - blue_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], + red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: """ - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] red_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] green_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] blue_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, - True if the RGB LED is common anode. + True if the RGB LED is common anode. Defaults to False. """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] for i in range( # pylint: disable=consider-using-enumerate From 3516ff0fe8eb9f6bf79e252a405ed8980a39aa14 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Tue, 21 Mar 2023 12:29:49 +0700 Subject: [PATCH 71/99] Made changes to typing. --- adafruit_rgbled.py | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 83d63e5..405ea49 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -20,9 +20,6 @@ """ try: from typing import Union - import adafruit_pca9685 as pca9685 - import pwmio - import microcontroller except ImportError: pass @@ -87,20 +84,20 @@ class RGBLED: def __init__( self, - red_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], - green_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], - blue_pin: Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel], + red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: """ - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] red_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] green_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union[microcontroller.Pin, pwmio.PWMOut, pca9685.PWMChannel] blue_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, - True if the RGB LED is common anode. + True if the RGB LED is common anode. Defaults to False. """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] for i in range( # pylint: disable=consider-using-enumerate From 0663429253ca9bdb14e8fe700194b7b0f1b92377 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Tue, 21 Mar 2023 12:35:26 +0700 Subject: [PATCH 72/99] Added comments to clarify some logic. --- adafruit_rgbled.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 405ea49..a30f999 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -143,12 +143,13 @@ def color(self) -> Union[int, tuple]: def color(self, value: Union[int, tuple]): if isinstance(value, int): try: + # Check that integer is <= 0xffffff and create an iterable. rgb = value.to_bytes(3, "big", signed=False) except OverflowError as exc: raise ValueError("Only bits 0->23 valid for integer input") from exc elif isinstance(value, tuple): try: - rgb = bytes(value) + rgb = bytes(value) # Check that tuple has 3 integers of 0 - 255. if len(rgb) != 3: raise ValueError except (ValueError, TypeError) as exc: @@ -160,6 +161,7 @@ def color(self, value: Union[int, tuple]): "Color must be a tuple of 3 integers or 24-bit integer value." ) for color, intensity in enumerate(rgb): + # Take advantage of bool truthiness. self._rgb_led_pins[color].duty_cycle = abs( intensity * 257 - 65535 * self._invert_pwm ) From 34bff7acc35a945fd8eaf3184e535a5e6219bce6 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Tue, 21 Mar 2023 18:44:35 +0700 Subject: [PATCH 73/99] Simplified pin init prior to adding support for Raspi pins. --- adafruit_rgbled.py | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index a30f999..b40081a 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -100,16 +100,15 @@ def __init__( True if the RGB LED is common anode. Defaults to False. """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] - for i in range( # pylint: disable=consider-using-enumerate - len(self._rgb_led_pins) - ): - if hasattr(self._rgb_led_pins[i], "frequency"): - self._rgb_led_pins[i].duty_cycle = 0 - elif str(type(self._rgb_led_pins[i])) == "": - self._rgb_led_pins[i] = PWMOut(self._rgb_led_pins[i]) - self._rgb_led_pins[i].duty_cycle = 0 - else: - raise TypeError("Must provide a pin, PWMOut, or PWMChannel.") + for pin in self._rgb_led_pins: + try: + if str(type(pin)) == "": + pin = PWMOut(pin) + pin.duty_cycle = 0 + except AttributeError as exc: + raise TypeError( + "Pins must be of type Pin, PWMOut or PWMChannel" + ) from exc self._invert_pwm = invert_pwm self._current_color = (0, 0, 0) self.color = self._current_color @@ -149,7 +148,7 @@ def color(self, value: Union[int, tuple]): raise ValueError("Only bits 0->23 valid for integer input") from exc elif isinstance(value, tuple): try: - rgb = bytes(value) # Check that tuple has 3 integers of 0 - 255. + rgb = bytes(value) # Check that tuple has integers of 0 - 255. if len(rgb) != 3: raise ValueError except (ValueError, TypeError) as exc: From b66abb3adc8b8ec37bcd422ddb08c02a0258704b Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 24 Mar 2023 07:59:02 +0700 Subject: [PATCH 74/99] Added logic for Raspberry Pi pins --- adafruit_rgbled.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index b40081a..f38da6b 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -100,18 +100,18 @@ def __init__( True if the RGB LED is common anode. Defaults to False. """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] - for pin in self._rgb_led_pins: + for pin, _ in enumerate(self._rgb_led_pins): try: - if str(type(pin)) == "": - pin = PWMOut(pin) - pin.duty_cycle = 0 + pin_type = str(type(self._rgb_led_pins[pin])) + if pin_type.startswith(""): + self._rgb_led_pins[pin] = PWMOut(self._rgb_led_pins[pin]) + self._rgb_led_pins[pin].duty_cycle = 0 except AttributeError as exc: raise TypeError( "Pins must be of type Pin, PWMOut or PWMChannel" ) from exc self._invert_pwm = invert_pwm self._current_color = (0, 0, 0) - self.color = self._current_color def __enter__(self) -> "RGBLED": return self From 7879309bf09253eca40227f65704ea29815b8245 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 24 Mar 2023 10:52:24 +0700 Subject: [PATCH 75/99] Removed re-raising errors, it's confusing --- adafruit_rgbled.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index f38da6b..1f85c94 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -2,6 +2,7 @@ # # SPDX-License-Identifier: MIT +# pylint: disable=raise-missing-from """ `adafruit_rgbled` ================================================================================ @@ -106,12 +107,11 @@ def __init__( if pin_type.startswith(""): self._rgb_led_pins[pin] = PWMOut(self._rgb_led_pins[pin]) self._rgb_led_pins[pin].duty_cycle = 0 - except AttributeError as exc: - raise TypeError( - "Pins must be of type Pin, PWMOut or PWMChannel" - ) from exc + except AttributeError: + raise TypeError("Pins must be of type Pin, PWMOut or PWMChannel") self._invert_pwm = invert_pwm self._current_color = (0, 0, 0) + self.color = self._current_color def __enter__(self) -> "RGBLED": return self @@ -144,17 +144,17 @@ def color(self, value: Union[int, tuple]): try: # Check that integer is <= 0xffffff and create an iterable. rgb = value.to_bytes(3, "big", signed=False) - except OverflowError as exc: - raise ValueError("Only bits 0->23 valid for integer input") from exc + except OverflowError: + raise ValueError("Only bits 0->23 valid for integer input") elif isinstance(value, tuple): try: rgb = bytes(value) # Check that tuple has integers of 0 - 255. if len(rgb) != 3: raise ValueError - except (ValueError, TypeError) as exc: + except (ValueError, TypeError): raise ValueError( "Only a tuple of 3 integers of 0 - 255 for tuple input." - ) from exc + ) else: raise TypeError( "Color must be a tuple of 3 integers or 24-bit integer value." From 61f89d249a4d1e6875f214e97fed03d3d0018218 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 07:10:19 +0300 Subject: [PATCH 76/99] Moved doc-string from __init__ to class definition. --- adafruit_rgbled.py | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index c7f123a..191a753 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -80,6 +80,15 @@ class RGBLED: import adafruit_rgbled with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) + + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: + The connection to the red LED. + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: + The connection to the green LED. + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: + The connection to the blue LED. + :param bool invert_pwm: False if the RGB LED is common cathode, + True if the RGB LED is common anode. Defaults to False. """ def __init__( @@ -89,16 +98,6 @@ def __init__( blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: - """ - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: - The connection to the red LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: - The connection to the green LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: - The connection to the blue LED. - :param bool invert_pwm: False if the RGB LED is common cathode, - True if the RGB LED is common anode. Defaults to False. - """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] for i in range( # pylint: disable=consider-using-enumerate len(self._rgb_led_pins) From d6f6b2752d7a3075a4008418af549bd64eee2ec1 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 07:11:29 +0300 Subject: [PATCH 77/99] Moved doc-string from __init__ to class definition. --- adafruit_rgbled.py | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 1f85c94..edee08a 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -81,6 +81,15 @@ class RGBLED: import adafruit_rgbled with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) + + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: + The connection to the red LED. + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: + The connection to the green LED. + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: + The connection to the blue LED. + :param bool invert_pwm: False if the RGB LED is common cathode, + True if the RGB LED is common anode. Defaults to False. """ def __init__( @@ -90,16 +99,6 @@ def __init__( blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: - """ - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: - The connection to the red LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: - The connection to the green LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: - The connection to the blue LED. - :param bool invert_pwm: False if the RGB LED is common cathode, - True if the RGB LED is common anode. Defaults to False. - """ self._rgb_led_pins = [red_pin, green_pin, blue_pin] for pin, _ in enumerate(self._rgb_led_pins): try: From 8ffdd7963586fb2754b10c174c909266e06a3756 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 10:06:28 +0300 Subject: [PATCH 78/99] Refactored typing to use ColorBasedColorUnion. --- adafruit_rgbled.py | 44 +++++++++++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 17 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 191a753..2f10cd5 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -19,7 +19,9 @@ https://github.com/adafruit/circuitpython/releases """ try: - from typing import Union + from typing import Union, Optional, Type, TracebackType + from circuitpython_typing.led import ColorBasedColorUnion + from microcontroller import Pin except ImportError: pass @@ -31,9 +33,9 @@ class RGBLED: """ - Creates a RGBLED object given three physical pins or PWMOut objects. + Creates an RGBLED object given three physical pins or PWMOut objects. - Example for setting a RGB LED using a RGB Tuple (Red, Green, Blue): + Example for setting an RGB LED using an RGB Tuple (Red, Green, Blue): .. code-block:: python @@ -48,7 +50,7 @@ class RGBLED: led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) led.color = (255, 0, 0) - Example for setting a RGB LED using a 24-bit integer (hex syntax): + Example for setting an RGB LED using a 24-bit integer (hex syntax): .. code-block:: python @@ -59,11 +61,11 @@ class RGBLED: GREEN_LED = board.D6 BLUE_LED = board.D7 - # Create a RGB LED object + # Create an RGB LED object led = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED) led.color = 0x100000 - Example for setting a RGB LED using a ContextManager: + Example for setting an RGB LED using a ContextManager: .. code-block:: python @@ -81,11 +83,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: + :param Union[Pin, PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: + :param Union[Pin, PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: + :param Union[Pin, PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. @@ -93,9 +95,9 @@ class RGBLED: def __init__( self, - red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + red_pin: Union[Pin, PWMOut, "PWMChannel"], + green_pin: Union[Pin, PWMOut, "PWMChannel"], + blue_pin: Union[Pin, PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] @@ -116,7 +118,12 @@ def __init__( def __enter__(self) -> "RGBLED": return self - def __exit__(self, exception_type, exception_value, traceback) -> None: + def __exit__( + self, + exception_type: Optional[Type[type]], + exception_value: Optional[BaseException], + traceback: Optional[TracebackType], + ) -> None: self.deinit() def deinit(self) -> None: @@ -126,11 +133,14 @@ def deinit(self) -> None: self._current_color = (0, 0, 0) @property - def color(self) -> Union[int, tuple]: + def color(self) -> ColorBasedColorUnion: """ Sets the RGB LED to a desired color. - :param Union[int, tuple] value: RGB LED desired value - can be a RGB tuple of values - 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. + :param ColorBasedColorUnion value: RGB LED desired value - can be a RGB + tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 + are equivalent. + + :returns Union[int, Tuple[int, int, int]]: The current LED color setting. :raises ValueError: If the input is an int > 0xffffff. :raises TypeError: If the input is not an integer or a tuple. @@ -138,7 +148,7 @@ def color(self) -> Union[int, tuple]: return self._current_color @color.setter - def color(self, value: Union[int, tuple]): + def color(self, value: ColorBasedColorUnion): self._current_color = value if isinstance(value, tuple): for i in range(0, 3): From 430c6af0214adbc713d3b8d7659c520a466410dc Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 10:12:47 +0300 Subject: [PATCH 79/99] Refactored Pin to microcontroller.Pin. --- adafruit_rgbled.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 2f10cd5..990a1e9 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -21,7 +21,7 @@ try: from typing import Union, Optional, Type, TracebackType from circuitpython_typing.led import ColorBasedColorUnion - from microcontroller import Pin + import microcontroller except ImportError: pass @@ -95,9 +95,9 @@ class RGBLED: def __init__( self, - red_pin: Union[Pin, PWMOut, "PWMChannel"], - green_pin: Union[Pin, PWMOut, "PWMChannel"], - blue_pin: Union[Pin, PWMOut, "PWMChannel"], + red_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], + green_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], + blue_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] From 89c364353057315d4af82c1f23b5294fff5f54ac Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 10:31:23 +0300 Subject: [PATCH 80/99] Refactored Pin to "microcontroller.Pin". --- adafruit_rgbled.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 990a1e9..e59e393 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -21,7 +21,6 @@ try: from typing import Union, Optional, Type, TracebackType from circuitpython_typing.led import ColorBasedColorUnion - import microcontroller except ImportError: pass @@ -95,9 +94,9 @@ class RGBLED: def __init__( self, - red_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], - green_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], - blue_pin: Union[microcontroller.Pin, PWMOut, "PWMChannel"], + red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] From 588a0d11a8a3481f76ce50d953e3a9ffa78fb51a Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 10:58:45 +0300 Subject: [PATCH 81/99] Changed import of TracebackType from typing to types. --- adafruit_rgbled.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index e59e393..89c1aa4 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -19,7 +19,8 @@ https://github.com/adafruit/circuitpython/releases """ try: - from typing import Union, Optional, Type, TracebackType + from typing import Union, Optional, Type + from types import TracebackType from circuitpython_typing.led import ColorBasedColorUnion except ImportError: pass From 3b711a1a562fc08c29be9f59a8c1a3a53b885824 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Wed, 12 Apr 2023 12:55:21 +0300 Subject: [PATCH 82/99] Attempt to fix docstring indent. --- adafruit_rgbled.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 89c1aa4..733520f 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -33,7 +33,7 @@ class RGBLED: """ - Creates an RGBLED object given three physical pins or PWMOut objects. + Create an RGBLED object given three physical pins or PWMOut objects. Example for setting an RGB LED using an RGB Tuple (Red, Green, Blue): @@ -83,11 +83,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union[Pin, PWMOut, "PWMChannel"] red_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union[Pin, PWMOut, "PWMChannel"] green_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union[Pin, PWMOut, "PWMChannel"] blue_pin: + :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. @@ -136,6 +136,7 @@ def deinit(self) -> None: def color(self) -> ColorBasedColorUnion: """ Sets the RGB LED to a desired color. + :param ColorBasedColorUnion value: RGB LED desired value - can be a RGB tuple of values 0 - 255 or a 24-bit integer. e.g. (255, 64, 35) and 0xff4023 are equivalent. From 2653b83610b67cf2ec3662a6354e36c36c1ee4ce Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 05:16:42 +0300 Subject: [PATCH 83/99] Added adafruit_circuitpython_typing~=1.4 to requirements.txt. --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 7a984a4..1e011e3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense Adafruit-Blinka +adafruit_circuitpython_typing~=1.4 From af553d3c1da8910299c6c8e33283ab7aa343dd9b Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 05:28:06 +0300 Subject: [PATCH 84/99] Imported microcontroller.Pin and adafruit_pca9685.PWMChannel --- adafruit_rgbled.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 733520f..f223255 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -21,6 +21,8 @@ try: from typing import Union, Optional, Type from types import TracebackType + from microcontroller import Pin + from adafruit_pca9685 import PWMChannel from circuitpython_typing.led import ColorBasedColorUnion except ImportError: pass @@ -83,11 +85,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] red_pin: + :param Union[Pin, PWMOut, PWMChannel] red_pin: The connection to the red LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] green_pin: + :param Union[Pin, PWMOut, PWMChannel] green_pin: The connection to the green LED. - :param Union["microcontroller.Pin", PWMOut, "PWMChannel"] blue_pin: + :param Union[Pin, PWMOut, PWMChannel] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. @@ -95,9 +97,9 @@ class RGBLED: def __init__( self, - red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + red_pin: Union[Pin, PWMOut, PWMChannel], + green_pin: Union[Pin, PWMOut, PWMChannel], + blue_pin: Union[Pin, PWMOut, PWMChannel], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] From 5d50d929b470410a0a89f027454106a921f642dc Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 05:54:35 +0300 Subject: [PATCH 85/99] Removed PWMChannel import as it fails CI. --- adafruit_rgbled.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index f223255..10808c1 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -22,7 +22,6 @@ from typing import Union, Optional, Type from types import TracebackType from microcontroller import Pin - from adafruit_pca9685 import PWMChannel from circuitpython_typing.led import ColorBasedColorUnion except ImportError: pass @@ -85,11 +84,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union[Pin, PWMOut, PWMChannel] red_pin: + :param Union[Pin, PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union[Pin, PWMOut, PWMChannel] green_pin: + :param Union[Pin, PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union[Pin, PWMOut, PWMChannel] blue_pin: + :param Union[Pin, PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. @@ -97,9 +96,9 @@ class RGBLED: def __init__( self, - red_pin: Union[Pin, PWMOut, PWMChannel], - green_pin: Union[Pin, PWMOut, PWMChannel], - blue_pin: Union[Pin, PWMOut, PWMChannel], + red_pin: Union[Pin, PWMOut, "PWMChannel"], + green_pin: Union[Pin, PWMOut, "PWMChannel"], + blue_pin: Union[Pin, PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] From 0ac396880fd02ef436d2fcf41560d57efcd7acda Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 06:02:09 +0300 Subject: [PATCH 86/99] Added adafruit_pca9685 to requirements.txt and imported for typing. --- adafruit_rgbled.py | 13 +++++++------ requirements.txt | 1 + 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 10808c1..f223255 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -22,6 +22,7 @@ from typing import Union, Optional, Type from types import TracebackType from microcontroller import Pin + from adafruit_pca9685 import PWMChannel from circuitpython_typing.led import ColorBasedColorUnion except ImportError: pass @@ -84,11 +85,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union[Pin, PWMOut, "PWMChannel"] red_pin: + :param Union[Pin, PWMOut, PWMChannel] red_pin: The connection to the red LED. - :param Union[Pin, PWMOut, "PWMChannel"] green_pin: + :param Union[Pin, PWMOut, PWMChannel] green_pin: The connection to the green LED. - :param Union[Pin, PWMOut, "PWMChannel"] blue_pin: + :param Union[Pin, PWMOut, PWMChannel] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. @@ -96,9 +97,9 @@ class RGBLED: def __init__( self, - red_pin: Union[Pin, PWMOut, "PWMChannel"], - green_pin: Union[Pin, PWMOut, "PWMChannel"], - blue_pin: Union[Pin, PWMOut, "PWMChannel"], + red_pin: Union[Pin, PWMOut, PWMChannel], + green_pin: Union[Pin, PWMOut, PWMChannel], + blue_pin: Union[Pin, PWMOut, PWMChannel], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] diff --git a/requirements.txt b/requirements.txt index 1e011e3..0bb4bb1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,4 @@ Adafruit-Blinka adafruit_circuitpython_typing~=1.4 +adafruit_pca9685 From 9fe37bbbf805f3542ffac6228767651ed20bba2a Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 07:10:45 +0300 Subject: [PATCH 87/99] Removed adafruit_pca9685 from requirements.txt and wrapped quotes around PWMChannel in doc-string. --- adafruit_rgbled.py | 6 +++--- requirements.txt | 1 - 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index f223255..c5c7386 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -85,11 +85,11 @@ class RGBLED: with adafruit_rgbled.RGBLED(board.D5, board.D6, board.D7, invert_pwm=True) as rgb_led: rgb_led.color = (0, 255, 0) - :param Union[Pin, PWMOut, PWMChannel] red_pin: + :param Union[Pin, PWMOut, "PWMChannel"] red_pin: The connection to the red LED. - :param Union[Pin, PWMOut, PWMChannel] green_pin: + :param Union[Pin, PWMOut, "PWMChannel"] green_pin: The connection to the green LED. - :param Union[Pin, PWMOut, PWMChannel] blue_pin: + :param Union[Pin, PWMOut, "PWMChannel"] blue_pin: The connection to the blue LED. :param bool invert_pwm: False if the RGB LED is common cathode, True if the RGB LED is common anode. Defaults to False. diff --git a/requirements.txt b/requirements.txt index 0bb4bb1..1e011e3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,4 +4,3 @@ Adafruit-Blinka adafruit_circuitpython_typing~=1.4 -adafruit_pca9685 From 5996fd2effde0a19ea7ac1e37b57c68acce01f4c Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 07:27:26 +0300 Subject: [PATCH 88/99] Added adafruit_pca9685 back to requirements.txt. --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 1e011e3..0bb4bb1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,3 +4,4 @@ Adafruit-Blinka adafruit_circuitpython_typing~=1.4 +adafruit_pca9685 From 2a17b3cbe04059f946657aed04fe7b645db20685 Mon Sep 17 00:00:00 2001 From: BiffoBear Date: Fri, 14 Apr 2023 07:40:28 +0300 Subject: [PATCH 89/99] Renamed adafruit_pca9685 to Adafruit-PCA9685, adafruit-circuitpython-typing. --- requirements.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 0bb4bb1..a1319b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,5 +3,5 @@ # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit_circuitpython_typing~=1.4 -adafruit_pca9685 +adafruit-circuitpython-typing~=1.4 +Adafruit-PCA9685 From 207b0d29743d70e90db2e735133e353b2e47e1c8 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 90/99] 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 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From ba4468910ad15143cf2099d74693a2a9f340cde5 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 91/99] 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 b6c69ed..3b9b058 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.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 f5d9e062b7e3ed74268b7833ca480188c37689e9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 31 Jul 2023 15:32:55 -0500 Subject: [PATCH 92/99] fix requirement pip name --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index a1319b9..47d8df5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,4 +4,4 @@ Adafruit-Blinka adafruit-circuitpython-typing~=1.4 -Adafruit-PCA9685 +adafruit-circuitpython-pca9685 From 14d8c810849d667150187772962f48f4d625bec2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 17 Sep 2023 12:58:13 -0500 Subject: [PATCH 93/99] use Pin --- adafruit_rgbled.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index 4851108..c5893bd 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -98,9 +98,9 @@ class RGBLED: def __init__( self, - red_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - green_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], - blue_pin: Union["microcontroller.Pin", PWMOut, "PWMChannel"], + red_pin: Union[Pin, PWMOut, "PWMChannel"], + green_pin: Union[Pin, PWMOut, "PWMChannel"], + blue_pin: Union[Pin, PWMOut, "PWMChannel"], invert_pwm: bool = False, ) -> None: self._rgb_led_pins = [red_pin, green_pin, blue_pin] From ec7da2ada844bc760c327e4434f41ce4c5347b36 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:23:40 -0500 Subject: [PATCH 94/99] "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 3b9b058..4216e09 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,19 +101,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 de9a9106de3aa908b36b2eb14d4f4faef23cc88c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 95/99] 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 4fa4a4e6813146fdfee16126f3be629f46a096dc Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 96/99] 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 4216e09..c66a097 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,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 f53cee982a793312cf0c7dafab664a3e97e1ac1d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 97/99] 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 32b488b793abc03748b4de9476de22a701d308ef Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 16 May 2025 18:56:23 +0000 Subject: [PATCH 98/99] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +--- .pylintrc | 399 ---------------------------------- README.rst | 6 +- adafruit_rgbled.py | 21 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/rgbled_blink.py | 2 + examples/rgbled_pca9685.py | 4 +- examples/rgbled_simpletest.py | 2 + ruff.toml | 109 ++++++++++ 11 files changed, 154 insertions(+), 454 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/README.rst b/README.rst index a2e3817..44cb57d 100644 --- a/README.rst +++ b/README.rst @@ -12,9 +12,9 @@ CircuitPython_RGBLED :target: https://github.com/adafruit/Adafruit_CircuitPython_RGBLED/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 CircuitPython driver for RGB LEDs. Works with native microcontroller pins, `Adafruit Blinka `_, or the `PCA9685 PWM driver `_. diff --git a/adafruit_rgbled.py b/adafruit_rgbled.py index c5893bd..fb8f4b7 100644 --- a/adafruit_rgbled.py +++ b/adafruit_rgbled.py @@ -2,7 +2,6 @@ # # SPDX-License-Identifier: MIT -# pylint: disable=raise-missing-from """ `adafruit_rgbled` ================================================================================ @@ -19,12 +18,14 @@ * Adafruit CircuitPython firmware for the supported boards: https://github.com/adafruit/circuitpython/releases """ + try: - from typing import Union, Optional, Type from types import TracebackType - from microcontroller import Pin + from typing import Optional, Type, Union + from adafruit_pca9685 import PWMChannel from circuitpython_typing.led import ColorBasedColorUnion + from microcontroller import Pin except ImportError: pass @@ -130,7 +131,7 @@ def __exit__( def deinit(self) -> None: """Turn the LEDs off, deinit pwmout and release hardware resources.""" for pin in self._rgb_led_pins: - pin.deinit() # pylint: disable=no-member + pin.deinit() self._current_color = (0, 0, 0) @property @@ -164,16 +165,10 @@ def color(self, value: ColorBasedColorUnion): if len(rgb) != 3: raise ValueError except (ValueError, TypeError): - raise ValueError( - "Only a tuple of 3 integers of 0 - 255 for tuple input." - ) + raise ValueError("Only a tuple of 3 integers of 0 - 255 for tuple input.") else: - raise TypeError( - "Color must be a tuple of 3 integers or 24-bit integer value." - ) + raise TypeError("Color must be a tuple of 3 integers or 24-bit integer value.") for color, intensity in enumerate(rgb): # Take advantage of bool truthiness. - self._rgb_led_pins[color].duty_cycle = abs( - intensity * 257 - 65535 * self._invert_pwm - ) + self._rgb_led_pins[color].duty_cycle = abs(intensity * 257 - 65535 * self._invert_pwm) self._current_color = value diff --git a/docs/api.rst b/docs/api.rst index 57aec1e..5bb3940 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. 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_rgbled :members: diff --git a/docs/conf.py b/docs/conf.py index c66a097..bff31e6 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("..")) @@ -48,9 +46,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 + " Brent Rubell" author = "Brent Rubell" diff --git a/examples/rgbled_blink.py b/examples/rgbled_blink.py index c099cb5..65ff9a4 100755 --- a/examples/rgbled_blink.py +++ b/examples/rgbled_blink.py @@ -4,7 +4,9 @@ # This example shows how to create a single RGB LED with a specific color channel # order and blink it. import time + import board + import adafruit_rgbled # Configure the setup diff --git a/examples/rgbled_pca9685.py b/examples/rgbled_pca9685.py index 425e801..b59702c 100644 --- a/examples/rgbled_pca9685.py +++ b/examples/rgbled_pca9685.py @@ -2,10 +2,12 @@ # SPDX-License-Identifier: MIT import time + +import adafruit_pca9685 import board import busio from rainbowio import colorwheel -import adafruit_pca9685 + import adafruit_rgbled # PCA9685 Initialization diff --git a/examples/rgbled_simpletest.py b/examples/rgbled_simpletest.py index 7d3ae63..da2b485 100644 --- a/examples/rgbled_simpletest.py +++ b/examples/rgbled_simpletest.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT import time + import board from rainbowio import colorwheel + import adafruit_rgbled # Pin the Red LED is connected to diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..2e20813 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,109 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "PLC2701", # private import + "PLW2901", # loop var overwrite +] + +[format] +line-ending = "lf" From 0cafa8ed3d7db7ae83906c1b209c78cd6b872a74 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 99/99] 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"