Skip to content

Commit 37ae1c2

Browse files
authored
Merge pull request #16 from fosslight/develop
Change the name to FOSSLight Source Scanner
2 parents 4ab936d + ff3812d commit 37ae1c2

File tree

4 files changed

+27
-27
lines changed

4 files changed

+27
-27
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Hi! I'm really appreciate that you'd like to contribute to this project. Your he
44

55
## Submitting a pull request
66

7-
1. <a class="github-button" href="https://github.com/fosslight/fosslight_source/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_source on GitHub">```Fork```</a> and clone the repository
7+
1. <a class="github-button" href="https://github.com/fosslight/fosslight_source_scanner/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_source_scanner on GitHub">```Fork```</a> and clone the repository
88
2. Create a new branch: `git checkout -b my-branch-name`
99
3. Make your change and make sure it works properly.
1010
4. Push to your fork and submit a pull request.

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,22 @@ Copyright (c) 2021 LG Electronics
33
SPDX-License-Identifier: Apache-2.0
44
-->
55
<p align='right'>
6-
<a href="https://github.com/fosslight/fosslight_source/blob/main/docs/README_Kor.md">
6+
<a href="https://github.com/fosslight/fosslight_source_scanner/blob/main/docs/README_Kor.md">
77
[Korean]
88
</a>
99
</p>
1010

11-
# FOSSLight Source
11+
# FOSSLight Source Scanner
1212

13-
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
13+
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source Scanner is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
1414
</p>
1515

1616
```note
1717
Detect the license for the source code.
1818
Use Source Code Scanner and process the scanner results.
1919
```
2020

21-
**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.
21+
**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.
2222

2323

2424
[sc]: https://github.com/nexB/scancode-toolkit
@@ -35,22 +35,22 @@ Use Source Code Scanner and process the scanner results.
3535

3636
## 📋 Prerequisite
3737

38-
FOSSLight Source needs a Python 3.6+.
38+
FOSSLight Source Scanner needs a Python 3.6+.
3939
For windows, you need to install [Microsoft Visual C++ Build Tools][ms_build].
4040

