Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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_source/fork" data-icon="octicon-repo-forked" aria-label="Fork fosslight/fosslight_source on GitHub">```Fork```</a> and clone the repository
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
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.
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ Copyright (c) 2021 LG Electronics
SPDX-License-Identifier: Apache-2.0
-->
<p align='right'>
<a href="https://github.com/fosslight/fosslight_source/blob/main/docs/README_Kor.md">
<a href="https://github.com/fosslight/fosslight_source_scanner/blob/main/docs/README_Kor.md">
[Korean]
</a>
</p>

# FOSSLight Source
# FOSSLight Source Scanner

<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)
<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)
</p>

```note
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
Expand All @@ -35,22 +35,22 @@ 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/

## 🎉 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
```

## 🚀 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.
Expand Down Expand Up @@ -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.

Expand All @@ -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 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
[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE
22 changes: 11 additions & 11 deletions docs/README_Kor.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<p align='right'>
<a href="https://github.com/fosslight/fosslight_source/blob/main/README.md">
<a href="https://github.com/fosslight/fosslight_source_scanner/blob/main/README.md">
[English]
</a>
</p>

# FOSSLight Source
# FOSSLight Source Scanner

<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)
<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)
</p>

```note
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

Expand All @@ -30,22 +30,22 @@ 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
```

## 🚀 How to run

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

### 1. fosslight_source
Source Code 분석을 실행한 후 FOSSLight Report 형식으로 출력합니다.
Expand Down Expand Up @@ -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
[repo]: https://github.com/fosslight/fosslight_source_scanner/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
[l]: https://github.com/fosslight/fosslight_source_scanner/blob/main/LICENSE
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@
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',
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",
Expand Down