Add fosslight_oss_pkg to fosslight_reuse

Author: soimkim

.reuse/dep5

@@ -10,10 +10,14 @@ Files: .github/*
 Copyright: 2021 LG Electronics
 License: Apache-2.0
 
+Files: tests/*
+Copyright: 2021 LG Electronics
+License: Apache-2.0
+
 Files: MANIFEST.in
 Copyright: 2021 LG Electronics
 License: Apache-2.0
 
 Files: requirements*.txt
 Copyright: 2021 LG Electronics
-License: Apache-2.0
+License: Apache-2.0

README.md

@@ -4,106 +4,28 @@ SPDX-License-Identifier: Apache-2.0
  -->
 # FOSSLight REUSE
 
-**FOSSLight REUSE** uses [reuse-tool][ret] to check whether the source code's copyright and license writing rules are complied with.
+**FOSSLight REUSE** is a tool that can be used to comply with the copyright/license writing rules in the source code.     
+It uses [reuse-tool][ret] to check whether the source code's copyright and license writing rules are complied with.
 
 [ret]: https://github.com/fsfe/reuse-tool
 
-## 🎉 How to install
 
-It can be installed using pip3.     
-It is recommended to install it in the [python 3.6 + virtualenv](https://github.com/fosslight/fosslight_source/blob/main/docs/Guide_virtualenv.md) environment.
+## 📖 User Guide
+Please see the [**User Guide**](https://github.com/fosslight/fosslight_reuse/blob/main/docs/user-guide.md) for more information on how to install and run it.    
+Here a short summary:    
 
-```
-$ pip3 install fosslight_reuse
-```
+- `lint` --- Check whether the source code's copyright and license writing rules are complied with.
 
-## 🚀 How to run
-``` 
-$ fosslight_reuse 
-```
-### Parameters      
-| Parameter  | Argument | Required  | Description |
-| ------------- | ------------- | ------------- |------------- |
-| p | [root_path_to_check] | O | Source path to check. | 
-| h | None | X | Print help message. | 
-| n | None | X | Add this parameter if you do not want to exclude venv*, node_modules, and .*/ from the analysis.|    
-| r | [result_file_name] | X | xml format result file name. (Default: reuse_checker.xml) |    
-| f | [file1,file2,...] | X | List of files to check copyright and license. |
+- `report` --- Convert oss-pkg-info.yaml to FOSSLight-Report.xlsx and vice versa.
 
-### Ex 1. Run with minimal parameters 
-``` 
-$ fosslight_reuse -p [root_path_to_check]
-```
-### Ex 2. Check for specific files
-Copyright text and License text are printed for /home/test/notice/sample.py, /home/test/src/init.py.
-```
-$ fosslight_reuse -p /home/test/ -f "notice/sample.py,src/init.py"
-```
-## How it works
-1. Check if it exists in the directory received by parameter -p.
-2. Find a OSS Package Information file.
-3. Run a Reuse lint.    
-    3-1. When running on a project basis. (without -f parameter)
-    - If there is no ./reuse/dep5 file in the Root Path, it is created.
-    - If it already exists, copy it to bk file and append the default config value to the existing dep file.
-    - By creating dep5 files, exclude binary or .json, venv */*, node_modules/*,. */* from reuse.
-    - Run the reuse lint 
-        If the OSS Package Information file exists, the list of missing license files is not printed.
-    - Rollback dep5-related file creation part.    
-    
-    3-2. When executing in file unit (with -f option)
-    - Print the copyright text and license text extraction by file.
-    - However, if the file does not exist or the file is binary or .json, copyright text and license text are not printed.
-
-4. Print the execution result and save it in xml format.
-
-## 📁 Result
-### Ex 1. Analyze the files in path.
-```
-(venv)$ fosslight_reuse -p /home/test/reuse-example -r result.xml
-```
-```
-# SUMMARY
-# Open Source Package info: File to which OSS Package information is written.
-# Used licenses: License detected in the path.
-# Files with copyright information: Number of files with copyright / Total number of files.
-# Files with license information: Number of files with license / Total number of files.
- 
-* Open Source Package info: /home/test/reuse-example/oss-package.info
-* Used licenses: CC-BY-4.0, CC0-1.0, GPL-3.0-or-later
-* Files with copyright information: 6 / 7
-* Files with license information: 6 / 7
-
-```
-
-### Ex 2. Analyze specific files. 
-The detected License and Copyright information for each file is output.
-```
-(venv)$ fosslight_reuse  -p /home/soimkim/test/reuse-example -f "src/load.c,src/dummy.c,src/main.c"
-```
-```
-# src/load.c
-* License:
-* Copyright: SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]>
- 
-# src/dummy.c
-* License:
-* Copyright:
- 
-# src/main.c
-* License: GPL-3.0-or-later
-* Copyright: SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]>
-
-```
 
 ## 👏 How to report issue
 
 Please report any ideas or bugs to improve by creating an issue in [Git Repository][repo]. Then there will be quick bug fixes and upgrades. Ideas to improve are always welcome.
 
 [repo]: https://github.com/fosslight/fosslight_reuse/issues
 
