From dd841a49293dd6951fe1a14dc43581a3a48aec80 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Elio=20Petten=C3=B2?= Date: Fri, 15 May 2020 16:41:06 +0100 Subject: [PATCH 1/3] Update copyright in LICENSE to just reference Adafruit Industries. --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 7806e61..2a4bb4f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2019 Adafruit for Adafruit Industries +Copyright (c) 2019 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 From 6a9701b0ad7248e4298bf9ce703a5ed7af450e99 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Elio=20Petten=C3=B2?= Date: Fri, 15 May 2020 15:44:24 +0100 Subject: [PATCH 2/3] Apply SPDX copyright and license headers in compliance with REUSE. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The REUSE specifications[1] are meant to make it explicit and easier to apply code licensing information for a project. The provided lint tool makes it easy to ensure all the content (code and not code) is tagged. Important notes: * All the code (and documentation) that otherwise didn't have an explicit license headers have been tagged with Kattni Rembor's copyright as per the LICENSE file. * All configuration files have been tagged with Kattni Rembor's copyright and Unlicense[2]. The current REUSE recommendation is to use CC0-1.0, but that has… side effects. There's some discussion in [3] about the recommendation for likely-uncopyrightable files (such as configuration files). [1]: https://reuse.software/ [2]: https://unlicense.org/ [3]: https://github.com/fsfe/reuse-docs/issues/62 --- .github/PULL_REQUEST_TEMPLATE.md.license | 3 +++ .github/workflows/githubci.yml | 4 ++++ .gitignore | 4 ++++ LICENSES/MIT.txt | 19 +++++++++++++++++++ LICENSES/Unlicense.txt | 20 ++++++++++++++++++++ README.md | 6 ++++++ install.sh | 4 ++++ requirements.txt | 3 +++ 8 files changed, 63 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md.license create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt diff --git a/.github/PULL_REQUEST_TEMPLATE.md.license b/.github/PULL_REQUEST_TEMPLATE.md.license new file mode 100644 index 0000000..d458858 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2019 Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 0fa1503..5c76e28 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2019 Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Github CircuitPython Library CI on: [push] diff --git a/.gitignore b/.gitignore index cc1a9c8..f2ba1fd 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2019 Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ 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.md b/README.md index 6207977..5bd6fb1 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + + # Actions CI CircuitPython Init Script The purpose of this repo is to create a centrally managed dependency diff --git a/install.sh b/install.sh index a1bc237..a8db00d 100755 --- a/install.sh +++ b/install.sh @@ -1,5 +1,9 @@ #!/usr/bin/env bash +# SPDX-FileCopyrightText: 2019 Adafruit Industries +# +# SPDX-License-Identifier: MIT + # we need bash 4 for associative arrays if [ "${BASH_VERSION%%[^0-9]*}" -lt "4" ]; then echo "BASH VERSION < 4: ${BASH_VERSION}" >&2 diff --git a/requirements.txt b/requirements.txt index e69de29..ce983d3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2019 Adafruit Industries +# +# SPDX-License-Identifier: Unlicense From 8029bb4c57aca101346d0a59e0e09a4e9ec77b2c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Diego=20Elio=20Petten=C3=B2?= Date: Fri, 15 May 2020 16:44:14 +0100 Subject: [PATCH 3/3] Add pre-commit hooks for reuse and basic checkers. --- .github/workflows/githubci.yml | 2 +- .pre-commit-config.yaml | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 .pre-commit-config.yaml diff --git a/.github/workflows/githubci.yml b/.github/workflows/githubci.yml index 5c76e28..4b9fb4e 100644 --- a/.github/workflows/githubci.yml +++ b/.github/workflows/githubci.yml @@ -10,7 +10,7 @@ jobs: build: runs-on: ubuntu-latest - + steps: - uses: actions/checkout@v1 - uses: actions/setup-python@v1 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..8db253a --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- 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