4141
[ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/
4242

4343
## 🎉 How to install
4444

45-
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.
45+
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.
4646

4747
```
4848
$ pip3 install fosslight_source
4949
```
5050

5151
## 🚀 How to run
5252

53-
There are two commands for FOSSLight Scanner.
53+
There are two commands for FOSSLight Source Scanner.
5454

5555
### 1. fosslight_source
5656
After executing ScanCode, the source code scanner, print the FOSSLight Report.
@@ -92,8 +92,8 @@ $ tree
9292
└── fosslight_src_log_2021-05-03_00-39-49.txt
9393
9494
```
95-
- FOSSLight-Report_[datetime].xlsx : FOSSLight Source result in OSS Report format.
96-
- FOSSLight-Report_[datetime].csv : FOSSLight Source result in csv format. (Except Windows)
95+
- FOSSLight-Report_[datetime].xlsx : FOSSLight Source Scanner result in OSS Report format.
96+
- FOSSLight-Report_[datetime].csv : FOSSLight Source Scanner result in csv format. (Except Windows)
9797
- fosslight_src_log_[datetime].txt : The execution log.
9898
- scancode_[datetime].json : The ScanCode result in case of -j option.
9999

@@ -102,10 +102,10 @@ $ tree
102102

103103
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.
104104

105-
[repo]: https://github.com/fosslight/fosslight_source/issues
105+
[repo]: https://github.com/fosslight/fosslight_source_scanner/issues
106106

107107
## 📄 License
108108

109-
FOSSLight Source is Apache-2.0, as found in the [LICENSE][l] file.
109+
FOSSLight Source Scanner is Apache-2.0, as found in the [LICENSE][l] file.
110110

111-
[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE
111+
[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE

docs/README_Kor.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
<p align='right'>
2-
<a href="https://github.com/fosslight/fosslight_source/blob/main/README.md">
2+
<a href="https://github.com/fosslight/fosslight_source_scanner/blob/main/README.md">
33
[English]
44
</a>
55
</p>
66

7-
# FOSSLight Source
7+
# FOSSLight Source Scanner
88

9-
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source)](https://api.reuse.software/info/github.com/fosslight/fosslight_source)
9+
<img src="https://img.shields.io/pypi/l/fosslight_source" alt="FOSSLight Source is released under the Apache-2.0 License." /> <img src="https://img.shields.io/pypi/v/fosslight_source" alt="Current python package version." /> <img src="https://img.shields.io/pypi/pyversions/fosslight_source" /> [![REUSE status](https://api.reuse.software/badge/github.com/fosslight/fosslight_source_scanner)](https://api.reuse.software/info/github.com/fosslight/fosslight_source_scanner)
1010
</p>
1111

1212
```note
1313
Source Code의 License를 검출합니다
1414
Source Code 스캐너를 이용하고 결과를 가공합니다
1515
```
1616

17-
**FOSSLight Source** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 검출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일을 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 결과는 Excel 형태로 출력됩니다.
17+
**FOSSLight Source Scanner** 소스 코드 스캐너인 [ScanCode][sc]를 이용하여, 파일 안에 포함된 Copyright과 License 문구를 검출합니다. Build Script, Binary, Directory, 특정 Directory (ex-test) 안의 파일을 제외시킵니다. 그리고 License 이름에서 "-only", "-old-style"와 같은 문구를 제거합니다. 결과는 Excel 형태로 출력됩니다.
1818

1919
[sc]: https://github.com/nexB/scancode-toolkit
2020

@@ -30,22 +30,22 @@ Source Code 스캐너를 이용하고 결과를 가공합니다
3030

3131
## 📋 Prerequisite
3232

33-
FOSSLight Source는 Python 3.6+ 기반에서 동작합니다..
33+
FOSSLight Source Scanner는 Python 3.6+ 기반에서 동작합니다..
3434
Windows의 경우 [Microsoft Visual C++ Build Tools][ms_build]를 추가로 설치해야 합니다.
3535

3636
[ms_build]: https://visualstudio.microsoft.com/vs/older-downloads/
3737

3838
## 🎉 How to install
3939

40-
FOSSLight Source는 pip3를 이용하여 설치할 수 있습니다. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) 환경에서 설치할 것을 권장합니다.
40+
FOSSLight Source Scanner는 pip3를 이용하여 설치할 수 있습니다. [python 3.6 + virtualenv](Guide_virtualenv_Kor.md) 환경에서 설치할 것을 권장합니다.
4141

4242
```
4343
$ pip3 install fosslight_source
4444
```
4545

4646
## 🚀 How to run
4747

48-
FOSSLight Scanner에는 하기 두 가지 명령어가 있습니다.
48+
FOSSLight Source Scanner에는 하기 두 가지 명령어가 있습니다.
4949

5050
### 1. fosslight_source
5151
Source Code 분석을 실행한 후 FOSSLight Report 형식으로 출력합니다.
@@ -94,12 +94,12 @@ $ tree
9494

9595
## 👏 How to report issue
9696

97-
개선 사항이나 버그는 [Git Repository][repo]에 이슈를 생성하여 리포트해주시기 바랍니다. 이슈 리포트는 FOSSLight Scanner 업그레이드에 많은 도움이 됩니다.
97+
개선 사항이나 버그는 [Git Repository][repo]에 이슈를 생성하여 리포트해주시기 바랍니다. 이슈 리포트는 FOSSLight Source Scanner 업그레이드에 많은 도움이 됩니다.
9898

99-
[repo]: https://github.com/fosslight/fosslight_source/issues
99+
[repo]: https://github.com/fosslight/fosslight_source_scanner/issues
100100

101101
## 📄 License
102102

103-
FOSSLight Source는 Apache-2.0입니다. License 원문 파일 [LICENSE][l]를 참고하십시오.
103+
FOSSLight Source Scanner는 Apache-2.0입니다. License 원문 파일 [LICENSE][l]를 참고하십시오.
104104

105-
[l]: https://github.com/fosslight/fosslight_source/blob/main/LICENSE
105+
[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE

setup.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@
1717
version='1.4.8',
1818
package_dir={"": "src"},
1919
packages=find_packages(where='src'),
20-
description='FOSSLight Source',
20+
description='FOSSLight Source Scanner',
2121
long_description=readme,
2222
long_description_content_type='text/markdown',
2323
license='Apache-2.0',
2424
author='LG Electronics',
25-
url='https://github.com/fosslight/fosslight_source',
26-
download_url='https://github.com/fosslight/fosslight_source',
25+
url='https://github.com/fosslight/fosslight_source_scanner',
26+
download_url='https://github.com/fosslight/fosslight_source_scanner',
2727
classifiers=['License :: OSI Approved :: Apache Software License',
2828
"Programming Language :: Python :: 3",
2929
"Programming Language :: Python :: 3.6",

0 commit comments

Comments
 (0)