Merge pull request #87 from fosslight/temp

bjk7119 · web-flow · commit 9eb44eae618a · 2022-07-22T13:46:18.000+09:00
Rename FOSSLight Reuse to FOSSLight Prechecker
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -1,7 +1,7 @@
 # 1. Update changelog
 # 2. Upload a Python Package using Twine
 
-name: Release fosslight_reuse
+name: Release fosslight_prechecker
 
 on:
   release:
@@ -61,8 +61,8 @@ jobs:
             TARGET: windows
             CMD_BUILD: >
                 pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
-                move dist/cli.exe fosslight_reuse_windows.exe
-            OUT_FILE_NAME: fosslight_reuse_windows.exe
+                move dist/cli.exe fosslight_prechecker_windows.exe
+            OUT_FILE_NAME: fosslight_prechecker_windows.exe
             ASSET_MIME: application/vnd.microsoft.portable-executable
     steps:
     - uses: actions/checkout@v2
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -1,6 +1,6 @@
 # Running tests with tox for releasing new version
 
-name: Pull requests fosslight_reuse
+name: Pull requests fosslight_prechecker
 
 on:
   pull_request:
@@ -47,9 +47,9 @@ jobs:
             TARGET: windows
             CMD_BUILD: >
                 pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
-                move dist/cli.exe fosslight_reuse_windows.exe &&
-                ./fosslight_reuse_windows.exe
-            OUT_FILE_NAME: fosslight_reuse_windows.exe
+                move dist/cli.exe fosslight_prechecker_windows.exe &&
+                ./fosslight_prechecker_windows.exe
+            OUT_FILE_NAME: fosslight_prechecker_windows.exe
             ASSET_MIME: application/vnd.microsoft.portable-executable
     steps:
     - uses: actions/checkout@v2
diff --git a/.reuse/dep5 b/.reuse/dep5
@@ -1,6 +1,6 @@
 Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: FOSSLight REUSE
-Source: https://github.com/fosslight/fosslight_reuse
+Upstream-Name: FOSSLight Prechecker
+Source: https://github.com/fosslight/fosslight_prechecker
 
 Files: *.md
 Copyright: 2021 LG Electronics
@@ -26,6 +26,6 @@ Files: .bumpversion.cfg
 Copyright: 2021 LG Electronics
 License: GPL-3.0-only
 
-Files: src/fosslight_reuse/resources/convert_license.json
+Files: src/fosslight_prechecker/resources/convert_license.json
 Copyright: 2021 LG Electronics
 License: GPL-3.0-only
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,7 +4,7 @@ Hi! I'm really appreciate that you'd like to contribute to this project. Your he
 
 ## Submitting a pull request
 
-1. <a class="github-button" href="https://github.com/fosslight/fosslight_reuse/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_reuse on GitHub">```Fork```</a> and clone the repository
+1. <a class="github-button" href="https://github.com/fosslight/fosslight_prechecker/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_prechecker on GitHub">```Fork```</a> and clone the repository
 2. Create a new branch: `git checkout -b my-branch-name`
 3. Make your change and make sure it works properly.
 4. Push to your fork and submit a pull request.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
 include README.md
 include requirements.txt
 include LICENSE
-recursive-include src/fosslight_reuse/resources *.json
+recursive-include src/fosslight_prechecker/resources *.json
diff --git a/README.md b/README.md
@@ -2,11 +2,11 @@
 Copyright (c) 2021 LG Electronics
 SPDX-License-Identifier: GPL-3.0-only
  -->
-# FOSSLight Reuse
+# FOSSLight Prechecker
 
 <img src="https://img.shields.io/pypi/l/fosslight-reuse" alt="License" /> <img src="https://img.shields.io/pypi/v/fosslight_reuse" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_reuse" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_reuse)](https://api.reuse.software/info/github.com/fosslight/fosslight_reuse)
 
