From 2139ea7f3146482406e73c59ca800e44a5a551f3 Mon Sep 17 00:00:00 2001 From: caternuson Date: Fri, 17 Apr 2020 19:24:08 -0700 Subject: [PATCH 01/69] initial working --- adafruit_as726x.py | 91 ++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 88 insertions(+), 3 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 94d9e67..a2d6618 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -92,8 +92,15 @@ _AS726X_NUM_CHANNELS = const(6) +_COLOR_REGS = (_AS7262_VIOLET, _AS7262_BLUE, _AS7262_GREEN, + _AS7262_YELLOW, _AS7262_ORANGE,_AS7262_RED) +_COLOR_REGS_CALIBRATED = (_AS7262_VIOLET_CALIBRATED, _AS7262_BLUE_CALIBRATED, + _AS7262_GREEN_CALIBRATED, _AS7262_YELLOW_CALIBRATED, + _AS7262_ORANGE_CALIBRATED, _AS7262_RED_CALIBRATED) + # pylint: disable=too-many-instance-attributes # pylint: disable=too-many-public-methods + class Adafruit_AS726x: """AS726x spectral sensor. @@ -120,7 +127,7 @@ class Adafruit_AS726x: DRIVER_CURRENT_LIMITS = (12.5, 25, 50, 100) - def __init__(self, i2c_bus): + def __init__(self): self._driver_led = False self._indicator_led = False self._driver_led_current = Adafruit_AS726x.DRIVER_CURRENT_LIMITS.index(12.5) @@ -130,8 +137,6 @@ def __init__(self, i2c_bus): self._gain = Adafruit_AS726x.GAIN.index(1) self.buf2 = bytearray(2) - self.i2c_device = I2CDevice(i2c_bus, _AS726X_ADDRESS) - # reset device self._virtual_write(_AS726X_CONTROL_SETUP, 0x80) @@ -372,6 +377,18 @@ def raw_red(self): """Raw red (650nm) 16-bit value""" return self.read_channel(_AS7262_RED) + def _virtual_read(self, addr): + raise NotImplementedError("Must be implemented.") + + def _virtual_write(self, addr, value): + raise NotImplementedError("Must be implemented.") + +class Adafruit_AS726x_I2C(Adafruit_AS726x): + + def __init__(self, i2c_bus, address=_AS726X_ADDRESS): + self.i2c_device = I2CDevice(i2c_bus, address) + super().__init__() + def _read_u8(self, command): """read a single byte from a specified register""" buf = self.buf2 @@ -427,6 +444,74 @@ def _virtual_write(self, addr, value): # Send the data to complete the operation. self.__write_u8(_AS726X_SLAVE_WRITE_REG, value) +class Adafruit_AS726x_UART(Adafruit_AS726x): + def __init__(self, uart): + self._uart = uart + self._uart.baudrate = 115200 + super().__init__() + + def read_channel(self, channel): + """Read an individual sensor channel""" + return self._virtual_read(channel) + + def read_calibrated_value(self, channel): + """Read a calibrated sensor channel""" + return self._virtual_read(channel) + + def _uart_xfer(self, cmd): + self._uart.reset_input_buffer() + cmd += '\n' + self._uart.write(cmd.encode()) + time.sleep(0.1) + if self._uart.in_waiting: + resp = self._uart.read(self._uart.in_waiting) + return resp.rstrip(b' OK\n') + else: + return None + + def _virtual_read(self, addr): + if addr == _AS726X_HW_VERSION: + return 0x40 + elif addr == _AS726X_DEVICE_TEMP: + return int(self._uart_xfer('ATTEMP')) + elif addr == _AS726X_LED_CONTROL: + LED_IND = int(self._uart_xfer('ATLED0')) + LED_DRV = int(self._uart_xfer('ATLED1')) + return LED_IND << 3 | LED_DRV + elif addr == _AS726X_CONTROL_SETUP: + GAIN = int(self._uart_xfer('ATGAIN')) + BANK = int(self._uart_xfer('ATTCSMD')) + return GAIN << 4 | BANK << 2 | 1 << 1 + elif addr in _COLOR_REGS: + resp = self._uart_xfer('ATDATA') + resp = resp.decode().split(',') + return int(resp[_COLOR_REGS.index(addr)]) + elif addr in _COLOR_REGS_CALIBRATED: + resp = self._uart_xfer('ATCDATA') + resp = resp.decode().split(',') + return float(resp[_COLOR_REGS_CALIBRATED.index(addr)]) + + def _virtual_write(self, addr, value): + if addr == _AS726X_CONTROL_SETUP: + RST = (value >> 7) & 0x01 + GAIN = (value >> 4) & 0x03 + BANK = (value >> 2) & 0x03 + if RST: + self._uart.write(b'ATRST\n') + return + self._uart_xfer('ATGAIN={}'.format(GAIN)) + self._uart_xfer('ATTCSMD={}'.format(BANK)) + elif addr == _AS726X_LED_CONTROL: + ICL_DRV = (value >> 4) & 0x07 + LED_DRV = 100 if value & 0x08 else 0 + ICL_IND = (value >> 1) & 0x07 + LED_IND = 100 if value & 0x01 else 0 + self._uart_xfer('ATLED0={}'.format(LED_IND)) + self._uart_xfer('ATLED1={}'.format(LED_DRV)) + self._uart_xfer('ATLEDC={}'.format(ICL_DRV << 4 | ICL_IND)) + elif addr == _AS726X_INT_T: + value = int(value / 2.8) + self._uart_xfer('ATINTTIME={}'.format(value)) # pylint: enable=too-many-instance-attributes # pylint: enable=too-many-public-methods From ead4d7b6f2806ae1512d0c37cb0b38a445f2251c Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 09:46:08 -0700 Subject: [PATCH 02/69] clean up --- adafruit_as726x.py | 50 +++++++++++++++++++++-------------- examples/as726x_simpletest.py | 13 ++++++--- 2 files changed, 40 insertions(+), 23 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index a2d6618..8ffc510 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -101,10 +101,9 @@ # pylint: disable=too-many-instance-attributes # pylint: disable=too-many-public-methods -class Adafruit_AS726x: - """AS726x spectral sensor. +class AS726x: + """AS726x spectral sensor base class. - :param ~busio.I2C i2c_bus: The I2C bus connected to the sensor """ MODE_0 = 0b00 @@ -130,11 +129,11 @@ class Adafruit_AS726x: def __init__(self): self._driver_led = False self._indicator_led = False - self._driver_led_current = Adafruit_AS726x.DRIVER_CURRENT_LIMITS.index(12.5) - self._indicator_led_current = Adafruit_AS726x.INDICATOR_CURRENT_LIMITS.index(1) - self._conversion_mode = Adafruit_AS726x.MODE_2 + self._driver_led_current = AS726x.DRIVER_CURRENT_LIMITS.index(12.5) + self._indicator_led_current = AS726x.INDICATOR_CURRENT_LIMITS.index(1) + self._conversion_mode = AS726x.MODE_2 self._integration_time = 0 - self._gain = Adafruit_AS726x.GAIN.index(1) + self._gain = AS726x.GAIN.index(1) self.buf2 = bytearray(2) # reset device @@ -153,7 +152,7 @@ def __init__(self): ) self.integration_time = 140 - self.conversion_mode = Adafruit_AS726x.MODE_2 + self.conversion_mode = AS726x.MODE_2 self.gain = 64 @property @@ -198,14 +197,14 @@ def driver_led_current(self): @driver_led_current.setter def driver_led_current(self, val): - if val not in Adafruit_AS726x.DRIVER_CURRENT_LIMITS: + if val not in AS726x.DRIVER_CURRENT_LIMITS: raise ValueError("Must be 12.5, 25, 50 or 100") if self._driver_led_current == val: return self._driver_led_current = val state = self._virtual_read(_AS726X_LED_CONTROL) state &= ~(0x3 << 4) - state = state | (Adafruit_AS726x.DRIVER_CURRENT_LIMITS.index(val) << 4) + state = state | (AS726x.DRIVER_CURRENT_LIMITS.index(val) << 4) self._virtual_write(_AS726X_LED_CONTROL, state) @property @@ -220,14 +219,14 @@ def indicator_led_current(self): @indicator_led_current.setter def indicator_led_current(self, val): - if val not in Adafruit_AS726x.INDICATOR_CURRENT_LIMITS: + if val not in AS726x.INDICATOR_CURRENT_LIMITS: raise ValueError("Must be 1, 2, 4 or 8") if self._indicator_led_current == val: return self._indicator_led_current = val state = self._virtual_read(_AS726X_LED_CONTROL) state &= ~(0x3 << 1) - state = state | (Adafruit_AS726x.INDICATOR_CURRENT_LIMITS.index(val) << 4) + state = state | (AS726x.INDICATOR_CURRENT_LIMITS.index(val) << 4) self._virtual_write(_AS726X_LED_CONTROL, state) @property @@ -258,14 +257,14 @@ def gain(self): @gain.setter def gain(self, val): - if val not in Adafruit_AS726x.GAIN: + if val not in AS726x.GAIN: raise ValueError("Must be 1, 3.7, 16 or 64") if self._gain == val: return self._gain = val state = self._virtual_read(_AS726X_CONTROL_SETUP) state &= ~(0x3 << 4) - state |= Adafruit_AS726x.GAIN.index(val) << 4 + state |= AS726x.GAIN.index(val) << 4 self._virtual_write(_AS726X_CONTROL_SETUP, state) @property @@ -383,7 +382,11 @@ def _virtual_read(self, addr): def _virtual_write(self, addr, value): raise NotImplementedError("Must be implemented.") -class Adafruit_AS726x_I2C(Adafruit_AS726x): +class AS726x_I2C(AS726x): + """AS726x spectral sensor via I2C. + + :param ~busio.I2C i2c_bus: The I2C bus connected to the sensor + """ def __init__(self, i2c_bus, address=_AS726X_ADDRESS): self.i2c_device = I2CDevice(i2c_bus, address) @@ -444,7 +447,12 @@ def _virtual_write(self, addr, value): # Send the data to complete the operation. self.__write_u8(_AS726X_SLAVE_WRITE_REG, value) -class Adafruit_AS726x_UART(Adafruit_AS726x): +class AS726x_UART(AS726x): + """AS726x spectral sensor via UART. + + :param ~busio.UART uart: The UART connected to the sensor + """ + def __init__(self, uart): self._uart = uart self._uart.baudrate = 115200 @@ -471,6 +479,7 @@ def _uart_xfer(self, cmd): def _virtual_read(self, addr): if addr == _AS726X_HW_VERSION: + # just return what is expected return 0x40 elif addr == _AS726X_DEVICE_TEMP: return int(self._uart_xfer('ATTEMP')) @@ -493,12 +502,13 @@ def _virtual_read(self, addr): def _virtual_write(self, addr, value): if addr == _AS726X_CONTROL_SETUP: - RST = (value >> 7) & 0x01 - GAIN = (value >> 4) & 0x03 - BANK = (value >> 2) & 0x03 - if RST: + # check for reset + if (value >> 7) & 0x01: self._uart.write(b'ATRST\n') return + # otherwise proceed + GAIN = (value >> 4) & 0x03 + BANK = (value >> 2) & 0x03 self._uart_xfer('ATGAIN={}'.format(GAIN)) self._uart_xfer('ATTCSMD={}'.format(BANK)) elif addr == _AS726X_LED_CONTROL: diff --git a/examples/as726x_simpletest.py b/examples/as726x_simpletest.py index d91a813..3c6549d 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -3,7 +3,10 @@ import board import busio -from adafruit_as726x import Adafruit_AS726x +# for I2C use: +from adafruit_as726x import AS726x_I2C +# for UART use: +#from adafruit_as726x import AS726x_UART # maximum value for sensor reading max_val = 16000 @@ -16,9 +19,13 @@ def graph_map(x): return min(int(x * max_graph / max_val), max_graph) -# Initialize I2C bus and sensor. +# for I2C use: i2c = busio.I2C(board.SCL, board.SDA) -sensor = Adafruit_AS726x(i2c) +sensor = AS726x_I2C(i2c) + +# for UART use: +#uart = busio.UART(board.TX, board.RX) +#sensor = AS726x_UART(uart) sensor.conversion_mode = sensor.MODE_2 From db60c0ffb53a57a0b731f4efdceb0172b0ff9c04 Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 10:00:11 -0700 Subject: [PATCH 03/69] linted, i mean blacked, or..whatever --- adafruit_as726x.py | 61 ++++++++++++++++++++++------------- examples/as726x_simpletest.py | 7 ++-- 2 files changed, 42 insertions(+), 26 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 8ffc510..608d533 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -92,15 +92,27 @@ _AS726X_NUM_CHANNELS = const(6) -_COLOR_REGS = (_AS7262_VIOLET, _AS7262_BLUE, _AS7262_GREEN, - _AS7262_YELLOW, _AS7262_ORANGE,_AS7262_RED) -_COLOR_REGS_CALIBRATED = (_AS7262_VIOLET_CALIBRATED, _AS7262_BLUE_CALIBRATED, - _AS7262_GREEN_CALIBRATED, _AS7262_YELLOW_CALIBRATED, - _AS7262_ORANGE_CALIBRATED, _AS7262_RED_CALIBRATED) +_COLOR_REGS = ( + _AS7262_VIOLET, + _AS7262_BLUE, + _AS7262_GREEN, + _AS7262_YELLOW, + _AS7262_ORANGE, + _AS7262_RED, +) +_COLOR_REGS_CALIBRATED = ( + _AS7262_VIOLET_CALIBRATED, + _AS7262_BLUE_CALIBRATED, + _AS7262_GREEN_CALIBRATED, + _AS7262_YELLOW_CALIBRATED, + _AS7262_ORANGE_CALIBRATED, + _AS7262_RED_CALIBRATED, +) # pylint: disable=too-many-instance-attributes # pylint: disable=too-many-public-methods + class AS726x: """AS726x spectral sensor base class. @@ -382,6 +394,7 @@ def _virtual_read(self, addr): def _virtual_write(self, addr, value): raise NotImplementedError("Must be implemented.") + class AS726x_I2C(AS726x): """AS726x spectral sensor via I2C. @@ -447,6 +460,7 @@ def _virtual_write(self, addr, value): # Send the data to complete the operation. self.__write_u8(_AS726X_SLAVE_WRITE_REG, value) + class AS726x_UART(AS726x): """AS726x spectral sensor via UART. @@ -468,12 +482,12 @@ def read_calibrated_value(self, channel): def _uart_xfer(self, cmd): self._uart.reset_input_buffer() - cmd += '\n' + cmd += "\n" self._uart.write(cmd.encode()) time.sleep(0.1) if self._uart.in_waiting: resp = self._uart.read(self._uart.in_waiting) - return resp.rstrip(b' OK\n') + return resp.rstrip(b" OK\n") else: return None @@ -482,46 +496,47 @@ def _virtual_read(self, addr): # just return what is expected return 0x40 elif addr == _AS726X_DEVICE_TEMP: - return int(self._uart_xfer('ATTEMP')) + return int(self._uart_xfer("ATTEMP")) elif addr == _AS726X_LED_CONTROL: - LED_IND = int(self._uart_xfer('ATLED0')) - LED_DRV = int(self._uart_xfer('ATLED1')) + LED_IND = int(self._uart_xfer("ATLED0")) + LED_DRV = int(self._uart_xfer("ATLED1")) return LED_IND << 3 | LED_DRV elif addr == _AS726X_CONTROL_SETUP: - GAIN = int(self._uart_xfer('ATGAIN')) - BANK = int(self._uart_xfer('ATTCSMD')) + GAIN = int(self._uart_xfer("ATGAIN")) + BANK = int(self._uart_xfer("ATTCSMD")) return GAIN << 4 | BANK << 2 | 1 << 1 elif addr in _COLOR_REGS: - resp = self._uart_xfer('ATDATA') - resp = resp.decode().split(',') + resp = self._uart_xfer("ATDATA") + resp = resp.decode().split(",") return int(resp[_COLOR_REGS.index(addr)]) elif addr in _COLOR_REGS_CALIBRATED: - resp = self._uart_xfer('ATCDATA') - resp = resp.decode().split(',') + resp = self._uart_xfer("ATCDATA") + resp = resp.decode().split(",") return float(resp[_COLOR_REGS_CALIBRATED.index(addr)]) def _virtual_write(self, addr, value): if addr == _AS726X_CONTROL_SETUP: # check for reset if (value >> 7) & 0x01: - self._uart.write(b'ATRST\n') + self._uart.write(b"ATRST\n") return # otherwise proceed GAIN = (value >> 4) & 0x03 BANK = (value >> 2) & 0x03 - self._uart_xfer('ATGAIN={}'.format(GAIN)) - self._uart_xfer('ATTCSMD={}'.format(BANK)) + self._uart_xfer("ATGAIN={}".format(GAIN)) + self._uart_xfer("ATTCSMD={}".format(BANK)) elif addr == _AS726X_LED_CONTROL: ICL_DRV = (value >> 4) & 0x07 LED_DRV = 100 if value & 0x08 else 0 ICL_IND = (value >> 1) & 0x07 LED_IND = 100 if value & 0x01 else 0 - self._uart_xfer('ATLED0={}'.format(LED_IND)) - self._uart_xfer('ATLED1={}'.format(LED_DRV)) - self._uart_xfer('ATLEDC={}'.format(ICL_DRV << 4 | ICL_IND)) + self._uart_xfer("ATLED0={}".format(LED_IND)) + self._uart_xfer("ATLED1={}".format(LED_DRV)) + self._uart_xfer("ATLEDC={}".format(ICL_DRV << 4 | ICL_IND)) elif addr == _AS726X_INT_T: value = int(value / 2.8) - self._uart_xfer('ATINTTIME={}'.format(value)) + self._uart_xfer("ATINTTIME={}".format(value)) + # pylint: enable=too-many-instance-attributes # pylint: enable=too-many-public-methods diff --git a/examples/as726x_simpletest.py b/examples/as726x_simpletest.py index 3c6549d..4ed5e95 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -5,8 +5,9 @@ # for I2C use: from adafruit_as726x import AS726x_I2C + # for UART use: -#from adafruit_as726x import AS726x_UART +# from adafruit_as726x import AS726x_UART # maximum value for sensor reading max_val = 16000 @@ -24,8 +25,8 @@ def graph_map(x): sensor = AS726x_I2C(i2c) # for UART use: -#uart = busio.UART(board.TX, board.RX) -#sensor = AS726x_UART(uart) +# uart = busio.UART(board.TX, board.RX) +# sensor = AS726x_UART(uart) sensor.conversion_mode = sensor.MODE_2 From c60848f1ceef464b4a19ee50b125c0c1c9c91e41 Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 10:06:55 -0700 Subject: [PATCH 04/69] this one is lint --- adafruit_as726x.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 608d533..04297af 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -111,7 +111,8 @@ # pylint: disable=too-many-instance-attributes # pylint: disable=too-many-public-methods - +# pylint: disable=invalid-name +# pylint: disable=no-else-return class AS726x: """AS726x spectral sensor base class. @@ -488,8 +489,7 @@ def _uart_xfer(self, cmd): if self._uart.in_waiting: resp = self._uart.read(self._uart.in_waiting) return resp.rstrip(b" OK\n") - else: - return None + return None def _virtual_read(self, addr): if addr == _AS726X_HW_VERSION: @@ -540,3 +540,5 @@ def _virtual_write(self, addr, value): # pylint: enable=too-many-instance-attributes # pylint: enable=too-many-public-methods +# pylint: enable=invalid-name +# pylint: enable=no-else-return \ No newline at end of file From fb443643f8c46af35db59453dec76a96695f6acf Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 10:09:49 -0700 Subject: [PATCH 05/69] and now black is unhappy again? --- adafruit_as726x.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 04297af..e4f5f31 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -114,6 +114,7 @@ # pylint: disable=invalid-name # pylint: disable=no-else-return + class AS726x: """AS726x spectral sensor base class. @@ -541,4 +542,4 @@ def _virtual_write(self, addr, value): # pylint: enable=too-many-instance-attributes # pylint: enable=too-many-public-methods # pylint: enable=invalid-name -# pylint: enable=no-else-return \ No newline at end of file +# pylint: enable=no-else-return From 1aa1ccb0e9563b674e65b5953fdfc718e5ef9b3a Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 10:15:16 -0700 Subject: [PATCH 06/69] they do --- adafruit_as726x.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index e4f5f31..e998891 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -493,6 +493,7 @@ def _uart_xfer(self, cmd): return None def _virtual_read(self, addr): + # pylint: disable=inconsistent-return-statements if addr == _AS726X_HW_VERSION: # just return what is expected return 0x40 From c15610edb2b5750ba985fe2b67b43500f35c84a8 Mon Sep 17 00:00:00 2001 From: caternuson Date: Sat, 18 Apr 2020 10:19:08 -0700 Subject: [PATCH 07/69] no, really, don't --- adafruit_as726x.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index e998891..2a715c5 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -113,6 +113,7 @@ # pylint: disable=too-many-public-methods # pylint: disable=invalid-name # pylint: disable=no-else-return +# pylint: disable=inconsistent-return-statements class AS726x: @@ -493,7 +494,6 @@ def _uart_xfer(self, cmd): return None def _virtual_read(self, addr): - # pylint: disable=inconsistent-return-statements if addr == _AS726X_HW_VERSION: # just return what is expected return 0x40 @@ -544,3 +544,4 @@ def _virtual_write(self, addr, value): # pylint: enable=too-many-public-methods # pylint: enable=invalid-name # pylint: enable=no-else-return +# pylint: enable=inconsistent-return-statements From 9a6710b0032d9154b0ef4ab6552acdfe956e5b04 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 8 Jul 2020 16:49:04 -0400 Subject: [PATCH 08/69] Fixed discord invite link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 76ee33f..681a34a 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :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_AS726x/workflows/Build%20CI/badge.svg From 694464f819058e36e963cbaf823e20b807fbabb4 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 15:06:44 -0500 Subject: [PATCH 09/69] 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 7cbde081ae061a9dcf0737f5d042fff19b25a4ac Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 16:06:47 -0500 Subject: [PATCH 10/69] 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 5d685f649994c18fe52fe12425dffbde48b7e127 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 17:01:28 -0500 Subject: [PATCH 11/69] Ran pre-commit and black, licenses still needed --- CODE_OF_CONDUCT.md | 8 ++++---- adafruit_as726x.py | 40 +++++++++++++++++++--------------------- 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..a62e132 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -43,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 @@ -74,9 +74,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/adafruit_as726x.py b/adafruit_as726x.py index 2a715c5..3e36b18 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -117,9 +117,7 @@ class AS726x: - """AS726x spectral sensor base class. - - """ + """AS726x spectral sensor base class.""" MODE_0 = 0b00 """Continuously gather samples of violet, blue, green and yellow. Orange and red are skipped @@ -204,10 +202,10 @@ def indicator_led(self, val): def driver_led_current(self): """The current limit for the driver LED in milliamps. One of: - - 12.5 mA - - 25 mA - - 50 mA - - 100 mA""" + - 12.5 mA + - 25 mA + - 50 mA + - 100 mA""" return self._driver_led_current @driver_led_current.setter @@ -226,10 +224,10 @@ def driver_led_current(self, val): def indicator_led_current(self): """The current limit for the indicator LED in milliamps. One of: - - 1 mA - - 2 mA - - 4 mA - - 8 mA""" + - 1 mA + - 2 mA + - 4 mA + - 8 mA""" return self._indicator_led_current @indicator_led_current.setter @@ -248,10 +246,10 @@ def indicator_led_current(self, val): def conversion_mode(self): """The conversion mode. One of: - - `MODE_0` - - `MODE_1` - - `MODE_2` - - `ONE_SHOT`""" + - `MODE_0` + - `MODE_1` + - `MODE_2` + - `ONE_SHOT`""" return self._conversion_mode @conversion_mode.setter @@ -300,8 +298,8 @@ def integration_time(self, val): def start_measurement(self): """Begin a measurement. - This will set the device to One Shot mode and values will not change after `data_ready` - until `start_measurement` is called again or the `conversion_mode` is changed.""" + This will set the device to One Shot mode and values will not change after `data_ready` + until `start_measurement` is called again or the `conversion_mode` is changed.""" state = self._virtual_read(_AS726X_CONTROL_SETUP) state &= ~(0x02) self._virtual_write(_AS726X_CONTROL_SETUP, state) @@ -401,8 +399,8 @@ def _virtual_write(self, addr, value): class AS726x_I2C(AS726x): """AS726x spectral sensor via I2C. - :param ~busio.I2C i2c_bus: The I2C bus connected to the sensor - """ + :param ~busio.I2C i2c_bus: The I2C bus connected to the sensor + """ def __init__(self, i2c_bus, address=_AS726X_ADDRESS): self.i2c_device = I2CDevice(i2c_bus, address) @@ -467,8 +465,8 @@ def _virtual_write(self, addr, value): class AS726x_UART(AS726x): """AS726x spectral sensor via UART. - :param ~busio.UART uart: The UART connected to the sensor - """ + :param ~busio.UART uart: The UART connected to the sensor + """ def __init__(self, uart): self._uart = uart From 8c54671377df40b0359f0d5a7c0fb92fb92c6c5d Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 17:20:50 -0500 Subject: [PATCH 12/69] Added licenses --- .gitignore | 4 + .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 6 + LICENSES/CC-BY-4.0.txt | 324 +++++++++++++++++++++++++++++++ LICENSES/MIT.txt | 19 ++ LICENSES/Unlicense.txt | 20 ++ README.rst.license | 3 + adafruit_as726x.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/as726x_simpletest.py | 3 + requirements.txt | 4 + setup.py | 4 + 17 files changed, 414 insertions(+), 20 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 1be1c4b..18d8cfc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ diff --git a/.pylintrc b/.pylintrc index d8f0ee8..f6fa550 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2020 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..132b39d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2020 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 a62e132..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge 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.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_as726x.py b/adafruit_as726x.py index 3e36b18..4507b1a 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Dean Miller for Adafruit Industries # -# Copyright (c) 2017 Dean Miller 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_as726x` ==================================================== 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 e72874b..71af868 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2020 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/as726x_simpletest.py b/examples/as726x_simpletest.py index 4ed5e95..24b8b25 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import time import board diff --git a/requirements.txt b/requirements.txt index d5d88a1..0930088 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index 785afd4..515b653 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: From 560be8f2a94fe7709a0e982978454905437c0b91 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Feb 2021 16:38:51 -0500 Subject: [PATCH 13/69] 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 f8ab663383fc5b4809e01f556f8a39b4b5e03c08 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 16:46:17 -0500 Subject: [PATCH 14/69] 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 f6fa550..55bd547 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 bed8790c94ece61e8932a408c813a323d57bffff Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 17:17:50 -0500 Subject: [PATCH 15/69] 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 97356126f40f791e0a79dd83ed1173a5718ee7b2 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 19 Mar 2021 13:40:44 -0400 Subject: [PATCH 16/69] "Increase duplicate code check threshold " --- .pylintrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.pylintrc b/.pylintrc index 55bd547..1dff3f2 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 e73945558daa96a399fef010cd23c2dc80313650 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sun, 25 Apr 2021 16:38:04 -0400 Subject: [PATCH 17/69] improving_docs --- adafruit_as726x.py | 87 +++++++++++++++++++++++++++++++++-- docs/index.rst | 4 ++ examples/as726x_simpletest.py | 6 +-- 3 files changed, 90 insertions(+), 7 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 4507b1a..cd6dbf2 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -9,6 +9,22 @@ Driver for the AS726x spectral sensors * Author(s): Dean Miller + +Implementation Notes +-------------------- + +**Hardware:** + +* Adafruit `AS7262 6-Channel Visible Light / Color Sensor Breakout + `_ (Product ID: 3779) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + """ import time @@ -281,8 +297,10 @@ def integration_time(self, val): def start_measurement(self): """Begin a measurement. - This will set the device to One Shot mode and values will not change after `data_ready` - until `start_measurement` is called again or the `conversion_mode` is changed.""" + This will set the device to One Shot mode and values will + not change after `data_ready` until :meth:`start_measurement` + is called again or the :meth:`conversion_mode` is changed. + """ state = self._virtual_read(_AS726X_CONTROL_SETUP) state &= ~(0x02) self._virtual_write(_AS726X_CONTROL_SETUP, state) @@ -382,7 +400,39 @@ def _virtual_write(self, addr, value): class AS726x_I2C(AS726x): """AS726x spectral sensor via I2C. - :param ~busio.I2C i2c_bus: The I2C bus connected to the sensor + :param ~busio.I2C i2c_bus: The I2C bus the AS726x is connected to + :param int address: The I2C device address. Defaults to :const:`0x49` + + + **Quickstart: Importing and using the AS726x** + + Here is an example of using the :class:`AS726x_I2C` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_as726x import AS726x_I2C + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + sensor = AS726x_I2C(i2c) + + Now you have access to the different color attributes + + .. code-block:: python + + violet = sensor.violet + blue = sensor.blue + green = sensor.green + yellow = sensor.yellow + orange = sensor.orange + red = sensor.red + + """ def __init__(self, i2c_bus, address=_AS726X_ADDRESS): @@ -449,6 +499,37 @@ class AS726x_UART(AS726x): """AS726x spectral sensor via UART. :param ~busio.UART uart: The UART connected to the sensor + + + **Quickstart: Importing and using the AS726x** + + Here is an example of using the :class:`AS726x_I2C` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_as726x import AS726x_UART + + Once this is done you can define your `board.UART` object and define your sensor object + + .. code-block:: python + + uart = board.UART() # uses board.SCL and board.SDA + sensor = AS726x_UART(uart) + + Now you have access to the different color attributes + + .. code-block:: python + + violet = sensor.violet + blue = sensor.blue + green = sensor.green + yellow = sensor.yellow + orange = sensor.orange + red = sensor.red + + """ def __init__(self, uart): diff --git a/docs/index.rst b/docs/index.rst index c39933a..d782707 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,9 +23,13 @@ Table of Contents .. toctree:: :caption: Tutorials + Adafruit AS7262 6-Channel Visible Light / Color Sensor Breakout Learning Guide + .. toctree:: :caption: Related Products + Adafruit AS7262 6-Channel Visible Light / Color Sensor Breakout + .. toctree:: :caption: Other Links diff --git a/examples/as726x_simpletest.py b/examples/as726x_simpletest.py index 24b8b25..78a0214 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -2,9 +2,7 @@ # SPDX-License-Identifier: MIT import time - import board -import busio # for I2C use: from adafruit_as726x import AS726x_I2C @@ -24,11 +22,11 @@ def graph_map(x): # for I2C use: -i2c = busio.I2C(board.SCL, board.SDA) +i2c = board.I2C() sensor = AS726x_I2C(i2c) # for UART use: -# uart = busio.UART(board.TX, board.RX) +# uart = board.UART() # sensor = AS726x_UART(uart) sensor.conversion_mode = sensor.MODE_2 From ccbcf0cd9beee7261d40025fd0609dd66a82e6aa Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:32:42 -0400 Subject: [PATCH 18/69] 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 df7c5b5d744a0ad9b1f2bf2ab27322d6cde72d34 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:35:18 -0400 Subject: [PATCH 19/69] 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 e7ac7fdfc08f8f5a30419ff0e3bcf3063bdbbaf7 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 May 2021 09:54:31 -0400 Subject: [PATCH 20/69] 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 bbaf3f1a4104e29a13b567ffc2f2480be45e06b0 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 3 Jun 2021 10:51:42 -0400 Subject: [PATCH 21/69] Moved default branch to main --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 681a34a..3e526b7 100644 --- a/README.rst +++ b/README.rst @@ -58,7 +58,7 @@ Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Documentation From 65abee91b23bc1d48064c378240920a02d951dc7 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 23 Sep 2021 17:52:55 -0400 Subject: [PATCH 22/69] 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 91f642e850a6dd85433de6b1c939d44ecf578a6c Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 25 Oct 2021 11:13:20 -0500 Subject: [PATCH 23/69] add docs link to readme --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 3e526b7..9eb293c 100644 --- a/README.rst +++ b/README.rst @@ -54,6 +54,11 @@ To install in a virtual environment in your current project: source .env/bin/activate pip3 install adafruit-circuitpython-as726x +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + Contributing ============ From b65f2b1e109f6fab132fe044f91d76f889ce3a91 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Nov 2021 14:40:16 -0400 Subject: [PATCH 24/69] 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 1dff3f2..e851cd6 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 132b39d..9c9ad71 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 ddbfba8ab31459e278558cea7fadc86f986a7f7f Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 25/69] 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 e851cd6..f7eb6bd 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 928e3c3cc3735ecd4895187835871f5a17de2e8b Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 15:30:07 -0500 Subject: [PATCH 26/69] Updated readthedocs file --- .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 9c9ad71..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 6f0b3f0c02b384ef7029bcde4e5740708e0b6a28 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 12:59:05 -0600 Subject: [PATCH 27/69] 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 84835d377bb2bc11cd6ebb26b5830fe38307a905 Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Wed, 22 Dec 2021 09:45:47 -0500 Subject: [PATCH 28/69] Remove obsolete reference to ustruct --- adafruit_as726x.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index cd6dbf2..6d7e723 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -26,16 +26,11 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ - +import struct import time from adafruit_bus_device.i2c_device import I2CDevice from micropython import const -try: - import struct -except ImportError: - import ustruct as struct - __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AS726x.git" From 844e97cc9837035b172496b1c4ea9de7d18a0678 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 29/69] 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 c7f994f51b23e3c9f630c27b0719903b58c2f3e4 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:16 -0500 Subject: [PATCH 30/69] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 9eb293c..c6ee3c1 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-as726x/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/as726x/en/latest/ + :target: https://docs.circuitpython.org/projects/as726x/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -57,7 +57,7 @@ To install in a virtual environment in your current project: 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 71af868..0069641 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,16 +23,16 @@ autodoc_member_order = "bysource" intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), "Register": ( - "https://circuitpython.readthedocs.io/projects/register/en/latest/", + "https://docs.circuitpython.org/projects/register/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", 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 d782707..71ae2d2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,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 515b653..30b21b8 100644 --- a/setup.py +++ b/setup.py @@ -49,8 +49,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 as726x light sensor hardware micropython circuitpython", From 161de2770266155fd97901a77ee2c766862e7d4e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 12:37:56 -0500 Subject: [PATCH 31/69] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index c6ee3c1..bf28886 100644 --- a/README.rst +++ b/README.rst @@ -59,14 +59,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 d36de7101ac31243aafaa74e0bdd212f97d67f02 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 12:02:08 -0700 Subject: [PATCH 32/69] Added type annotations to adafruit_as726x.py --- adafruit_as726x.py | 205 +++++++++++++++++++++++---------------------- 1 file changed, 106 insertions(+), 99 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 6d7e723..c50b0ea 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -30,63 +30,70 @@ import time from adafruit_bus_device.i2c_device import I2CDevice from micropython import const +import busio -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AS726x.git" +try: + from typing import Tuple +except ImportError: + pass -_AS726X_ADDRESS = const(0x49) -_AS726X_HW_VERSION = const(0x00) -_AS726X_FW_VERSION = const(0x02) -_AS726X_CONTROL_SETUP = const(0x04) -_AS726X_INT_T = const(0x05) -_AS726X_DEVICE_TEMP = const(0x06) -_AS726X_LED_CONTROL = const(0x07) +__version__: str = "0.0.0-auto.0" +__repo__: str = "https://github.com/adafruit/Adafruit_CircuitPython_AS726x.git" + +_AS726X_ADDRESS: int = const(0x49) + +_AS726X_HW_VERSION: int = const(0x00) +_AS726X_FW_VERSION: int = const(0x02) +_AS726X_CONTROL_SETUP: int = const(0x04) +_AS726X_INT_T: int = const(0x05) +_AS726X_DEVICE_TEMP: int = const(0x06) +_AS726X_LED_CONTROL: int = const(0x07) # for reading sensor data -_AS7262_V_HIGH = const(0x08) -_AS7262_V_LOW = const(0x09) -_AS7262_B_HIGH = const(0x0A) -_AS7262_B_LOW = const(0x0B) -_AS7262_G_HIGH = const(0x0C) -_AS7262_G_LOW = const(0x0D) -_AS7262_Y_HIGH = const(0x0E) -_AS7262_Y_LOW = const(0x0F) -_AS7262_O_HIGH = const(0x10) -_AS7262_O_LOW = const(0x11) -_AS7262_R_HIGH = const(0x12) -_AS7262_R_LOW = const(0x13) - -_AS7262_V_CAL = const(0x14) -_AS7262_B_CAL = const(0x18) -_AS7262_G_CAL = const(0x1C) -_AS7262_Y_CAL = const(0x20) -_AS7262_O_CAL = const(0x24) -_AS7262_R_CAL = const(0x28) +_AS7262_V_HIGH: int = const(0x08) +_AS7262_V_LOW: int = const(0x09) +_AS7262_B_HIGH: int = const(0x0A) +_AS7262_B_LOW: int = const(0x0B) +_AS7262_G_HIGH: int = const(0x0C) +_AS7262_G_LOW: int = const(0x0D) +_AS7262_Y_HIGH: int = const(0x0E) +_AS7262_Y_LOW: int = const(0x0F) +_AS7262_O_HIGH: int = const(0x10) +_AS7262_O_LOW: int = const(0x11) +_AS7262_R_HIGH: int = const(0x12) +_AS7262_R_LOW: int = const(0x13) + +_AS7262_V_CAL: int = const(0x14) +_AS7262_B_CAL: int = const(0x18) +_AS7262_G_CAL: int = const(0x1C) +_AS7262_Y_CAL: int = const(0x20) +_AS7262_O_CAL: int = const(0x24) +_AS7262_R_CAL: int = const(0x28) # hardware registers -_AS726X_SLAVE_STATUS_REG = const(0x00) -_AS726X_SLAVE_WRITE_REG = const(0x01) -_AS726X_SLAVE_READ_REG = const(0x02) -_AS726X_SLAVE_TX_VALID = const(0x02) -_AS726X_SLAVE_RX_VALID = const(0x01) - -_AS7262_VIOLET = const(0x08) -_AS7262_BLUE = const(0x0A) -_AS7262_GREEN = const(0x0C) -_AS7262_YELLOW = const(0x0E) -_AS7262_ORANGE = const(0x10) -_AS7262_RED = const(0x12) -_AS7262_VIOLET_CALIBRATED = const(0x14) -_AS7262_BLUE_CALIBRATED = const(0x18) -_AS7262_GREEN_CALIBRATED = const(0x1C) +_AS726X_SLAVE_STATUS_REG: int = const(0x00) +_AS726X_SLAVE_WRITE_REG: int = const(0x01) +_AS726X_SLAVE_READ_REG: int = const(0x02) +_AS726X_SLAVE_TX_VALID: int = const(0x02) +_AS726X_SLAVE_RX_VALID: int = const(0x01) + +_AS7262_VIOLET: int = const(0x08) +_AS7262_BLUE: int = const(0x0A) +_AS7262_GREEN: int = const(0x0C) +_AS7262_YELLOW: int = const(0x0E) +_AS7262_ORANGE: int = const(0x10) +_AS7262_RED: int = const(0x12) +_AS7262_VIOLET_CALIBRATED: int = const(0x14) +_AS7262_BLUE_CALIBRATED: int = const(0x18) +_AS7262_GREEN_CALIBRATED: int = const(0x1C) _AS7262_YELLOW_CALIBRATED = const(0x20) -_AS7262_ORANGE_CALIBRATED = const(0x24) -_AS7262_RED_CALIBRATED = const(0x28) +_AS7262_ORANGE_CALIBRATED: int = const(0x24) +_AS7262_RED_CALIBRATED: int = const(0x28) -_AS726X_NUM_CHANNELS = const(6) +_AS726X_NUM_CHANNELS: int = const(6) -_COLOR_REGS = ( +_COLOR_REGS: Tuple[int, ...] = ( _AS7262_VIOLET, _AS7262_BLUE, _AS7262_GREEN, @@ -94,7 +101,7 @@ _AS7262_ORANGE, _AS7262_RED, ) -_COLOR_REGS_CALIBRATED = ( +_COLOR_REGS_CALIBRATED: Tuple[int, ...] = ( _AS7262_VIOLET_CALIBRATED, _AS7262_BLUE_CALIBRATED, _AS7262_GREEN_CALIBRATED, @@ -113,25 +120,25 @@ class AS726x: """AS726x spectral sensor base class.""" - MODE_0 = 0b00 + MODE_0: int = 0b00 """Continuously gather samples of violet, blue, green and yellow. Orange and red are skipped and read zero.""" - MODE_1 = 0b01 + MODE_1: int = 0b01 """Continuously gather samples of green, yellow, orange and red. Violet and blue are skipped and read zero.""" - MODE_2 = 0b10 # default + MODE_2: int = 0b10 # default """Continuously gather samples of all colors""" - ONE_SHOT = 0b11 + ONE_SHOT: int = 0b11 """Gather a single sample of all colors and then stop""" - GAIN = (1, 3.7, 16, 64) + GAIN: Tuple[float, ...] = (1, 3.7, 16, 64) - INDICATOR_CURRENT_LIMITS = (1, 2, 4, 8) + INDICATOR_CURRENT_LIMITS: Tuple[int, ...] = (1, 2, 4, 8) - DRIVER_CURRENT_LIMITS = (12.5, 25, 50, 100) + DRIVER_CURRENT_LIMITS: Tuple[float, ...] = (12.5, 25, 50, 100) def __init__(self): self._driver_led = False @@ -163,12 +170,12 @@ def __init__(self): self.gain = 64 @property - def driver_led(self): + def driver_led(self) -> bool: """True when the driver LED is on. False otherwise.""" return self._driver_led @driver_led.setter - def driver_led(self, val): + def driver_led(self, val: bool) -> None: val = bool(val) if self._driver_led == val: return @@ -178,12 +185,12 @@ def driver_led(self, val): self._virtual_write(_AS726X_LED_CONTROL, enable | (val << 3)) @property - def indicator_led(self): + def indicator_led(self) -> bool: """True when the indicator LED is on. False otherwise.""" return self._indicator_led @indicator_led.setter - def indicator_led(self, val): + def indicator_led(self, val: bool) -> None: val = bool(val) if self._indicator_led == val: return @@ -193,7 +200,7 @@ def indicator_led(self, val): self._virtual_write(_AS726X_LED_CONTROL, enable | val) @property - def driver_led_current(self): + def driver_led_current(self) -> float: """The current limit for the driver LED in milliamps. One of: - 12.5 mA @@ -203,7 +210,7 @@ def driver_led_current(self): return self._driver_led_current @driver_led_current.setter - def driver_led_current(self, val): + def driver_led_current(self, val: float) -> None: if val not in AS726x.DRIVER_CURRENT_LIMITS: raise ValueError("Must be 12.5, 25, 50 or 100") if self._driver_led_current == val: @@ -215,7 +222,7 @@ def driver_led_current(self, val): self._virtual_write(_AS726X_LED_CONTROL, state) @property - def indicator_led_current(self): + def indicator_led_current(self) -> int: """The current limit for the indicator LED in milliamps. One of: - 1 mA @@ -225,7 +232,7 @@ def indicator_led_current(self): return self._indicator_led_current @indicator_led_current.setter - def indicator_led_current(self, val): + def indicator_led_current(self, val: int) -> None: if val not in AS726x.INDICATOR_CURRENT_LIMITS: raise ValueError("Must be 1, 2, 4 or 8") if self._indicator_led_current == val: @@ -237,7 +244,7 @@ def indicator_led_current(self, val): self._virtual_write(_AS726X_LED_CONTROL, state) @property - def conversion_mode(self): + def conversion_mode(self) -> int: """The conversion mode. One of: - `MODE_0` @@ -247,7 +254,7 @@ def conversion_mode(self): return self._conversion_mode @conversion_mode.setter - def conversion_mode(self, val): + def conversion_mode(self, val: int) -> None: val = int(val) assert self.MODE_0 <= val <= self.ONE_SHOT if self._conversion_mode == val: @@ -258,12 +265,12 @@ def conversion_mode(self, val): self._virtual_write(_AS726X_CONTROL_SETUP, state | (val << 2)) @property - def gain(self): + def gain(self) -> int: """The gain for the sensor""" return self._gain @gain.setter - def gain(self, val): + def gain(self, val: int) -> None: if val not in AS726x.GAIN: raise ValueError("Must be 1, 3.7, 16 or 64") if self._gain == val: @@ -275,12 +282,12 @@ def gain(self, val): self._virtual_write(_AS726X_CONTROL_SETUP, state) @property - def integration_time(self): + def integration_time(self) -> float: """The integration time in milliseconds between 2.8 and 714 ms""" return self._integration_time @integration_time.setter - def integration_time(self, val): + def integration_time(self, val: float) -> None: val = int(val) if not 2.8 <= val <= 714: raise ValueError("Out of supported range 2.8 - 714 ms") @@ -289,7 +296,7 @@ def integration_time(self, val): self._integration_time = val self._virtual_write(_AS726X_INT_T, int(val / 2.8)) - def start_measurement(self): + def start_measurement(self) -> None: """Begin a measurement. This will set the device to One Shot mode and values will @@ -302,11 +309,11 @@ def start_measurement(self): self.conversion_mode = self.ONE_SHOT - def read_channel(self, channel): + def read_channel(self, channel: int) -> int: """Read an individual sensor channel""" return (self._virtual_read(channel) << 8) | self._virtual_read(channel + 1) - def read_calibrated_value(self, channel): + def read_calibrated_value(self, channel: int) -> float: """Read a calibrated sensor channel""" val = bytearray(4) val[0] = self._virtual_read(channel) @@ -316,79 +323,79 @@ def read_calibrated_value(self, channel): return struct.unpack("!f", val)[0] @property - def data_ready(self): + def data_ready(self) -> bool: """True if the sensor has data ready to be read, False otherwise""" return (self._virtual_read(_AS726X_CONTROL_SETUP) >> 1) & 0x01 @property - def temperature(self): + def temperature(self) -> int: """The temperature of the device in Celsius""" return self._virtual_read(_AS726X_DEVICE_TEMP) @property - def violet(self): + def violet(self) -> float: """Calibrated violet (450nm) value""" return self.read_calibrated_value(_AS7262_VIOLET_CALIBRATED) @property - def blue(self): + def blue(self) -> float: """Calibrated blue (500nm) value""" return self.read_calibrated_value(_AS7262_BLUE_CALIBRATED) @property - def green(self): + def green(self) -> float: """Calibrated green (550nm) value""" return self.read_calibrated_value(_AS7262_GREEN_CALIBRATED) @property - def yellow(self): + def yellow(self) -> float: """Calibrated yellow (570nm) value""" return self.read_calibrated_value(_AS7262_YELLOW_CALIBRATED) @property - def orange(self): + def orange(self) -> float: """Calibrated orange (600nm) value""" return self.read_calibrated_value(_AS7262_ORANGE_CALIBRATED) @property - def red(self): + def red(self) -> float: """Calibrated red (650nm) value""" return self.read_calibrated_value(_AS7262_RED_CALIBRATED) @property - def raw_violet(self): + def raw_violet(self) -> int: """Raw violet (450nm) 16-bit value""" return self.read_channel(_AS7262_VIOLET) @property - def raw_blue(self): + def raw_blue(self) -> int: """Raw blue (500nm) 16-bit value""" return self.read_channel(_AS7262_BLUE) @property - def raw_green(self): + def raw_green(self) -> int: """Raw green (550nm) 16-bit value""" return self.read_channel(_AS7262_GREEN) @property - def raw_yellow(self): + def raw_yellow(self) -> int: """Raw yellow (570nm) 16-bit value""" return self.read_channel(_AS7262_YELLOW) @property - def raw_orange(self): + def raw_orange(self) -> int: """Raw orange (600nm) 16-bit value""" return self.read_channel(_AS7262_ORANGE) @property - def raw_red(self): + def raw_red(self) -> int: """Raw red (650nm) 16-bit value""" return self.read_channel(_AS7262_RED) - def _virtual_read(self, addr): + def _virtual_read(self, addr: int) -> int: raise NotImplementedError("Must be implemented.") - def _virtual_write(self, addr, value): + def _virtual_write(self, addr: int, value: int) -> None: raise NotImplementedError("Must be implemented.") @@ -430,11 +437,11 @@ class AS726x_I2C(AS726x): """ - def __init__(self, i2c_bus, address=_AS726X_ADDRESS): + def __init__(self, i2c_bus: busio.I2C, address: int = _AS726X_ADDRESS): self.i2c_device = I2CDevice(i2c_bus, address) super().__init__() - def _read_u8(self, command): + def _read_u8(self, command: int) -> int: """read a single byte from a specified register""" buf = self.buf2 buf[0] = command @@ -443,7 +450,7 @@ def _read_u8(self, command): i2c.readinto(buf, end=1) return buf[0] - def __write_u8(self, command, abyte): + def __write_u8(self, command: int, abyte: int) -> None: """Write a command and 1 byte of data to the I2C device""" buf = self.buf2 buf[0] = command @@ -451,7 +458,7 @@ def __write_u8(self, command, abyte): with self.i2c_device as i2c: i2c.write(buf) - def _virtual_read(self, addr): + def _virtual_read(self, addr: int) -> int: """read a virtual register""" while True: # Read slave I2C status to see if the read buffer is ready. @@ -471,7 +478,7 @@ def _virtual_read(self, addr): data = self._read_u8(_AS726X_SLAVE_READ_REG) return data - def _virtual_write(self, addr, value): + def _virtual_write(self, addr: int, value: int) -> None: """write a virtual register""" while True: # Read slave I2C status to see if the write buffer is ready. @@ -527,20 +534,20 @@ class AS726x_UART(AS726x): """ - def __init__(self, uart): + def __init__(self, uart: busio.UART): self._uart = uart self._uart.baudrate = 115200 super().__init__() - def read_channel(self, channel): + def read_channel(self, channel: int) -> int: """Read an individual sensor channel""" return self._virtual_read(channel) - def read_calibrated_value(self, channel): + def read_calibrated_value(self, channel: int) -> float: """Read a calibrated sensor channel""" return self._virtual_read(channel) - def _uart_xfer(self, cmd): + def _uart_xfer(self, cmd: int) -> int: self._uart.reset_input_buffer() cmd += "\n" self._uart.write(cmd.encode()) @@ -550,7 +557,7 @@ def _uart_xfer(self, cmd): return resp.rstrip(b" OK\n") return None - def _virtual_read(self, addr): + def _virtual_read(self, addr: int) -> int: if addr == _AS726X_HW_VERSION: # just return what is expected return 0x40 @@ -573,7 +580,7 @@ def _virtual_read(self, addr): resp = resp.decode().split(",") return float(resp[_COLOR_REGS_CALIBRATED.index(addr)]) - def _virtual_write(self, addr, value): + def _virtual_write(self, addr: int, value: int) -> None: if addr == _AS726X_CONTROL_SETUP: # check for reset if (value >> 7) & 0x01: From ef0473b1de17b961bff75707bc7de2faefb44edc Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 15:07:14 -0700 Subject: [PATCH 33/69] Moved busio import inside the try block for typing --- adafruit_as726x.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index c50b0ea..37c4a63 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -30,10 +30,12 @@ import time from adafruit_bus_device.i2c_device import I2CDevice from micropython import const -import busio try: from typing import Tuple + + # This is only needed for typing + import busio # pylint: disable=unused-import except ImportError: pass From 1f9d8c5e6e9f8e7e1cca16c37fee56ac9020e47f Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 16:21:11 -0700 Subject: [PATCH 34/69] Resolve review comments from tekktrik --- adafruit_as726x.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 37c4a63..490cd63 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -32,7 +32,7 @@ from micropython import const try: - from typing import Tuple + from typing import Tuple, Optional, Union # This is only needed for typing import busio # pylint: disable=unused-import @@ -267,12 +267,12 @@ def conversion_mode(self, val: int) -> None: self._virtual_write(_AS726X_CONTROL_SETUP, state | (val << 2)) @property - def gain(self) -> int: + def gain(self) -> float: """The gain for the sensor""" return self._gain @gain.setter - def gain(self, val: int) -> None: + def gain(self, val: float) -> None: if val not in AS726x.GAIN: raise ValueError("Must be 1, 3.7, 16 or 64") if self._gain == val: @@ -394,10 +394,10 @@ def raw_red(self) -> int: """Raw red (650nm) 16-bit value""" return self.read_channel(_AS7262_RED) - def _virtual_read(self, addr: int) -> int: + def _virtual_read(self, addr: int) -> Union[int, float]: raise NotImplementedError("Must be implemented.") - def _virtual_write(self, addr: int, value: int) -> None: + def _virtual_write(self, addr: int, value: Union[int, float]) -> None: raise NotImplementedError("Must be implemented.") @@ -439,7 +439,7 @@ class AS726x_I2C(AS726x): """ - def __init__(self, i2c_bus: busio.I2C, address: int = _AS726X_ADDRESS): + def __init__(self, i2c_bus: busio.I2C, address: int = _AS726X_ADDRESS) -> None: self.i2c_device = I2CDevice(i2c_bus, address) super().__init__() @@ -460,7 +460,7 @@ def __write_u8(self, command: int, abyte: int) -> None: with self.i2c_device as i2c: i2c.write(buf) - def _virtual_read(self, addr: int) -> int: + def _virtual_read(self, addr: int) -> Union[int, float]: """read a virtual register""" while True: # Read slave I2C status to see if the read buffer is ready. @@ -480,7 +480,7 @@ def _virtual_read(self, addr: int) -> int: data = self._read_u8(_AS726X_SLAVE_READ_REG) return data - def _virtual_write(self, addr: int, value: int) -> None: + def _virtual_write(self, addr: int, value: Union[int, float]) -> None: """write a virtual register""" while True: # Read slave I2C status to see if the write buffer is ready. @@ -536,12 +536,12 @@ class AS726x_UART(AS726x): """ - def __init__(self, uart: busio.UART): + def __init__(self, uart: busio.UART) -> None: self._uart = uart self._uart.baudrate = 115200 super().__init__() - def read_channel(self, channel: int) -> int: + def read_channel(self, channel: int) -> float: """Read an individual sensor channel""" return self._virtual_read(channel) @@ -549,7 +549,7 @@ def read_calibrated_value(self, channel: int) -> float: """Read a calibrated sensor channel""" return self._virtual_read(channel) - def _uart_xfer(self, cmd: int) -> int: + def _uart_xfer(self, cmd: Optional[str]) -> str: self._uart.reset_input_buffer() cmd += "\n" self._uart.write(cmd.encode()) @@ -559,7 +559,7 @@ def _uart_xfer(self, cmd: int) -> int: return resp.rstrip(b" OK\n") return None - def _virtual_read(self, addr: int) -> int: + def _virtual_read(self, addr: int) -> Union[int, float]: if addr == _AS726X_HW_VERSION: # just return what is expected return 0x40 @@ -582,7 +582,7 @@ def _virtual_read(self, addr: int) -> int: resp = resp.decode().split(",") return float(resp[_COLOR_REGS_CALIBRATED.index(addr)]) - def _virtual_write(self, addr: int, value: int) -> None: + def _virtual_write(self, addr: int, value: Union[int, float]) -> None: if addr == _AS726X_CONTROL_SETUP: # check for reset if (value >> 7) & 0x01: From 871500b896ee9d84920d583c2dba36dfc0fa22c2 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 16:58:49 -0700 Subject: [PATCH 35/69] change `Union[float,int]` to `float` per PEP 484 --- adafruit_as726x.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 490cd63..db29229 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -32,7 +32,7 @@ from micropython import const try: - from typing import Tuple, Optional, Union + from typing import Tuple, Optional # This is only needed for typing import busio # pylint: disable=unused-import @@ -394,10 +394,10 @@ def raw_red(self) -> int: """Raw red (650nm) 16-bit value""" return self.read_channel(_AS7262_RED) - def _virtual_read(self, addr: int) -> Union[int, float]: + def _virtual_read(self, addr: int) -> float: raise NotImplementedError("Must be implemented.") - def _virtual_write(self, addr: int, value: Union[int, float]) -> None: + def _virtual_write(self, addr: int, value: float) -> None: raise NotImplementedError("Must be implemented.") @@ -460,7 +460,7 @@ def __write_u8(self, command: int, abyte: int) -> None: with self.i2c_device as i2c: i2c.write(buf) - def _virtual_read(self, addr: int) -> Union[int, float]: + def _virtual_read(self, addr: int) -> float: """read a virtual register""" while True: # Read slave I2C status to see if the read buffer is ready. @@ -480,7 +480,7 @@ def _virtual_read(self, addr: int) -> Union[int, float]: data = self._read_u8(_AS726X_SLAVE_READ_REG) return data - def _virtual_write(self, addr: int, value: Union[int, float]) -> None: + def _virtual_write(self, addr: int, value: float) -> None: """write a virtual register""" while True: # Read slave I2C status to see if the write buffer is ready. @@ -559,7 +559,7 @@ def _uart_xfer(self, cmd: Optional[str]) -> str: return resp.rstrip(b" OK\n") return None - def _virtual_read(self, addr: int) -> Union[int, float]: + def _virtual_read(self, addr: int) -> float: if addr == _AS726X_HW_VERSION: # just return what is expected return 0x40 @@ -582,7 +582,7 @@ def _virtual_read(self, addr: int) -> Union[int, float]: resp = resp.decode().split(",") return float(resp[_COLOR_REGS_CALIBRATED.index(addr)]) - def _virtual_write(self, addr: int, value: Union[int, float]) -> None: + def _virtual_write(self, addr: int, value: float) -> None: if addr == _AS726X_CONTROL_SETUP: # check for reset if (value >> 7) & 0x01: From 253abb16d58c6d8a0b3d771b68ab29c52fa93cfb Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 36/69] 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 cae9bfd8f1726bda3c1a77c7ddabe6a01df467d8 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 37/69] 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 32322bd3f74cf5646e7518c83bc0f24097c253bb Mon Sep 17 00:00:00 2001 From: Eva Herrada <33632497+evaherrada@users.noreply.github.com> Date: Thu, 21 Apr 2022 18:43:18 -0400 Subject: [PATCH 38/69] Update .gitignore --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 18d8cfc..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2020 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 2c0b15bd12d32a34cd97735a0945887b9ff8d549 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:19 -0400 Subject: [PATCH 39/69] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index bf28886..e2c5238 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/as726x/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 23a5b888086352e11aa42c7ff4e3febf52f365da Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:49:05 -0500 Subject: [PATCH 40/69] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e2c5238..20d198d 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/as726x/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 fa37739e5b88dcc4f9c2c5201a605c113bb83efb Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:21:05 -0400 Subject: [PATCH 41/69] 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 c3b0bbe0de5d37dd86b37a07e88e600e451a019f Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 42/69] 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 f7eb6bd..3b0a120 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 950e27adc4a7e3235c061c9d3962496956f3096a Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 43/69] 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 3b0a120..3c88767 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 5f16751c8d247dd5ceaa625c9a720e4f2031e568 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 44/69] 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 0069641..b6e0671 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -62,7 +62,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 3866cb2b2f0d78f039a47239d5183b4e6b4522ea Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:00 -0400 Subject: [PATCH 45/69] 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 71ae2d2..37655c0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From 4cfd77b32da3e8ac04272c3a03a16af5e52b1935 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:28 -0400 Subject: [PATCH 46/69] 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 20d198d..1effcbf 100644 --- a/README.rst +++ b/README.rst @@ -50,8 +50,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-as726x Documentation From 5f898bd2f6c703f1d0e8984cbe6a69466427b707 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:20 -0400 Subject: [PATCH 47/69] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 1effcbf..304dd15 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AS726x/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 + Driver for the AS726x spectral sensors Installation and Dependencies From 38466e708a7df5c5e5515d8060d9e44d6c787a58 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:52 -0400 Subject: [PATCH 48/69] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++----- .github/workflows/release.yml | 17 +++++----- optional_requirements.txt | 3 ++ pyproject.toml | 45 +++++++++++++++++++++++++++ requirements.txt | 4 +-- setup.py | 58 ----------------------------------- 6 files changed, 70 insertions(+), 75 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..dad42e7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-as726x" +description = "CircuitPython driver for AS726x spectral sensor." +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_AS726x"} +keywords = [ + "adafruit", + "as726x", + "light", + "sensor", + "hardware", + "micropython", + "circuitpython", +] +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_as726x"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 0930088..fcef575 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-busdevice adafruit-circuitpython-register +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py deleted file mode 100644 index 30b21b8..0000000 --- a/setup.py +++ /dev/null @@ -1,58 +0,0 @@ -# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-as726x", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython driver for AS726x spectral sensor.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_AS726x", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-register", - "adafruit-circuitpython-busdevice", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit as726x light sensor hardware micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_as726x"], -) From 56fa33c82b8594fc87bb2daf2e3ccbcd87e8b053 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 49/69] 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 dad42e7..7982731 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From ca038218339235d98a30b50eb791488b53cc2540 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:12 -0400 Subject: [PATCH 50/69] Update version string --- adafruit_as726x.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_as726x.py b/adafruit_as726x.py index db29229..17ad233 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -40,7 +40,7 @@ pass -__version__: str = "0.0.0-auto.0" +__version__: str = "0.0.0+auto.0" __repo__: str = "https://github.com/adafruit/Adafruit_CircuitPython_AS726x.git" _AS726X_ADDRESS: int = const(0x49) diff --git a/pyproject.toml b/pyproject.toml index 7982731..32dd90f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-as726x" description = "CircuitPython driver for AS726x spectral sensor." -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From dc66c2bea3e54a8a1af97484d105e30893df2eb5 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:12 -0400 Subject: [PATCH 51/69] 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 8589decc54f42d6331dfe041407434984560a7c2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:29 -0400 Subject: [PATCH 52/69] 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 b6e0671..665102a 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("..")) @@ -45,7 +46,8 @@ # General information about the project. project = "Adafruit AS726x Library" -copyright = "2017 Dean Miller" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Dean Miller" author = "Dean Miller" # The version info for the project you're documenting, acts as replacement for From 39cc6dd11f0bcf461ed01439a961654d1f8d1a43 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:20 -0400 Subject: [PATCH 53/69] 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 665102a..346382a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,8 +46,14 @@ # General information about the project. project = "Adafruit AS726x Library" +creation_year = "2017" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Dean Miller" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Dean Miller" author = "Dean Miller" # The version info for the project you're documenting, acts as replacement for From 86e6ea6a423e0ec0330d36aaa6f176cad6cacd87 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:49 -0400 Subject: [PATCH 54/69] 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 e668cd3c48933fde433304fa5d5eadd1b5f2272d Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:46:59 -0400 Subject: [PATCH 55/69] 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 8d0b4b3a8f95a1d9c6a08b70078a066bcdb8cf73 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:19 -0400 Subject: [PATCH 56/69] 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 7e3e582feb74c66b6954e8381a9f796fffddb24c Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:43 -0400 Subject: [PATCH 57/69] 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 1dfa940d019534e7151c7aa125be5d101ab2a490 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:32 -0400 Subject: [PATCH 58/69] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index 3c88767..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2020 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 c665ce14b1e289bbd3b1128a41e2511cf9943753 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:20 -0500 Subject: [PATCH 59/69] Added commented out board.STEMMA_I2C with explanation --- examples/as726x_simpletest.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/as726x_simpletest.py b/examples/as726x_simpletest.py index 78a0214..130ee53 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -22,7 +22,8 @@ def graph_map(x): # for I2C use: -i2c = board.I2C() +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS726x_I2C(i2c) # for UART use: From e689d788abbf358781a74ca05eff2d883e889248 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/69] 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 4290b5689593aef314459e4ada5a5c2b01fe3fe1 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/69] 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 37fd1ad388b4a15751c7d52a42fec341376fd75d Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 62/69] 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 8347514e10694b02ed9ca11fd24e3d504ceb6d48 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 22:02:40 -0400 Subject: [PATCH 63/69] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 346382a..ab5cf63 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.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 d6e3c1baf85e58946633dceedd8c8ce6055dae57 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:19:05 -0500 Subject: [PATCH 64/69] "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 ab5cf63..d0b358b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -102,19 +102,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 4acfeaa52be331f4c3a3057902a9c0b684f00954 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 65/69] 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 00b154e774f1c7c8857bc0604630220ea5d1010e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 66/69] 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 d0b358b..fcdb4f0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -105,7 +105,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 3d818ce84f4120d202ea0b4445e7ba69b061957d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 67/69] 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 565b528a1da7b68f8ed66963338365da307a3cb2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 18:49:29 +0000 Subject: [PATCH 68/69] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +--- .pylintrc | 399 ---------------------------------- README.rst | 6 +- adafruit_as726x.py | 35 +-- docs/api.rst | 3 + docs/conf.py | 8 +- examples/as726x_simpletest.py | 1 + ruff.toml | 105 +++++++++ 9 files changed, 147 insertions(+), 464 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 304dd15..1f6aee3 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AS726x/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 Driver for the AS726x spectral sensors diff --git a/adafruit_as726x.py b/adafruit_as726x.py index 17ad233..e57c4ee 100644 --- a/adafruit_as726x.py +++ b/adafruit_as726x.py @@ -26,16 +26,18 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ + import struct import time + from adafruit_bus_device.i2c_device import I2CDevice from micropython import const try: - from typing import Tuple, Optional + from typing import Optional, Tuple # This is only needed for typing - import busio # pylint: disable=unused-import + import busio except ImportError: pass @@ -112,12 +114,6 @@ _AS7262_RED_CALIBRATED, ) -# pylint: disable=too-many-instance-attributes -# pylint: disable=too-many-public-methods -# pylint: disable=invalid-name -# pylint: disable=no-else-return -# pylint: disable=inconsistent-return-statements - class AS726x: """AS726x spectral sensor base class.""" @@ -163,9 +159,7 @@ def __init__(self): # TODO: add support for other devices if version != 0x40: - raise ValueError( - "device could not be reached or this device is not supported!" - ) + raise ValueError("device could not be reached or this device is not supported!") self.integration_time = 140 self.conversion_mode = AS726x.MODE_2 @@ -591,23 +585,16 @@ def _virtual_write(self, addr: int, value: float) -> None: # otherwise proceed GAIN = (value >> 4) & 0x03 BANK = (value >> 2) & 0x03 - self._uart_xfer("ATGAIN={}".format(GAIN)) - self._uart_xfer("ATTCSMD={}".format(BANK)) + self._uart_xfer(f"ATGAIN={GAIN}") + self._uart_xfer(f"ATTCSMD={BANK}") elif addr == _AS726X_LED_CONTROL: ICL_DRV = (value >> 4) & 0x07 LED_DRV = 100 if value & 0x08 else 0 ICL_IND = (value >> 1) & 0x07 LED_IND = 100 if value & 0x01 else 0 - self._uart_xfer("ATLED0={}".format(LED_IND)) - self._uart_xfer("ATLED1={}".format(LED_DRV)) - self._uart_xfer("ATLEDC={}".format(ICL_DRV << 4 | ICL_IND)) + self._uart_xfer(f"ATLED0={LED_IND}") + self._uart_xfer(f"ATLED1={LED_DRV}") + self._uart_xfer(f"ATLEDC={ICL_DRV << 4 | ICL_IND}") elif addr == _AS726X_INT_T: value = int(value / 2.8) - self._uart_xfer("ATINTTIME={}".format(value)) - - -# pylint: enable=too-many-instance-attributes -# pylint: enable=too-many-public-methods -# pylint: enable=invalid-name -# pylint: enable=no-else-return -# pylint: enable=inconsistent-return-statements + self._uart_xfer(f"ATINTTIME={value}") diff --git a/docs/api.rst b/docs/api.rst index 38acd50..3c21aa3 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_as726x :members: diff --git a/docs/conf.py b/docs/conf.py index fcdb4f0..e26e262 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -50,9 +48,7 @@ creation_year = "2017" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Dean Miller" author = "Dean Miller" diff --git a/examples/as726x_simpletest.py b/examples/as726x_simpletest.py index 130ee53..3090bfe 100644 --- a/examples/as726x_simpletest.py +++ b/examples/as726x_simpletest.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import time + import board # for I2C use: diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# 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 +] + +[format] +line-ending = "lf" From f6813bc6c30f45911ca267f17c6a8dd8fc9abbdb Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 69/69] 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"