Updated with changes from pre-commit

Author: fourstix

README.rst

@@ -28,7 +28,7 @@ at `SparkFun Qwiic Relay <https://github.com/sparkfun/Qwiic_Relay>`_
     :alt: SparkFun Qwiic Single Relay (COM-15093)
 
 `SparkFun Qwiic Single Relay (COM-15093) <https://www.sparkfun.com/products/15093>`_
-  
+
 
 
 Dependencies
@@ -48,7 +48,7 @@ or individual libraries can be installed using
 Raspberry Pi Setup
 ------------------
 Adafruit has an excellent tutorial on `Installing CircuitPython Libraries on Raspberry Pi <https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi/>`_.
- 
+
 Quick Start Summary:
 --------------------
 * Start with the latest version of Raspbian with Wifi configured.
@@ -202,15 +202,12 @@ Then run the build:
 
 License Information
 -----------------------
-This product is **open source**! 
+This product is **open source**!
 
-Please review the LICENSE.md file for license information. 
+Please review the LICENSE.md file for license information.
 
-Please use, reuse, and modify these files as you see fit. 
+Please use, reuse, and modify these files as you see fit.
 
 Please maintain the attributions to SparkFun Electronics and Adafruit and release any derivative under the same license.
 
 Distributed as-is; no warranty is given.
-
-
-

docs/conf.py

@@ -28,8 +28,11 @@
 
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),"BusDevice": ("https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", None),
-    
+    "python": ("https://docs.python.org/3.4", None),
+    "BusDevice": (
+        "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
+        None,
+    ),
     "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
 }
 

docs/examples.rst

@@ -45,4 +45,3 @@ Examples
 .. literalinclude:: ../examples/example6_set_relay_status.py
     :caption: examples/example6_set_relay_status.py
     :linenos:
-

docs/index.rst

@@ -23,7 +23,7 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-    Sparkfun Qwiic Single Relay Hookup Guide <https://learn.sparkfun.com/tutorials/qwiic-single-relay-hookup-guide> 
+    Sparkfun Qwiic Single Relay Hookup Guide <https://learn.sparkfun.com/tutorials/qwiic-single-relay-hookup-guide>
 
 .. toctree::
     :caption: Related Products

examples/example1_basic_control.py

@@ -30,16 +30,16 @@
 # Create relay object
 relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c)
 
-print('Qwicc Relay Example 1 Basic Control')
+print("Qwicc Relay Example 1 Basic Control")
 
 # Check if connected
 if relay.connected:
-    print('Relay connected.')
+    print("Relay connected.")
 else:
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
-print('Type Ctrl-C to exit program.')
+print("Type Ctrl-C to exit program.")
 
 try:
     while True:

examples/example2_change_i2c_address.py

@@ -41,54 +41,53 @@
 if len(sys.argv) > 1:
     try:
         # check to see if hex or decimal arguement
-        if '0x' in sys.argv[1]:
+        if "0x" in sys.argv[1]:
             i2c_address = int(sys.argv[1], 16)
         else:
             i2c_address = int(sys.argv[1])
     except ValueError:
-        print('Ignoring invalid arguement: ' + str(sys.argv[1]))
+        print("Ignoring invalid arguement: " + str(sys.argv[1]))
 
 # Show the initial address
-print('Current i2c address = ' + str(i2c_address)
-      + ' [' + hex(i2c_address) + ']')
+print("Current i2c address = " + str(i2c_address) + " [" + hex(i2c_address) + "]")
 
 # Create busio object using our Board I2C port
 i2c = board.I2C()
 relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c, i2c_address)
 
 if relay.connected:
-    print('Qwiic Relay Example.')
+    print("Qwiic Relay Example.")
 else:
     # if we can't connecct, something is wrong so just quit
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
-print('Address: ' + str(i2c_address) + ' [' + hex(i2c_address) + ']')
+print("Address: " + str(i2c_address) + " [" + hex(i2c_address) + "]")
 
-text = input('Enter a new I2C address (as a decimal from 8 to 119 or hex 0x08 to 0x77):')
+text = input(
+    "Enter a new I2C address (as a decimal from 8 to 119 or hex 0x08 to 0x77):"
+)
 
 # check to see if hex or decimal value
-if '0x' in text:
+if "0x" in text:
     new_address = int(text, 16)
 else:
     new_address = int(text)
 
-print('Changing address to ' + str(new_address)
-      + ' [' + hex(new_address) + ']')
+print("Changing address to " + str(new_address) + " [" + hex(new_address) + "]")
 
 result = relay.set_i2c_address(new_address)
 
 if result:
-    print('Address changed to ' + str(new_address)
-          + ' [' + hex(new_address) + ']')
+    print("Address changed to " + str(new_address) + " [" + hex(new_address) + "]")
     # After the change check the new connection and show firmware version
     if relay.connected:
-        print('Connected to Relay after address change.')
+        print("Connected to Relay after address change.")
     else:
-        print('Error after address change. Cannot connect to Relay.')
+        print("Error after address change. Cannot connect to Relay.")
 
 else:
