From 3301074ce1312b76338ff72e8f2f9b6fbf74480e Mon Sep 17 00:00:00 2001 From: Jiyeong Seok Date: Thu, 17 Jun 2021 14:01:33 +0900 Subject: [PATCH 1/2] Change the name to FOSSLight Source Scanner --- README.md | 16 ++++++++-------- docs/README_Kor.md | 14 +++++++------- setup.py | 2 +- 3 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 0d51568..ab34d7e 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ SPDX-License-Identifier: Apache-2.0

-# FOSSLight Source +# FOSSLight Source Scanner -FOSSLight Source is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source) +FOSSLight Source Scanner is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)

```note @@ -18,7 +18,7 @@ Detect the license for the source code. Use Source Code Scanner and process the scanner results. ``` -**FOSSLight Source** uses [ScanCode][sc], a source code scanner, to detect the copyright and license phrases contained in the file. Some files (ex- build script), binary files, directory and files in specific directories (ex-test) are excluded from the result. And removes words such as "-only" and "-old-style" from the license name to be printed. The output result is generated in Excel format. +**FOSSLight Source Scanner** uses [ScanCode][sc], a source code scanner, to detect the copyright and license phrases contained in the file. Some files (ex- build script), binary files, directory and files in specific directories (ex-test) are excluded from the result. And removes words such as "-only" and "-old-style" from the license name to be printed. The output result is generated in Excel format. [sc]: https://github.com/nexB/scancode-toolkit @@ -35,7 +35,7 @@ Use Source Code Scanner and process the scanner results. ## ๐Ÿ“‹ Prerequisite -FOSSLight Source needs a Python 3.6+. +FOSSLight Source Scanner needs a Python 3.6+. For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build]. [ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/ @@ -50,7 +50,7 @@ $ pip3 install fosslight_source ## ๐Ÿš€ How to run -There are two commands for FOSSLight Scanner. +There are two commands for FOSSLight Source Scanner. ### 1. fosslight_source After executing ScanCode, the source code scanner, print the FOSSLight Report. @@ -92,8 +92,8 @@ $ tree โ””โ”€โ”€ fosslight_src_log_2021-05-03_00-39-49.txt ``` -- FOSSLight-Report_[datetime].xlsx : FOSSLight Source result in OSS Report format. -- FOSSLight-Report_[datetime].csv : FOSSLight Source result in csv format. (Except Windows) +- FOSSLight-Report_[datetime].xlsx : FOSSLight Source Scanner result in OSS Report format. +- FOSSLight-Report_[datetime].csv : FOSSLight Source Scanner result in csv format. (Except Windows) - fosslight_src_log_[datetime].txt : The execution log. - scancode_[datetime].json : The ScanCode result in case of -j option. @@ -106,6 +106,6 @@ Please report any ideas or bugs to improve by creating an issue in [Git Reposito ## ๐Ÿ“„ License -FOSSLight Source is Apache-2.0, as found in the [LICENSE][l] file. +FOSSLight Source Scanner is Apache-2.0, as found in the [LICENSE][l] file. [l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE diff --git a/docs/README_Kor.md b/docs/README_Kor.md index 3b2d23e..765256e 100644 --- a/docs/README_Kor.md +++ b/docs/README_Kor.md @@ -4,7 +4,7 @@

-# FOSSLight Source +# FOSSLight Source Scanner FOSSLight Source is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)

