Cleaned up lint. Updated README with instructions.

Author: ShawnHymel

README.rst

@@ -59,18 +59,18 @@ Connect the components as shown to your board. Note that you can use a 220 Ohm o
 .. image:: https://github.com/adafruit/Adafruit_CircuitPython_BoardTest/blob/master/docs/test_jig.png
     :alt: Test jig Fritzing diagram
 
-To use each test, import the library, find the pins available on your board, and call ``boardtest_<test name>.run_test(pins)``. To run the GPIO test, for example:
+To use each test, copy the individual .py or .mpy test(s) into a folder named adafruit_boardtest in the CIRCUITPY drive, import the library, find the pins available on your board, and call ``boardtest_<test name>.run_test(pins)``. To run the GPIO test, for example:
 
 .. code:: python
 
     import board
-    import boardtest_gpio
+    from adafruit_boardtest import boardtest_gpio
 
     # List out all the pins available to us
     pins = [p for p in dir(board)]
     print()
     print("All pins found:", end=' ')
-    
+
     # Print pins
     for p in pins:
         print(p, end=' ')

adafruit_boardtest/boardtest_gpio.py

@@ -25,7 +25,7 @@
 Toggles all available GPIO on a board. Verify their operation with an LED,
 multimeter, another microcontroller, etc.
 
-Run this script as its own main.py to individually run the test, or compile 
+Run this script as its own main.py to individually run the test, or compile
 with mpy-cross and call from separate test script.
 
 * Author(s): Shawn Hymel for Adafruit Industries
@@ -40,10 +40,11 @@
 
 """
 
+import time
+
 import board
 import digitalio
 import supervisor
-import time
 
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BoardTest.git"
@@ -59,9 +60,9 @@
 NA = "N/A"
 
 # Determine if given value is a number
-def _is_number(s):
+def _is_number(val):
     try:
-        float(s)
+        float(val)
         return True
     except ValueError:
         return False
@@ -73,9 +74,7 @@ def _deinit_pins(gpios):
 
 # Toggle IO pins while waiting for answer
 def _toggle_wait(gpios):
-    
-    global test_results
-    
+
     timestamp = time.monotonic()
     led_state = False
     print("Are the pins listed above toggling? [y/n]")
@@ -92,21 +91,17 @@ def _toggle_wait(gpios):
             gpio.value = led_state
         if supervisor.runtime.serial_bytes_available:
             answer = input()
-            if answer == 'y':
-                return True
-            else:
-                return False
-                break
+            return bool(answer == 'y')
 
 def run_test(pins):
 
     """
     Toggles all available GPIO on and off repeatedly.
-    
+
     :param list[str] pins: list of pins to run the test on
     :return: tuple(str, list[str]): test result followed by list of pins tested
     """
-    
+
     # Create a list of analog GPIO pins
     analog_pins = [p for p in pins if p[0] == 'A' and _is_number(p[1])]
 
@@ -116,14 +111,14 @@ def run_test(pins):
     # Toggle LEDs if we find any
     gpio_pins = analog_pins + digital_pins
     if gpio_pins:
-        
+
         # Create a list of IO objects for us to toggle
         gpios = [digitalio.DigitalInOut(getattr(board, p)) for p in gpio_pins]
 
         # Print out the LEDs found
         print("GPIO pins found:", end=' ')
-        for p in gpio_pins:
-            print(p, end=' ')
+        for pin in gpio_pins:
+            print(pin, end=' ')
         print('\n')
 
         # Set all IO to output
@@ -132,29 +127,29 @@ def run_test(pins):
 
         # Toggle pins while waiting for user to verify LEDs blinking
         result = _toggle_wait(gpios)
-        
+
         # Release pins
         _deinit_pins(gpios)
-        
+
         if result:
             return PASS, gpio_pins
-        else:
-            return FAIL, gpio_pins
-    
-    else:
-        print("No GPIO pins found")
-        return NA, []
+
+        return FAIL, gpio_pins
+
+    # Else (no pins found)
+    print("No GPIO pins found")
+    return NA, []
 
 def _main():
-    
+
     # List out all the pins available to us
     pins = [p for p in dir(board)]
     print()
     print("All pins found:", end=' ')
-    
+
     # Print pins
-    for p in pins:
-        print(p, end=' ')
+    for pin in pins:
+        print(pin, end=' ')
     print('\n')
 
     # Run test

adafruit_boardtest/boardtest_i2c.py

@@ -24,7 +24,7 @@
 ====================================================
 Performs random writes and reads to I2C EEPROM.
 
-Run this script as its own main.py to individually run the test, or compile 
+Run this script as its own main.py to individually run the test, or compile
 with mpy-cross and call from separate test script.
 
 * Author(s): Shawn Hymel for Adafruit Industries
@@ -34,7 +34,8 @@
 
 **Hardware:**
 
-* `Microchip AT24HC04B I2C EEPROM <https://www.digikey.com/product-detail/en/microchip-technology/AT24HC04B-PU/AT24HC04B-PU-ND/1886137>`_
+* `Microchip AT24HC04B I2C EEPROM <https://www.digikey.com/product-detail/en/\
+microchip-technology/AT24HC04B-PU/AT24HC04B-PU-ND/1886137>`_
 
 **Software and Dependencies:**
 
@@ -43,11 +44,12 @@
 
 """
 