-## 📄 License
-Copyright (c) 2020 LG Electronics, Inc.     
-FOSSLight REUSE is Apache-2.0, as found in the [LICENSE][l] file.
+## 📄 License  
+FOSSLight REUSE is licensed under [Apache-2.0][l].
 
 [l]: https://github.com/fosslight/fosslight_reuse/blob/main/LICENSE

docs/user-guide.md

@@ -0,0 +1,136 @@
+<!--
+Copyright (c) 2021 LG Electronics
+SPDX-License-Identifier: Apache-2.0
+ -->
+# FOSSLight REUSE
+**FOSSLight REUSE** is a tool that can be used to comply with the copyright/license writing rules in the source code.    
+It uses [reuse-tool][ret] to check whether the source code's copyright and license writing rules are complied with.
+
+[ret]: https://github.com/fsfe/reuse-tool
+
+##  Functions
+1. `lint` --- Check whether the source code's copyright and license writing rules are complied with.    
+2. `report` --- Convert oss-pkg-info.yaml to FOSSLight-Report.xlsx and vice versa.
+     - It converts oss-pkg-info.yaml to SRC Sheet of FOSSLight Report or    
+     - BIN (Android) and BOM Sheet of OSS Report to oss-pkg-info.yaml.
+
+## 🎉 How to install
+
+It can be installed using pip3.     
+It is recommended to install it in the [python 3.6 + virtualenv](https://fosslight.org/fosslight-guide-en/scanner/etc/guide_virtualenv.html) environment.
+
+```
+$ pip3 install fosslight_reuse
+```
+
+## 🚀 How to run - lint (Check copyright and license writing rules)
+``` 
+$ fosslight_reuse lint
+```
+### Parameters      
+| Parameter  | Argument | Required  | Description |
+| ------------- | ------------- | ------------- |------------- |
+| p | [root_path_to_check] | O | Source path to check. | 
+| h | None | X | Print help message. | 
+| n | None | X | Add this parameter if you do not want to exclude venv*, node_modules, and .*/ from the analysis.|    
+| o | [result_file_name] | X | xml format result file name. (Default: reuse_checker.xml) |    
+| f | [file1,file2,...] | X | List of files to check copyright and license. |
+
+### Ex 1. Run with minimal parameters 
+``` 
+$ fosslight_reuse lint -p [root_path_to_check]
+```
+### Ex 2. Check for specific files
+Copyright text and License text are printed for /home/test/notice/sample.py, /home/test/src/init.py.
+```
+$ fosslight_reuse lint -p /home/test/ -f "notice/sample.py,src/init.py"
+```
+## How it works
+1. Check if it exists in the directory received by parameter -p.
+2. Find a OSS Package Information file.
+3. Run a Reuse lint.    
+    3-1. When running on a project basis. (without -f parameter)
+    - If there is no ./reuse/dep5 file in the Root Path, it is created.
+    - If it already exists, copy it to bk file and append the default config value to the existing dep file.
+    - By creating dep5 files, exclude binary or .json, venv */*, node_modules/*,. */* from reuse.
+    - Run the reuse lint 
+        If the OSS Package Information file exists, the list of missing license files is not printed.
+    - Rollback dep5-related file creation part.    
+    
+    3-2. When executing in file unit (with -f option)
+    - Print the copyright text and license text extraction by file.
+    - However, if the file does not exist or the file is binary or .json, copyright text and license text are not printed.
+
+4. Print the execution result and save it in xml format.
+
+## 📁 Result
+### Ex 1. Analyze the files in path.
+```
+(venv)$ fosslight_reuse lint -p /home/test/reuse-example -r result.xml
+```
+```
+# SUMMARY
+# Open Source Package info: File to which OSS Package information is written.
+# Used licenses: License detected in the path.
+# Files with copyright information: Number of files with copyright / Total number of files.
+# Files with license information: Number of files with license / Total number of files.
+ 
+* Open Source Package info: /home/test/reuse-example/oss-package.info
+* Used licenses: CC-BY-4.0, CC0-1.0, GPL-3.0-or-later
+* Files with copyright information: 6 / 7
+* Files with license information: 6 / 7
+
+```
+
+### Ex 2. Analyze specific files. 
+The detected License and Copyright information for each file is output.
+```
+(venv)$ fosslight_reuse lint -p /home/soimkim/test/reuse-example -f "src/load.c,src/dummy.c,src/main.c"
+```
+```
+# src/load.c
+* License:
+* Copyright: SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]>
+ 
+# src/dummy.c
+* License:
+* Copyright:
+ 
+# src/main.c
+* License: GPL-3.0-or-later
+* Copyright: SPDX-FileCopyrightText: 2019 Jane Doe <[email protected]>
+
+```
+
+## 🚀 How to run - report (Convert oss-pkg-info.yaml <-> FOSSLight-Report.xlsx)
+``` 
+$ fosslight_reuse report
+```
+### Parameters      
+| Parameter  | Argument | Required  | Description |
+| ------------- | ------------- | ------------- |------------- |
+| p | [path_to_check] | O | Convert all oss-pkg-info*.yaml or oss-pkg-info*.yml in the path recursively | 
+| h | None | X | Print help message. | 
+| o | [result_file_name] | X | Output file name |    
+| f | [file1,file2,...] | X | 1. Yaml files are converted as OSS Report (separated by, if multiple) <br> ex) -f src/oss-pkg-info.yaml,main/setting.yml 2. OSS Report file to be converted to oss-pkg-info.yaml. |
+
+### Ex 1. Convert oss-pkg-info.yaml file to OSS Report.
+1-1. Convert all oss-pkg-info*.yaml or oss-pkg-info*.yml in the path recursively.
+``` 
+$ fosslight_reuse report -p /home/test/source
+```
+
+1-2. Covert the specific oss-pkg-info.yaml files.
+``` 
+$ fosslight_reuse report -f src/oss-pkg-info.yaml,main/setting.yml
+```
+
+### Ex 2. Convert OSS Report to oss-pkg-info.yaml file.
+```
+$ fosslight_reuse report -f src/OSS-Report.xlsx
+```
+
+## 📁 Result
+If an output file name is specified with -o, a result file is created with that name.
+- FOSSLight-Report_[datetime].xlsx : When the oss-pkg-info.yaml file is converted to OSS-Report.xlsx
+- oss-pkg-info_[datetime].yaml : FOSSLight-Report.xlsx is converted to oss-pkg-info.yaml.