@@ -14,7 +14,7 @@ Source Code์˜ License๋ฅผ ๊ฒ€์ถœํ•ฉ๋‹ˆ๋‹ค Source Code ์Šค์บ๋„ˆ๋ฅผ ์ด์šฉํ•˜๊ณ  ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€๊ณตํ•ฉ๋‹ˆ๋‹ค ``` -**FOSSLight Source** ์†Œ์Šค ์ฝ”๋“œ ์Šค์บ๋„ˆ์ธ [ScanCode][sc]๋ฅผ ์ด์šฉํ•˜์—ฌ, ํŒŒ์ผ ์•ˆ์— ํฌํ•จ๋œ Copyright๊ณผ License ๋ฌธ๊ตฌ๋ฅผ ๊ฒ€์ถœํ•ฉ๋‹ˆ๋‹ค. Build Script, Binary, Directory, ํŠน์ • Directory (ex-test) ์•ˆ์˜ ํŒŒ์ผ์„ ์ œ์™ธ์‹œํ‚ต๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  License ์ด๋ฆ„์—์„œ "-only", "-old-style"์™€ ๊ฐ™์€ ๋ฌธ๊ตฌ๋ฅผ ์ œ๊ฑฐํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ๊ณผ๋Š” Excel ํ˜•ํƒœ๋กœ ์ถœ๋ ฅ๋ฉ๋‹ˆ๋‹ค. +**FOSSLight Source Scanner** ์†Œ์Šค ์ฝ”๋“œ ์Šค์บ๋„ˆ์ธ [ScanCode][sc]๋ฅผ ์ด์šฉํ•˜์—ฌ, ํŒŒ์ผ ์•ˆ์— ํฌํ•จ๋œ Copyright๊ณผ License ๋ฌธ๊ตฌ๋ฅผ ๊ฒ€์ถœํ•ฉ๋‹ˆ๋‹ค. Build Script, Binary, Directory, ํŠน์ • Directory (ex-test) ์•ˆ์˜ ํŒŒ์ผ์„ ์ œ์™ธ์‹œํ‚ต๋‹ˆ๋‹ค. ๊ทธ๋ฆฌ๊ณ  License ์ด๋ฆ„์—์„œ "-only", "-old-style"์™€ ๊ฐ™์€ ๋ฌธ๊ตฌ๋ฅผ ์ œ๊ฑฐํ•ฉ๋‹ˆ๋‹ค. ๊ฒฐ๊ณผ๋Š” Excel ํ˜•ํƒœ๋กœ ์ถœ๋ ฅ๋ฉ๋‹ˆ๋‹ค. [sc]: https://github.com/nexB/scancode-toolkit @@ -30,14 +30,14 @@ Source Code ์Šค์บ๋„ˆ๋ฅผ ์ด์šฉํ•˜๊ณ  ๊ฒฐ๊ณผ๋ฅผ ๊ฐ€๊ณตํ•ฉ๋‹ˆ๋‹ค ## ๐Ÿ“‹ Prerequisite -FOSSLight Source๋Š” Python 3.6+ ๊ธฐ๋ฐ˜์—์„œ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค.. +FOSSLight Source Scanner๋Š” Python 3.6+ ๊ธฐ๋ฐ˜์—์„œ ๋™์ž‘ํ•ฉ๋‹ˆ๋‹ค.. Windows์˜ ๊ฒฝ์šฐ [Microsoft Visual C++ Build Tools][ms_build]๋ฅผ ์ถ”๊ฐ€๋กœ ์„ค์น˜ํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค. [ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/ ## ๐ŸŽ‰ How to install -FOSSLight Source๋Š” pip3๋ฅผ ์ด์šฉํ•˜์—ฌ ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) ํ™˜๊ฒฝ์—์„œ ์„ค์น˜ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค. +FOSSLight Source Scanner๋Š” pip3๋ฅผ ์ด์šฉํ•˜์—ฌ ์„ค์น˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) ํ™˜๊ฒฝ์—์„œ ์„ค์น˜ํ•  ๊ฒƒ์„ ๊ถŒ์žฅํ•ฉ๋‹ˆ๋‹ค. ``` $ pip3 install fosslight_source @@ -45,7 +45,7 @@ $ pip3 install fosslight_source ## ๐Ÿš€ How to run -FOSSLight Scanner์—๋Š” ํ•˜๊ธฐ ๋‘ ๊ฐ€์ง€ ๋ช…๋ น์–ด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค. +FOSSLight Source Scanner์—๋Š” ํ•˜๊ธฐ ๋‘ ๊ฐ€์ง€ ๋ช…๋ น์–ด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค. ### 1. fosslight_source Source Code ๋ถ„์„์„ ์‹คํ–‰ํ•œ ํ›„ FOSSLight Report ํ˜•์‹์œผ๋กœ ์ถœ๋ ฅํ•ฉ๋‹ˆ๋‹ค. @@ -94,12 +94,12 @@ $ tree ## ๐Ÿ‘ How to report issue -๊ฐœ์„  ์‚ฌํ•ญ์ด๋‚˜ ๋ฒ„๊ทธ๋Š” [Git Repository][repo]์— ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๋ฆฌํฌํŠธํ•ด์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ์ด์Šˆ ๋ฆฌํฌํŠธ๋Š” FOSSLight Scanner ์—…๊ทธ๋ ˆ์ด๋“œ์— ๋งŽ์€ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. +๊ฐœ์„  ์‚ฌํ•ญ์ด๋‚˜ ๋ฒ„๊ทธ๋Š” [Git Repository][repo]์— ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๋ฆฌํฌํŠธํ•ด์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ์ด์Šˆ ๋ฆฌํฌํŠธ๋Š” FOSSLight Source Scanner ์—…๊ทธ๋ ˆ์ด๋“œ์— ๋งŽ์€ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. [repo]: https://github.com/fosslight/fosslight_source/issues ## ๐Ÿ“„ License -FOSSLight Source๋Š” Apache-2.0์ž…๋‹ˆ๋‹ค. License ์›๋ฌธ ํŒŒ์ผ [LICENSE][l]๋ฅผ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค. +FOSSLight Source Scanner๋Š” Apache-2.0์ž…๋‹ˆ๋‹ค. License ์›๋ฌธ ํŒŒ์ผ [LICENSE][l]๋ฅผ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค. [l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE diff --git a/setup.py b/setup.py index 8f4915f..b666eaa 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ version='1.4.8', package_dir={"": "src"}, packages=find_packages(where='src'), - description='FOSSLight Source', + description='FOSSLight Source Scanner', long_description=readme, long_description_content_type='text/markdown', license='Apache-2.0', From ff3812dcc1ac9a498424b5d356672574e5ce9808 Mon Sep 17 00:00:00 2001 From: Soim Kim Date: Thu, 17 Jun 2021 14:36:01 +0900 Subject: [PATCH 2/2] Update git repository url --- CONTRIBUTING.md | 2 +- README.md | 10 +++++----- docs/README_Kor.md | 8 ++++---- setup.py | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bae5f0e..d04ce65 100644 --- 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. ```Fork``` and clone the repository +1. ```Fork``` 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/README.md b/README.md index ab34d7e..ab711a4 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,14 @@ Copyright (c) 2021 LG Electronics SPDX-License-Identifier: Apache-2.0 -->

