onot 0.0.1

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.

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

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.1.xlsx --output_format html

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.

License

Apache-2.0