sktelecom / onot

Generate open source software notice based on the SPDX document

onot

onot is a tool that automatically creates open source software notices based on SPDX documents. onot is an open source project co-developed by Kakao and SK telecom. We welcome your contributions.

Installation

Use the package manager pip to install foobar.

pip install onot

or you can install latest verson from source code.

git clone https://github.com/sktelecom/onot.git ~/onot
cd ~/onot; python setup.py install

Usage

Command Line

1. Prepare your input file. The input file is an Excel format SPDX document, and refer to the next page for how to prepare it.

2. Run onot command with two arguments.

   • -i or --input : SPDX document in Excel format containing open source information to be included in the OSS notice
   • -o or --output_format : File type of OSS notice to be generated (html or text)
   • Sample output : output/OSS_Notice_SPDX-Tools-v2.0_20221009_180948.html

onot --input sample/SPDXRdfExample-v2.3.xlsx --output_format html

GUI for windows

1. Prepare your input file. The input file is an Excel format SPDX document, and refer to the next page for how to prepare it.

2. Run the command below or download zip file from release assets.

$ pyinstaller -w onot/gui/onot_app.py

3. Run the onot_app.exe file. Executable file is located in the onot_app directory.

Test

python -m unittest

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Maintainer

Name	Company	Email
Rogers (한현민)	Kakao	[email protected]
Haksung (장학성)	SK telecom	[email protected]

Contributor

Name	Company	Email
Cindy (이승아)	Kakao	[email protected]

License

Apache-2.0

onot's Issues

RDF/xml 형태 SPDX 문서 기반 oss notice 생성

현재의 onot은 excel 형태의 SPDX 문서를 input으로 받아서 OSS notice를 생성하고 있는데요, SPDX 문서는 RDF/xml, tag-value 등 여러가지 문서 형태를 지원합니다.

onot도 Excel 뿐만 아니라 다른 형태의 SPDX 문서를 input으로 받아도 OSS notice를 생성하게 되길 원합니다.

감사합니다.

test & issue reports

onot는 이제 막 세상에 나왔습니다. 버그 천지일거예요. :)
test와 issue report를 부탁드립니다.

감사합니다.

Windows GUI용 executable 지원

Python 환경 구축이 곤란한 사용자를 위한 Windows GUI용 executable 지원이 필요합니다.

• PyQt5로 input file을 선택하고 오픈소스 고지문을 생성하기 위한 간단한 GUI를 구성하고,
• PyInstaller로 executable을 생성

소스 공개용 저장소 링크 제공

일반적으로 written offer에는 "You may also find the source code at http://sktelecom.github.io" 와 같이 고객이 직접 소스코드를 다운 받을 수 있는 저장소 링크를 제공합니다.

onot이 이러한 정보를 제공하려면 http://sktelecom.github.io와 같은 저장소 주소 정보를 받아서 이를 고지문에 포함시켜야 합니다. SPDX 문서는 이런 정보를 포함하지 않아서, 어떻게 처리하는게 좋을지 고민이 필요합니다.

감사합니다.

Integration Black Duck scanning using GitHub Actions

Dual License 표기 처리

'License Concluded'란에 라이선스 표기가 'OR'나 'AND'를 써서 두 개 이상의 라이선스 정보가 표기되는 경우가 있습니다. SPDX에서도 이러한 방법을 사용하고 있습니다. : https://spdx.github.io/spdx-spec/SPDX-license-expressions/#d42-disjunctive-or-operator

현재는 이를 처리하지 않고 있는데요, 이렇게 OR, AND, WITH 등의 형태로 두 개 이상의 라이선스가 작성되는 경우를 처리해야 합니다.

감사합니다.

install error in Windows 10

I tried install using setup.py in Windows 10 environment, but met below error.

python setup.py install
Traceback (most recent call last):
  File "C:\Users\ian\project\onot\setup.py", line 11, in <module>
    long_description = fh.read()
UnicodeDecodeError: 'cp949' codec can't decode byte 0xed in position 2118: illegal multibyte sequence

Error loading Python DLL

I made an onot_app.exe file using the below command in Windows 10 environment.

pyinstaller -w onot/gui/onot_app.py

and tried run build\onot_app\onot_app.exe but met Error loading Python DLL.

Error loading Python DLL

'C"\Users\...\onot\build\onot_app\python39.dll. 
LoadLibrary: 지정된 모듈을 찾을 수 없습니다.

Text 형태 OSS notice 생성

현재 onot이 생성하는 고지문 파일 형태는 html입니다.
심플한 text 형태로도 고지문을 생성하게 되길 원합니다.

SPDX > 'Per File Info' 내 오픈소스 정보 포함

현재는 SPDX > 'Package Info'내 오픈소스 정보만 가져오고 있습니다.
'Per File Info' 내 오픈소스 정보도 가져와서 오픈소스 고지문에 포함시켜야 합니다.
물론, 동일한 오픈소스 정보를 중복해서 포함시킬 필요는 없습니다.

감사합니다.