-import board
-import busio
 import random
 import time
 
+import board
+import busio
+
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BoardTest.git"
 
@@ -66,60 +68,60 @@
 NA = "N/A"
 
 # Open comms to I2C EEPROM by trying a write to memory address
-def _eeprom_i2c_wait(i2c, i2c_addr, mem_addr, timeout = 1.0):
-    
+def _eeprom_i2c_wait(i2c, i2c_addr, mem_addr, timeout=1.0):
+
     # Try to access the I2C EEPROM (it becomes unresonsive during a write)
     timestamp = time.monotonic()
     while time.monotonic() < timestamp + timeout:
         try:
             i2c.writeto(i2c_addr, bytearray([mem_addr]), end=1, stop=False)
             return True
-        except:
+        except OSError:
             pass
-            
+
     return False
 
 # Write to address. Returns status (True for successful write, False otherwise)
-def _eeprom_i2c_write_byte(i2c, i2c_addr, mem_addr, mem_data, timeout = 1.0):
-    
+def _eeprom_i2c_write_byte(i2c, i2c_addr, mem_addr, mem_data):
+
     # Make sure address is only one byte:
     if mem_addr > 255:
         return False
-        
+
     # Make sure data is only one byte:
     if mem_data > 255:
         return False
-        
+
     # Write data to memory at given address
     try:
         i2c.writeto(i2c_addr, bytearray([mem_addr, mem_data]))
-    except:
+    except OSError:
         return False
-    
+
     return True
 
 # Read from address. Returns tuple [status, result]
-def _eeprom_i2c_read_byte(i2c, i2c_addr, mem_addr, timeout = 1.0):
-    
+def _eeprom_i2c_read_byte(i2c, i2c_addr, mem_addr, timeout=1.0):
+
     # Make sure address is only one byte:
     if mem_addr > 255:
         return False, bytearray()
-   
+
     # Try writing to address (EEPROM is unresponsive while writing)
-    if _eeprom_i2c_wait(i2c, i2c_addr, mem_addr, timeout) == False:
+    if not _eeprom_i2c_wait(i2c, i2c_addr, mem_addr, timeout):
         return False, bytearray()
-     
+
     # Finish the read
     buf = bytearray(1)
     i2c.readfrom_into(i2c_addr, buf)
-    
+
     return True, buf
 
 def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
-    
+
     """
     Performs random writes and reads to I2C EEPROM.
-    
+
     :param list[str] pins: list of pins to run the test on
     :param str sda_pin: pin name of I2C SDA
     :param str scl_pin: pin name of I2C SCL
@@ -131,7 +133,7 @@ def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
 
         # Tell user to connect EEPROM chip
         print("Connect a Microchip AT24HC04B EEPROM I2C chip. " +
-            "Press enter to continue.")
+              "Press enter to continue.")
         input()
 
         # Set up I2C
@@ -143,7 +145,7 @@ def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
 
         # Pick a random address, write to it, read from it, and see if they match
         pass_test = True
-        for i in range(NUM_I2C_TESTS):
+        for _ in range(NUM_I2C_TESTS):
 
             # Randomly pick an address and a data value (one byte)
             mem_addr = random.randint(0, EEPROM_I2C_MAX_ADDR)
@@ -153,7 +155,7 @@ def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
 
             # Try writing this random value to the random address
             result = _eeprom_i2c_write_byte(i2c, EEPROM_I2C_ADDR, mem_addr, mem_data)
-            if result == False:
+            if not result:
                 print("FAIL: I2C could not communicate")
                 pass_test = False
                 break
@@ -162,7 +164,7 @@ def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
             result = _eeprom_i2c_read_byte(i2c, EEPROM_I2C_ADDR, mem_addr)
             print("Read:\t\t" + hex(result[1][0]))
             print()
-            if result[0] == False:
+            if not result[0]:
                 print("FAIL: I2C could not communicate")
                 pass_test = False
                 break
@@ -179,23 +181,23 @@ def run_test(pins, sda_pin=SDA_PIN_NAME, scl_pin=SCL_PIN_NAME):
         # Store results
         if pass_test:
             return PASS, [sda_pin, scl_pin]
-        else:
-            return FAIL, [sda_pin, scl_pin]
-    
-    else:
-        print("No I2C pins found")
-        return NA, []
+
+        return FAIL, [sda_pin, scl_pin]
+
+    # Else (no pins found)
+    print("No I2C pins found")
+    return NA, []
 
 def _main():
-    
+
     # List out all the pins available to us
     pins = [p for p in dir(board)]
     print()
     print("All pins found:", end=' ')
-    
+
     # Print pins
-    for p in pins:
-        print(p, end=' ')
+    for pin in pins:
+        print(pin, end=' ')
     print('\n')
 
     # Run test