Ran pre-commit, added licenses

.gitignore

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 *.mpy
 .idea
 __pycache__
@@ -8,4 +12,4 @@ bundles
 *.DS_Store
 .eggs
 dist
-**/*.egg-info
+**/*.egg-info

.pylintrc

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 [MASTER]
 
 # A comma-separated list of package or module names from where C extensions may

.readthedocs.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 python:
     version: 3
 requirements_file: requirements.txt

CODE_OF_CONDUCT.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
+SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries
+SPDX-License-Identifier: CC-BY-4.0
+-->
+
 # Adafruit Community Code of Conduct
 
 ## Our Pledge
@@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include:
 
 The goal of the standards and moderation guidelines outlined here is to build
 and maintain a respectful community. We ask that you don’t just aim to be
-"technically unimpeachable", but rather try to be your best self. 
+"technically unimpeachable", but rather try to be your best self.
 
 We value many things beyond technical expertise, including collaboration and
 supporting others within our community. Providing a positive experience for
@@ -74,9 +80,9 @@ You may report in the following ways:
 In any situation, you may send an email to <[email protected]>.
 
 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.

LICENSES/MIT.txt

@@ -0,0 +1,19 @@
+MIT License Copyright (c) <year> <copyright holders>
+
+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.

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 <https://unlicense.org/>

README.rst.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+
+SPDX-License-Identifier: MIT

adafruit_fram.py

@@ -1,24 +1,7 @@
-# The MIT License (MIT)
+# SPDX-FileCopyrightText: 2018 Michael Schroeder for Adafruit Industries
 #
-# Copyright (c) 2018 Michael Schroeder
-#
-# 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_fram`
 ====================================================
@@ -88,9 +71,9 @@ def __init__(self, max_size, write_protect=False, wp_pin=None):
 
     @property
     def write_wraparound(self):
-        """ Determines if sequential writes will wrapaound highest memory address
-            (``len(FRAM) - 1``) address. If ``False``, and a requested write will
-            extend beyond the maximum size, an exception is raised.
+        """Determines if sequential writes will wrapaound highest memory address
+        (``len(FRAM) - 1``) address. If ``False``, and a requested write will
+        extend beyond the maximum size, an exception is raised.
         """
         return self._wraparound
 
@@ -102,44 +85,44 @@ def write_wraparound(self, value):
 
     @property
     def write_protected(self):
-        """ The status of write protection. Default value on initialization is
-            ``False``.
+        """The status of write protection. Default value on initialization is
+        ``False``.
 
-            When a ``WP`` pin is supplied during initialization, or using
-            ``write_protect_pin``, the status is tied to that pin and enables
-            hardware-level protection.
+        When a ``WP`` pin is supplied during initialization, or using
+        ``write_protect_pin``, the status is tied to that pin and enables
+        hardware-level protection.
 
-            When no ``WP`` pin is supplied, protection is only at the software
-            level in this library.
+        When no ``WP`` pin is supplied, protection is only at the software
+        level in this library.
         """
         return self._wp if self._wp_pin is None else self._wp_pin.value
 
     def __len__(self):
-        """ The size of the current FRAM chip. This is one more than the highest
-            address location that can be read or written to.
+        """The size of the current FRAM chip. This is one more than the highest
+        address location that can be read or written to.
 
-            .. code-block:: python
+        .. code-block:: python
 
-                fram = adafruit_fram.FRAM_xxx() # xxx = 'I2C' or 'SPI'
+            fram = adafruit_fram.FRAM_xxx() # xxx = 'I2C' or 'SPI'
 
-                # size returned by len()
-                len(fram)
+            # size returned by len()
+            len(fram)
 
-                # can be used with range
-                for i in range(0, len(fram))
+            # can be used with range
+            for i in range(0, len(fram))
         """
         return self._max_size
 
     def __getitem__(self, address):
-        """ Read the value at the given index, or values in a slice.
+        """Read the value at the given index, or values in a slice.
 
-            .. code-block:: python
+        .. code-block:: python
 
-                # read single index
-                fram[0]
+            # read single index
+            fram[0]
 
-                # read values 0 thru 9 with a slice
-                fram[0:9]
+            # read values 0 thru 9 with a slice
+            fram[0:9]
         """
         if isinstance(address, int):
             if not 0 <= address < self._max_size:
@@ -172,15 +155,15 @@ def __getitem__(self, address):
         return read_buffer
 
     def __setitem__(self, address, value):
-        """ Write the value at the given starting index.
+        """Write the value at the given starting index.
 
-            .. code-block:: python
+        .. code-block:: python
 
-                # write single index
-                fram[0] = 1
+            # write single index
+            fram[0] = 1
 
-                # write values 0 thru 4 with a list
-                fram[0] = [0,1,2,3]
+            # write values 0 thru 4 with a list
+            fram[0] = [0,1,2,3]
         """
         if self.write_protected:
             raise RuntimeError("FRAM currently write protected.")
@@ -212,7 +195,7 @@ def _write(self, start_address, data, wraparound):
 
 
 class FRAM_I2C(FRAM):
-    """ I2C class for FRAM.
+    """I2C class for FRAM.
 
     :param: ~busio.I2C i2c_bus: The I2C bus the FRAM is connected to.
     :param: int address: I2C address of FRAM. Default address is ``0x50``.
@@ -291,7 +274,7 @@ def write_protected(self, value):
 
 
 class FRAM_SPI(FRAM):
-    """ SPI class for FRAM.
+    """SPI class for FRAM.
 
     :param: ~busio.SPI spi_bus: The SPI bus the FRAM is connected to.
     :param: ~digitalio.DigitalInOut spi_cs: The SPI CS pin.

docs/_static/favicon.ico.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
+
+SPDX-License-Identifier: CC-BY-4.0

docs/api.rst.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

docs/conf.py

@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 import os
 import sys
 

docs/examples.rst.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

docs/index.rst.license

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT

examples/fram_i2c_simpletest.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
 ## Simple Example For CircuitPython/Python I2C FRAM Library
 
 import board

examples/fram_spi_simpletest.py

@@ -1,3 +1,6 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+# SPDX-License-Identifier: MIT
+
 ## Simple Example For CircuitPython/Python SPI FRAM Library
 
 import board

requirements.txt

@@ -1,2 +1,6 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
 Adafruit-Blinka
 adafruit-circuitpython-busdevice

setup.py

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 """A setuptools based setup module.
 
 See: