Merge pull request #75 from fosslight/develop

Print license text through notice parameter

Author: dd-jy

.github/workflows/publish-release.yml

@@ -59,32 +59,32 @@ jobs:
           - os: ubuntu-18.04
             TARGET: ubuntu
             CMD_BUILD: >
-                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
+                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks --add-binary "LICENSE:LICENSES" --add-binary "LICENSES/LicenseRef-3rd_party_licenses.txt:LICENSES" &&
                 mv dist/cli fosslight_bin_ubuntu18
             OUT_FILE_NAME: fosslight_bin_ubuntu18
             ASSET_MIME: application/octet-stream
           - os: macos-latest
             TARGET: macos
             CMD_BUILD: >
-                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
+                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks --add-binary "LICENSE:LICENSES" --add-binary "LICENSES/LicenseRef-3rd_party_licenses.txt:LICENSES" &&
                 mv dist/cli fosslight_bin_macos
             OUT_FILE_NAME: fosslight_bin_macos
             ASSET_MIME: aapplication/x-mach-binary
           - os: windows-latest
             TARGET: windows
             CMD_BUILD: >
-                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks &&
+                pyinstaller --onefile cli.py -n cli --additional-hooks-dir=hooks --add-binary "LICENSE;LICENSES" --add-binary "LICENSES\LicenseRef-3rd_party_licenses.txt;LICENSES" &&
                 move dist/cli.exe fosslight_bin_windows.exe
             OUT_FILE_NAME: fosslight_bin_windows.exe
             ASSET_MIME: application/vnd.microsoft.portable-executable
     steps:
     - uses: actions/checkout@v2
       with:
         ref: main
-    - name: Set up Python 3.6
+    - name: Set up Python 3.8
       uses: actions/setup-python@v2
       with:
-        python-version: 3.6
+        python-version: '3.8'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -112,7 +112,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: '3.7'
+        python-version: '3.8'
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -124,13 +124,3 @@ jobs:
       run: |
         python setup.py sdist bdist_wheel
         twine upload dist/*
-    - name: Upload Release 3rd Party License text
-      id: upload-release-license
-      uses: actions/[email protected]
-      env:
-        GITHUB_TOKEN: ${{ secrets.TOKEN }}
-      with:
-        upload_url: ${{ github.event.release.upload_url }}
-        asset_path: ./LICENSES/LicenseRef-3rd_party_licenses.txt
-        asset_name: LicenseRef-3rd_party_licenses.txt
-        asset_content_type: text/plain

.github/workflows/pull-request.yml

@@ -34,7 +34,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [3.6]
+        python-version: [3.8]
 
     steps:
     - uses: actions/checkout@v2
@@ -55,13 +55,13 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        python-version: [3.6]
+        python-version: [3.8]
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python 3.6
+    - name: Set up Python 3.8
       uses: actions/setup-python@v2
       with:
-        python-version: 3.6
+        python-version: '3.8'
     - name: Install & Run
       run: |
         python -m pip install --upgrade pip

setup.py

@@ -3,6 +3,8 @@
 # Copyright (c) 2021 LG Electronics Inc.
 # SPDX-License-Identifier: Apache-2.0
 from codecs import open
+import os
+import shutil
 from setuptools import setup, find_packages
 
 with open('README.md', 'r', 'utf-8') as f:
@@ -11,9 +13,26 @@
 with open('requirements.txt', 'r', 'utf-8') as f:
     install_requires = f.read().splitlines()
 
+_PACKAEG_NAME = 'fosslight_binary'
+_LICENSE_FILE = 'LICENSE'
+_LICENSE_DIR = 'LICENSES'
+
 if __name__ == "__main__":
+    dest_path = os.path.join('src', _PACKAEG_NAME, _LICENSE_DIR)
+    try:
+        if not os.path.exists(dest_path):
+            os.mkdir(dest_path)
+        if os.path.isfile(_LICENSE_FILE):
+            shutil.copy(_LICENSE_FILE, dest_path)
+        if os.path.isdir(_LICENSE_DIR):
+            license_f = [f_name for f_name in os.listdir(_LICENSE_DIR) if f_name.upper().startswith(_LICENSE_FILE)]
+            for lic_f in license_f:
+                shutil.copy(os.path.join(_LICENSE_DIR, lic_f), dest_path)
+    except Exception as e:
+        print(f'Warning: Fail to copy the license text: {e}')
+
     setup(
-        name='fosslight_binary',
+        name=_PACKAEG_NAME,
         version='4.1.12',
         package_dir={"": "src"},
         packages=find_packages(where='src'),
@@ -42,6 +61,8 @@
                 'python-magic'
             ],
         },
+        package_data={_PACKAEG_NAME: [os.path.join(_LICENSE_DIR, '*')]},
+        include_package_data=True,
         entry_points={
             "console_scripts": [
                 "binary_analysis = fosslight_binary.cli:main",
@@ -50,3 +71,4 @@
             ]
         }
     )
+    shutil.rmtree(dest_path, ignore_errors=True)

src/fosslight_binary/_help.py

@@ -17,7 +17,8 @@
         -o <output_path>\t\t    Output path
         \t\t\t\t    (If you want to generate the specific file name, add the output path with file name.)
         -f <format>\t\t\t    Output file format (excel, csv, opossum, yaml)
-        -d <db_url>\t\t\t    DB Connection(format :'postgresql://username:password@host:port/database_name')"""
+        -d <db_url>\t\t\t    DB Connection(format :'postgresql://username:password@host:port/database_name')
+        --notice\t\t\t    Print the open source license notice text."""
 
 
 def print_help_msg():

src/fosslight_binary/cli.py

@@ -27,6 +27,7 @@ def main():
     parser.add_argument('-o', '--output', type=str, required=False)
     parser.add_argument('-d', '--dburl', type=str, default='', required=False)
     parser.add_argument('-f', '--format', type=str, required=False)
+    parser.add_argument('--notice', action='store_true', required=False)
 
     try:
         args = parser.parse_args()
@@ -55,6 +56,19 @@ def main():
     if args.format:  # -f option
         format = args.format
 
+    if args.notice:  # --notice option
+        try:
+            base_path = sys._MEIPASS
+        except Exception:
+            base_path = os.path.dirname(__file__)
+
+        data_path = os.path.join(base_path, 'LICENSES')
+        print(f"*** {_PKG_NAME} open source license notice ***")
+        for ff in os.listdir(data_path):
+            f = open(os.path.join(data_path, ff), 'r', encoding='utf8')
+            print(f.read())
+        sys.exit(0)
+
     timer = TimerThread()
     timer.setDaemon(True)
     timer.start()