[#114, #108] Apply some REUSE standards, move requirements, update headers (2024) (#123)

* doc(#114): project - update headers

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* doc(#114): project - move licences and update THIRD-PARTY

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* refactor(#108): Licenses Inventory - define requirements for Python modules

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

* refactor(#114): review - apply comments

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

---------

Signed-off-by: Pierre-Yves Lapersonne <pierreyves.lapersonne@orange.com>

Author: pylapp

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- [Licenses Inventory] Improve requirements for Python modules in use ([#108](https://github.com/Orange-OpenSource/floss-toolbox/issues/108))
+- [Project] Apply REUSE standards ([#114](https://github.com/Orange-OpenSource/floss-toolbox/issues/114))
 - [Utils] Add metrics and improve outputs for third-party generator scripts
 - [Project] Improve a bit CHANGELOG by leading scope keyword for each line
 

…sInventory/licenses/LICENSE-requests.txt LICENSES/Apache-2.0.txttoolbox/LicensesInventory/licenses/LICENSE-requests.txt renamed to LICENSES/Apache-2.0.txt toolbox/LicensesInventory/licenses/LICENSE-requests.txt renamed to LICENSES/Apache-2.0.txt

@@ -173,3 +173,30 @@
       defend, and hold each Contributor harmless for any liability
       incurred by, or claims asserted against, such Contributor by reason
       of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

…box/github/licenses/LICENSE-Ruby-Git.txt LICENSES/MIT.txttoolbox/github/licenses/LICENSE-Ruby-Git.txt renamed to LICENSES/MIT.txt toolbox/github/licenses/LICENSE-Ruby-Git.txt renamed to LICENSES/MIT.txt

@@ -1,6 +1,6 @@
-The MIT License
+MIT License
 
-Copyright (c) 2008 Scott Chacon
+Copyright (c) [year] [fullname]
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ 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 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.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

THIRD-PARTY.md

@@ -0,0 +1,65 @@
+
+# Third Party Softwares
+
+This document contains the list of Third Party Softwares along with the license information.
+
+Third Party Software may impose additional restrictions and it is the user's responsibility to ensure that they have met the licensing
+requirements of the relevant license of the Third Party Software they are using.
+
+## For "github" bucket
+
+### Octokit
+
+Version 6.1.1
+
+Copyright 2009-2017 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+
+*octokit.rb* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
+You may download the source code on the [following website](https://github.com/octokit/octokit.rb).
+
+### Ruby Git
+
+Version 1.18.0
+
+Copyright (c) 2008 Scott Chacon
+
+*Ruby Git* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
+You may download the source code on the [following website](https://github.com/ruby-git/ruby-git).
+
+## For "LicensesInventory" bucket
+
+### Beautiful Soup
+
+Version 4.10.0
+
+Copyright (c) Leonard Richardson
+
+*Beautiful Soup* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
+You may download the source code on the [following website](https://git.launchpad.net/beautifulsoup/).
+
+### pytest
+
+Version 7.2.1
+
+Copyright (c) 2004 Holger Krekel and others
+
+*pytest* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
+You may download the source code on the [following website](https://github.com/pytest-dev/pytest).
+
+### requests
+
+Version 2.28.1
+
+Copyright (c) 2019 Kenneth Reitz
+
+*requests* is distributed under the terms and conditions of the [Apache 2.0 License](https://opensource.org/license/apache-2-0).
+You may download the source code on the [following website](https://github.com/psf/requests).
+
+### xmltodict
+
+Version 0.13.0
+
+Copyright (c) 2012 Martin Blech and individual contributors.
+
+*xmltodict* is distributed under the terms and conditions of the [MIT License](https://opensource.org/license/MIT).
+You may download the source code on the [following website](https://github.com/martinblech/xmltodict).

toolbox/LicensesInventory/README.md

@@ -33,13 +33,10 @@ _Keywords: #licenses #SPM #Gradle #Maven #NPMJS #package #Cocoapods #pubspec #go
 ## Prerequisites
 
 - _Python_ version **3.7**
-- _Python_ modules like _requests_, _xmltodict_ and _pytest-6.2.5_
+- _Python_ modules like _requests_, _xmltodict_, _pytests_ and _beautiful soup_
 
 ```shell
-pip install requests
-pip install xmltodict
-pip install pytest
-pip install beautifulsoup4
+pip install -r requirements.txt
 ```
 
 This project expects to have the third-party elements above available and already added in your system.

toolbox/LicensesInventory/THIRD-PARTY.txt

@@ -1,15 +1,18 @@
 #!/bin/bash
 # Software Name: floss-toolbox
-# SPDX-FileCopyrightText: Copyright (c) 2020-2023 Orange
+# SPDX-FileCopyrightText: Copyright (c) Orange SA
 # SPDX-License-Identifier: Apache-2.0
 #
-# This software is distributed under the Apache 2.0 license.
+# This software is distributed under the Apache 2.0 license,
+# the text of which is available at https://opensource.org/license/apache-2-0
+# or see the "LICENSE.txt" file for more details.
 #
-# Author: Pierre-Yves LAPERSONNE <pierreyves(dot)lapersonne(at)orange(dot)com> et al.
+# Authors: See CONTRIBUTORS.txt
+# Software description: A toolbox of scripts to help work of forges admins and open source referents
 
 # Since...............: 10/03/2023
 # Description.........: Make a dry-run of the LicensesInventory module to check if everything is ready to use
-# Version.............: 2.2.0
+# Version.............: 2.3.0
 
 set -eu
 
@@ -130,6 +133,7 @@ CheckIfFileExists "./sources/search/search.py"
 CheckIfFileExists "./sources/__init__.py"
 CheckIfFileExists "./sources/main.py"
 CheckIfFileExists "./config.ini"
+CheckIfFileExists "./requirements.txt"
 
 echo -e "\nCheck integration test files..."
 
@@ -181,12 +185,6 @@ CheckIfFileExists "./tests/integrationtests/test_licenses.py"
 echo -e "\nCheck other files"
 
 CheckIfFileExists "./README.md"
-CheckIfFileExists "./THIRD-PARTY.txt"
-CheckIfDirectoryExists "./licenses"
-CheckIfFileExists "./licenses/LICENSE-beautifulsoup.txt"
-CheckIfFileExists "./licenses/LICENSE-pytest.txt"
-CheckIfFileExists "./licenses/LICENSE-requests.txt"
-CheckIfFileExists "./licenses/LICENSE-xmltodict.txt"
 
 # Runtimes and tools
 # ------------------