- + [Korean]

# FOSSLight Source Scanner -FOSSLight Source Scanner is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source) +FOSSLight Source Scanner is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)

```note @@ -42,7 +42,7 @@ For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build]. ## ๐ŸŽ‰ 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. +It can be installed using pip3. It is recommended to install it in the [python 3.6 + virtualenv](https://github.com/fosslight/fosslight_source_scanner/blob/main/docs/Guide_virtualenv.md) environment. ``` $ pip3 install fosslight_source @@ -102,10 +102,10 @@ $ tree 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_source/issues +[repo]: https://github.com/fosslight/fosslight_source_scanner/issues ## ๐Ÿ“„ License FOSSLight Source Scanner is Apache-2.0, as found in the [LICENSE][l] file. -[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE +[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE diff --git a/docs/README_Kor.md b/docs/README_Kor.md index 765256e..eece061 100644 --- a/docs/README_Kor.md +++ b/docs/README_Kor.md @@ -1,12 +1,12 @@

- + [English]

# FOSSLight Source Scanner -FOSSLight Source is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source) +FOSSLight Source is released under the Apache-2.0 License. Current python package version. [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)

```note @@ -96,10 +96,10 @@ $ tree ๊ฐœ์„  ์‚ฌํ•ญ์ด๋‚˜ ๋ฒ„๊ทธ๋Š” [Git Repository][repo]์— ์ด์Šˆ๋ฅผ ์ƒ์„ฑํ•˜์—ฌ ๋ฆฌํฌํŠธํ•ด์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค. ์ด์Šˆ ๋ฆฌํฌํŠธ๋Š” FOSSLight Source Scanner ์—…๊ทธ๋ ˆ์ด๋“œ์— ๋งŽ์€ ๋„์›€์ด ๋ฉ๋‹ˆ๋‹ค. -[repo]: https://github.com/fosslight/fosslight_source/issues +[repo]: https://github.com/fosslight/fosslight_source_scanner/issues ## ๐Ÿ“„ License FOSSLight Source Scanner๋Š” Apache-2.0์ž…๋‹ˆ๋‹ค. License ์›๋ฌธ ํŒŒ์ผ [LICENSE][l]๋ฅผ ์ฐธ๊ณ ํ•˜์‹ญ์‹œ์˜ค. -[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE +[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE diff --git a/setup.py b/setup.py index b666eaa..67957b3 100644 --- a/setup.py +++ b/setup.py @@ -22,8 +22,8 @@ long_description_content_type='text/markdown', license='Apache-2.0', author='LG Electronics', - url='https://github.com/fosslight/fosslight_source', - download_url='https://github.com/fosslight/fosslight_source', + url='https://github.com/fosslight/fosslight_source_scanner', + download_url='https://github.com/fosslight/fosslight_source_scanner', classifiers=['License :: OSI Approved :: Apache Software License', "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6",