requirements.txt

@@ -2,4 +2,6 @@ binaryornot
 requests
 reuse
 PyYAML
+xlrd==1.2.0
+XlsxWriter==1.2.9
 fosslight_util

setup.py

@@ -14,23 +14,28 @@
 if __name__ == "__main__":
     setup(
         name='fosslight_reuse',
-        version='1.0.1',
+        version='2.0.0',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
-        description='Wrapper of reuse lint.',
+        description='FOSSLight Reuse',
         long_description=readme,
         long_description_content_type='text/markdown',
-        license='LGE-Proprietary',
-        author='Soim Kim',
-        author_email='[email protected]',
-        url='http://mod.lge.com/code/projects/OSC/repos/fosslight_reuse',
-        download_url='http://mod.lge.com/code/rest/archive/latest/projects/OSC/repos/fosslight_reuse/archive?format=zip',
-        classifiers=['Programming Language :: Python :: 3.6',
-                     'License :: OSI Approved :: Closed Sorce Software'],
+        license='Apache-2.0',
+        author='LG Electronics',
+        url='https://github.com/fosslight/fosslight_reuse',
+        download_url='https://github.com/fosslight/fosslight_reuse',
+        classifiers=[
+            "License :: OSI Approved :: Closed Source Software",
+            "Programming Language :: Python :: 3",
+            "Programming Language :: Python :: 3.6",
+            "Programming Language :: Python :: 3.7",
+            "Programming Language :: Python :: 3.8",
+            "Programming Language :: Python :: 3.9"],
         install_requires=required,
+        include_package_data=True,
         entry_points={
             "console_scripts": [
-                "fosslight_reuse = fosslight_reuse.wrapper_reuse_lint:main"
+                "fosslight_reuse = fosslight_reuse.cli:main"
             ]
         }
     )