-    print('Address change failed.')
+    print("Address change failed.")
 
 # good advice whether the address changed worked or not
-print('Run example3_i2c_scanner.py to verify the Qwiic Relay address.')
+print("Run example3_i2c_scanner.py to verify the Qwiic Relay address.")

examples/example3_i2c_scanner.py

@@ -35,14 +35,15 @@
 # Since i2c.scan() returns all addresses above the relay address,
 # we look for the relay address using only write requests.
 
+
 def test_i2c_write(addr):
-    "Write to an address to see if there's an device there"""
+    "Write to an address to see if there's an device there" ""
     while not i2c.try_lock():
         pass
 
     try:
         # Make an empty write request to an address
-        i2c.writeto(addr, b'')
+        i2c.writeto(addr, b"")
         return True
 
     except OSError:
@@ -53,7 +54,7 @@ def test_i2c_write(addr):
         i2c.unlock()
 
 
-print('Press Ctrl-C to exit program')
+print("Press Ctrl-C to exit program")
 
 try:
     while True:
@@ -65,10 +66,12 @@ def test_i2c_write(addr):
                 found.append(address)
 
         if found:
-            print('I2C addresses found:',
-                  [hex(device_address) for device_address in found])
+            print(
+                "I2C addresses found:",
+                [hex(device_address) for device_address in found],
+            )
         else:
-            print('No I2C device found.')
+            print("No I2C device found.")
 
         # wait a bit and scan again
         sleep(5)

examples/example4_get_relay_status.py

@@ -32,24 +32,24 @@
 # Create relay object
 relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c)
 
-print('Qwiic Relay Example 4 Get Relay Status')
+print("Qwiic Relay Example 4 Get Relay Status")
 
 # Check if connected
 if relay.connected:
-    print('Relay connected.')
+    print("Relay connected.")
 else:
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
-print('Type Ctrl-C to exit program.')
+print("Type Ctrl-C to exit program.")
 
 try:
     while True:
         relay.relay_on()
-        print('The relay status is ', relay.status)
+        print("The relay status is ", relay.status)
         sleep(2)
         relay.relay_off()
-        print('The relay status is ', relay.status)
+        print("The relay status is ", relay.status)
         sleep(2)
 
 except KeyboardInterrupt:

examples/example5_get_firmware_version.py

@@ -33,20 +33,20 @@
 # Create relay object
 relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c)
 
-print('Qwicc Relay Example 5 Get Firmware Version')
+print("Qwicc Relay Example 5 Get Firmware Version")
 
 # Check if connected
 if relay.connected:
-    print('Relay connected.')
+    print("Relay connected.")
 else:
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
-print('Type Ctrl-C to exit program.')
+print("Type Ctrl-C to exit program.")
 
 try:
     while True:
-        print('Firmware version: ' + relay.version)
+        print("Firmware version: " + relay.version)
         sleep(2)
 
 except KeyboardInterrupt:

examples/example6_set_relay_status.py

@@ -30,27 +30,27 @@
 # Create relay object
 relay = sparkfun_qwiicrelay.Sparkfun_QwiicRelay(i2c)
 
-print('Qwiic Relay Example 6 Set Relay Status')
+print("Qwiic Relay Example 6 Set Relay Status")
 
 # Check if connected
 if relay.connected:
-    print('Relay connected.')
+    print("Relay connected.")
 else:
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
-print('Type Ctrl-C to exit program.')
+print("Type Ctrl-C to exit program.")
 
 try:
     while True:
         # Set status = 1/True is the same as relay.relay_on()
         relay.status = True
-        print('The relay status is', bool(relay.status))
+        print("The relay status is", bool(relay.status))
         sleep(2)
 
         # Set status = 0/False is the same as relay.relay_off()
         relay.status = False
-        print('The relay status is', bool(relay.status))
+        print("The relay status is", bool(relay.status))
         sleep(2)
 
 except KeyboardInterrupt:

examples/qwiicrelay_simpletest.py

@@ -29,21 +29,21 @@
 
 # Check if connected
 if relay.connected:
-    print('Relay connected.')
+    print("Relay connected.")
 else:
-    print('Relay does not appear to be connected. Please check wiring.')
+    print("Relay does not appear to be connected. Please check wiring.")
     sys.exit()
 
 # Print firmware version and current status
-print('Firmware version ' + relay.version)
-print('Relay status ', relay.status)
+print("Firmware version " + relay.version)
+print("Relay status ", relay.status)
 
 # Turn the relay on and off
-print('Press Ctrl-C to exit program')
+print("Press Ctrl-C to exit program")
 while True:
     relay.relay_on()
-    print('Relay status ', relay.status)
+    print("Relay status ", relay.status)
     sleep(2)
     relay.relay_off()
-    print('Relay status ', relay.status)
+    print("Relay status ", relay.status)
     sleep(2)

setup.py

@@ -58,7 +58,6 @@
     ],
     # What does your project relate to?
     keywords="adafruit blinka circuitpython micropython qwiicrelay sparkfun qwiic relay",
-
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
     # IF LIBRARY FILES ARE A PACKAGE FOLDER,