-**FOSSLight Reuse** is a tool that can be used to comply with the copyright/license writing rules in the source code.     
+**FOSSLight Prechecker** 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][rule] are complied with.
 
 [ret]: https://github.com/fsfe/reuse-tool
@@ -19,7 +19,7 @@ Here a short summary:
 
 - `lint` --- Check whether the [source code's copyright and license writing rules][rule] are complied with.
 
-- `convert` --- Convert [oss-pkg-info.yaml](https://github.com/fosslight/fosslight_reuse/blob/main/tests/convert/oss-pkg-info.yaml) to [FOSSLight-Report.xlsx](https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html) and vice versa.
+- `convert` --- Convert [oss-pkg-info.yaml](https://github.com/fosslight/fosslight_prechecker/blob/main/tests/convert/oss-pkg-info.yaml) to [FOSSLight-Report.xlsx](https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html) and vice versa.
 
 - `add` --- Add copyright and license to missing file(s)
 
@@ -28,9 +28,9 @@ Here a short summary:
 
 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
+[repo]: https://github.com/fosslight/fosslight_prechecker/issues
 
 ## 📄 License  
-FOSSLight Reuse is licensed under [GPL-3.0-only][l].
+FOSSLight Prechecker is licensed under [GPL-3.0-only][l].
 
-[l]: https://github.com/fosslight/fosslight_reuse/blob/main/LICENSE
+[l]: https://github.com/fosslight/fosslight_prechecker/blob/main/LICENSE
diff --git a/cli.py b/cli.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 # Copyright (c) 2020 LG Electronics Inc.
 # SPDX-License-Identifier: GPL-3.0-only
-from fosslight_oss_pkg.fosslight_oss_pkg import convert_report
+from fosslight_oss_pkg._convert import convert_report
 
 if __name__ == '__main__':
     convert_report("", "", "")
diff --git a/hooks/hook-fosslight_prechecker.py b/hooks/hook-fosslight_prechecker.py
@@ -4,4 +4,4 @@
 # SPDX-License-Identifier: GPL-3.0-only
 from PyInstaller.utils.hooks import collect_all
 
-datas, binaries, hiddenimports = collect_all('fosslight_reuse')
+datas, binaries, hiddenimports = collect_all('fosslight_prechecker')
diff --git a/setup.py b/setup.py
@@ -13,17 +13,17 @@
 
 if __name__ == "__main__":
     setup(
-        name='fosslight_reuse',
+        name='fosslight_prechecker',
         version='2.2.2',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
-        description='FOSSLight Reuse',
+        description='FOSSLight Prechecker',
         long_description=readme,
         long_description_content_type='text/markdown',
         license='GPL-3.0-only',
         author='LG Electronics',
-        url='https://github.com/fosslight/fosslight_reuse',
-        download_url='https://github.com/fosslight/fosslight_reuse',
+        url='https://github.com/fosslight/fosslight_prechecker',
+        download_url='https://github.com/fosslight/fosslight_prechecker',
         classifiers=[
             "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
             "Programming Language :: Python :: 3",
@@ -32,11 +32,12 @@
             "Programming Language :: Python :: 3.8",
             "Programming Language :: Python :: 3.9"],
         install_requires=required,
-        package_data={'fosslight_reuse': ['resources/convert_license.json']},
+        package_data={'fosslight_prechecker': ['resources/convert_license.json']},
         include_package_data=True,
         entry_points={
             "console_scripts": [
-                "fosslight_reuse = fosslight_reuse.cli:main"
+                "fosslight_prechecker = fosslight_prechecker.cli:main",
+                "fosslight_reuse = fosslight_prechecker.cli:main"
             ]
         }
     )
diff --git a/src/fosslight_oss_pkg/_convert.py b/src/fosslight_oss_pkg/_convert.py
@@ -10,14 +10,14 @@
 from datetime import datetime
 from pathlib import Path
 from yaml import safe_dump
-from fosslight_reuse._help import print_help_msg
+from fosslight_prechecker._help import print_help_msg
 from fosslight_util.constant import LOGGER_NAME
 from fosslight_util.set_log import init_log
 from fosslight_util.output_format import check_output_format
 from ._parsing_excel import convert_excel_to_yaml, convert_yml_to_excel
 
-CUSTOMIZED_FORMAT_FOR_REUSE = {'yaml': '.yaml', 'excel': '.xlsx'}
-_PKG_NAME = "fosslight_reuse"
+CUSTOMIZED_FORMAT_FOR_PRECHECKER = {'yaml': '.yaml', 'excel': '.xlsx'}
+_PKG_NAME = "fosslight_prechecker"
 logger = logging.getLogger(LOGGER_NAME)
 
 
@@ -51,9 +51,9 @@ def convert_report(base_path, output_name, format, need_log_file=True, sheet_nam
     now = datetime.now().strftime('%Y%m%d_%H-%M-%S')
     is_window = platform.system() == "Windows"
 
-    success, msg, output_path, output_name, output_extension = check_output_format(output_name, format, CUSTOMIZED_FORMAT_FOR_REUSE)
+    success, msg, output_path, output_name, output_extension = check_output_format(output_name, format, CUSTOMIZED_FORMAT_FOR_PRECHECKER)
 
-    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_reuse_log_{now}.txt"),
+    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_prechecker_log_{now}.txt"),
                                    need_log_file, logging.INFO, logging.DEBUG, _PKG_NAME, base_path)
     if success:
         if output_path == "":
diff --git a/src/fosslight_prechecker/__init__.py b/src/fosslight_prechecker/__init__.py
diff --git a/src/fosslight_prechecker/_add.py b/src/fosslight_prechecker/_add.py
@@ -15,15 +15,15 @@
 from fosslight_util.parsing_yaml import find_all_oss_pkg_files, parsing_yml
 from fosslight_util.output_format import check_output_format
 from datetime import datetime
-from fosslight_reuse._fosslight_reuse import reuse_for_project, reuse_for_files, dump_error_msg, get_path_to_find
+from fosslight_prechecker._precheck import precheck_for_project, precheck_for_files, dump_error_msg, get_path_to_find
 from reuse.header import run as reuse_header
 from reuse.download import run as reuse_download
 from reuse._comment import EXTENSION_COMMENT_STYLE_MAP_LOWERCASE
 from reuse._main import parser as reuse_arg_parser
 from reuse.project import Project
 
 
-PKG_NAME = "fosslight_reuse"
+PKG_NAME = "fosslight_prechecker"
 LICENSE_INCLUDE_FILES = ["license", "license.md", "license.txt", "notice"]
 EXCLUDE_DIR = ["test", "tests", "doc", "docs"]
 EXCLUDE_PREFIX = ("test", ".", "doc", "__")
@@ -76,7 +76,7 @@ def check_license_and_copyright(path_to_find, all_files, missing_license, missin
     skip_files = sorted(set(all_files_filtered) - set(missing_license_filtered) - set(missing_copyright_filtered))
     logger.info(f"\n# File list that have both license and copyright : {len(skip_files)} / {len(all_files_filtered)}")
 
-    reuse_for_files(path_to_find, skip_files)
+    precheck_for_files(path_to_find, skip_files)
 
     return missing_license_filtered, missing_copyright_filtered
 
@@ -346,7 +346,7 @@ def add_content(target_path="", input_license="", input_copyright="", output_pat
         output_path = os.path.abspath(output_path)
 
     now = datetime.now().strftime('%Y%m%d_%H-%M-%S')
-    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_reuse_add_log_{now}.txt"),
+    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_prechecker_add_log_{now}.txt"),
                                    need_log_file, logging.INFO, logging.DEBUG, PKG_NAME, path_to_find)
 
     if not os.path.isdir(path_to_find):
@@ -374,7 +374,7 @@ def add_content(target_path="", input_license="", input_copyright="", output_pat
     # File Only mode (-f option)
     if _check_only_file_mode:
         main_parser = reuse_arg_parser()
-        missing_license_list, missing_copyright_list, project = reuse_for_files(path_to_find, file_to_check_list)
+        missing_license_list, missing_copyright_list, project = precheck_for_files(path_to_find, file_to_check_list)
 
         if input_license == "" and input_copyright == "":
             input_copyright = input_copyright_while_running()
@@ -419,7 +419,7 @@ def add_content(target_path="", input_license="", input_copyright="", output_pat
         all_files_list = get_allfiles_list(path_to_find)
 
         # Get missing license / copyright file list
-        missing_license, missing_copyright, _, project, _ = reuse_for_project(path_to_find, need_log_file)
+        missing_license, missing_copyright, _, project, _ = precheck_for_project(path_to_find, need_log_file)
 
         # Print Skipped Files
         missing_license_filtered, missing_copyright_filtered = \
diff --git a/src/fosslight_prechecker/_constant.py b/src/fosslight_prechecker/_constant.py
@@ -21,7 +21,7 @@
             .underline{text-decoration-line: underline;}
             table{width: 100%;}
         </style>
-        <title>FOSSLight Reuse</title>
+        <title>FOSSLight Prechecker</title>
     </head>
     <body>
             <table cellspacing="0" cellpadding="0" border="0" style="font-family:'arial,sans-serif'">
@@ -30,7 +30,7 @@
                         <table cellspacing="0" cellpadding="0" border="0">
                             <tr>
                                 <td colspan="3" height="25" style="background:#c00c3f">
-                                    <h1 style="margin:0;padding-left:5px;font-size:14px;color:white">FOSSLight Reuse Lint</h1>
+                                    <h1 style="margin:0;padding-left:5px;font-size:14px;color:white">FOSSLight Prechecker Lint</h1>
                                 </td>
                             </tr>
                             <tr>
diff --git a/src/fosslight_prechecker/_help.py b/src/fosslight_prechecker/_help.py
@@ -4,16 +4,16 @@
 # SPDX-License-Identifier: GPL-3.0-only
 from fosslight_util.help import PrintHelpMsg
 
-_HELP_MESSAGE_REUSE = """
-    FOSSLight Reuse is a Tool to check REUSE compliance in source code.
+_HELP_MESSAGE_PRECHECKER = """
+    FOSSLight Prechecker is a tool that checks whether source code complies with copyright and license writing rules.
 
-    Usage: fosslight_reuse [Mode] [option1] <arg1> [option2] <arg2>...
-     ex) fosslight_reuse lint -p /home/test/src/
-         fosslight_reuse add -p /home/test/test.py -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
+    Usage: fosslight_prechecker [Mode] [option1] <arg1> [option2] <arg2>...
+     ex) fosslight_prechecker lint -p /home/test/src/
+         fosslight_prechecker add -p /home/test/test.py -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
 
     Parameters:
         Mode
-            lint\t\t    Check REUSE compliance
+            lint\t\t    Check whether the copyright and license writing rules are complied with
             convert\t\t    Convert oss_pkg_info.yaml <-> FOSSLight-Report.xlsx
             add\t\t\t    Add missing license and copyright
 
@@ -35,5 +35,5 @@
 
 
 def print_help_msg(exitOpt=True):
-    helpMsg = PrintHelpMsg(_HELP_MESSAGE_REUSE)
+    helpMsg = PrintHelpMsg(_HELP_MESSAGE_PRECHECKER)
     helpMsg.print_help_msg(exitOpt)
diff --git a/src/fosslight_prechecker/_precheck.py b/src/fosslight_prechecker/_precheck.py
@@ -16,10 +16,10 @@
 from reuse import report
 from reuse.project import Project
 from reuse.report import ProjectReport
-from fosslight_reuse._result import write_result_file, create_result_file, result_for_summary, ResultItem
-from fosslight_reuse._constant import DEFAULT_EXCLUDE_EXTENSION, OSS_PKG_INFO_FILES
+from fosslight_prechecker._result import write_result_file, create_result_file, result_for_summary, ResultItem
+from fosslight_prechecker._constant import DEFAULT_EXCLUDE_EXTENSION, OSS_PKG_INFO_FILES
 
-PKG_NAME = "fosslight_reuse"
+PKG_NAME = "fosslight_prechecker"
 REUSE_CONFIG_FILE = ".reuse/dep5"
 DEFAULT_EXCLUDE_EXTENSION_FILES = []  # Exclude files from reuse
 _turn_on_default_reuse_config = True
@@ -109,7 +109,7 @@ def remove_reuse_dep5_file(rollback, file_to_remove, temp_dir_name):
         dump_error_msg(f"Error_Remove_Dep5 : {ex}")
 
 
-def reuse_for_files(path, files):
+def precheck_for_files(path, files):
     global DEFAULT_EXCLUDE_EXTENSION_FILES
 
     missing_license_list = []
@@ -140,15 +140,15 @@ def reuse_for_files(path, files):
                             missing_copyright_list.append(file)
 
             except Exception as ex:
-                dump_error_msg(f"Error_Reuse_for_file_to_read : {ex}", True)
+                dump_error_msg(f"Error - precheck_for_files to read : {ex}", True)
 
     except Exception as ex:
-        dump_error_msg(f"Error_Reuse_for_file : {ex}", True)
+        dump_error_msg(f"Error - precheck_for_files: {ex}", True)
 
     return missing_license_list, missing_copyright_list, prj
 
 
-def reuse_for_project(path_to_find, need_log_file):
+def precheck_for_project(path_to_find, need_log_file):
     missing_license = []
     missing_copyright = []
 
@@ -181,7 +181,7 @@ def reuse_for_project(path_to_find, need_log_file):
             path_to_find += "/"
         missing_copyright = [sub.replace(path_to_find, '') for sub in missing_copyright]
     except Exception as ex:
-        dump_error_msg(f"Error_Reuse_lint: {ex}", True)
+        dump_error_msg(f"Error prechecker lint: {ex}", True)
 
     if _turn_on_default_reuse_config:
         remove_reuse_dep5_file(need_rollback, temp_file_name, temp_dir_name)
@@ -198,7 +198,7 @@ def dump_error_msg(error_msg: str, exit=False):
 
 def init(path_to_find, output_path, file_list, need_log_file=True):
     global logger, _result_log
-    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_reuse_log_{_start_time}.txt"),
+    logger, _result_log = init_log(os.path.join(output_path, f"fosslight_prechecker_log_{_start_time}.txt"),
                                    need_log_file, logging.INFO, logging.DEBUG, PKG_NAME, path_to_find)
     if file_list:
         _result_log["File list to check"] = file_list
@@ -259,9 +259,9 @@ def run_lint(target_path, disable, output_file_name, format='', need_log_file=Tr
         _turn_on_default_reuse_config = not disable
 
         if _check_only_file_mode:
-            license_missing_files, copyright_missing_files, project = reuse_for_files(path_to_find, file_to_check_list)
+            license_missing_files, copyright_missing_files, project = precheck_for_files(path_to_find, file_to_check_list)
         else:
-            license_missing_files, copyright_missing_files, oss_pkg_info, project, report = reuse_for_project(path_to_find, need_log_file)
+            license_missing_files, copyright_missing_files, oss_pkg_info, project, report = precheck_for_project(path_to_find, need_log_file)
 
         result_item = result_for_summary(path_to_find,
                                          oss_pkg_info,
diff --git a/src/fosslight_prechecker/_result.py b/src/fosslight_prechecker/_result.py
diff --git a/src/fosslight_prechecker/_result_html.py b/src/fosslight_prechecker/_result_html.py
diff --git a/src/fosslight_prechecker/cli.py b/src/fosslight_prechecker/cli.py
diff --git a/src/fosslight_prechecker/resources/convert_license.json b/src/fosslight_prechecker/resources/convert_license.json
diff --git a/tox.ini b/tox.ini
