Metadata-Version: 2.1
Name: onot
Version: 1.0.0
Summary: Generate open source software notice based on the SPDX document
Home-page: https://github.com/sktelecom/onot
Author: Haksung Jang
Author-email: hakssung@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# 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](https://github.com/kakao) and [SK telecom](https://github.com/sktelecom). We welcome your contributions.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar.

```bash
pip install onot
```

or you can install latest verson from source code. 

```bash
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](./sample/SPDXRdfExample-v2.1.xlsx), and refer to the next page for [how to prepare it](./docs/how_to_prepare.md).

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](https://sktelecom.github.io/compliance/OSS_Notice_Sample_Application_20221011_140301.html)

```python
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](./sample/SPDXRdfExample-v2.1.xlsx), and refer to the next page for [how to prepare it](./docs/how_to_prepare.md).

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

```shell
$ 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
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](https://github.com/HyunMinH) (한현민) | Kakao| um4825@gmail.com |
| [Haksung](https://github.com/haksungjang) (장학성) | SK telecom | hakssung@gmail.com |

### Contributor

| Name | Company | Email |
|--|--|--|
| [Cindy](https://github.com/blackstrida) (이승아) | Kakao| blackstrida@gmail.com |

## License
[Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)
