|
2 | 2 | sidebar_position: 6 |
3 | 3 | title: Introduction |
4 | 4 | slug: /2025/oss-review-toolkit/ |
5 | | ---- |
| 5 | +--- |
| 6 | +<!-- |
| 7 | +SPDX-License-Identifier: CC-BY-SA-4.0 |
| 8 | +
|
| 9 | +SPDX-FileCopyright Text: 2025 Prakash Mishra <prakashmishra9921@gmail.com> |
| 10 | +--> |
| 11 | + |
| 12 | +## Author: |
| 13 | + |
| 14 | +[Prakash Mishra](https://github.com/Prakash-Mishra-9ghz) |
| 15 | + |
| 16 | +## Contact Info: |
| 17 | + |
| 18 | +- [Email](mailto:prakashmishra9921@gmail.com) |
| 19 | +- [LinkedIn](https://www.linkedin.com/in/prakash-mishra-0a56472b9/) |
| 20 | + |
| 21 | +## Project Title: |
| 22 | + |
| 23 | +Integrating OSS Review Toolkit with FOSSology |
| 24 | + |
| 25 | +## What's the project about? |
| 26 | + |
| 27 | +This project aims to integrate FOSSology — a powerful license scanning tool — into the OSS Review Toolkit (ORT), a platform widely used for analyzing software dependencies. |
| 28 | +By developing a dedicated scanner plugin within ORT, the integration will enable users to seamlessly leverage FOSSology’s license detection capabilities as part of ORT’s automated workflows. |
| 29 | + |
| 30 | + |
| 31 | +## Key Deliverables |
| 32 | + |
| 33 | +The project scope includes the following key tasks: |
| 34 | + |
| 35 | +### Introduce NOMOS as an ORT Scanner Plugin ### |
| 36 | +Implement a new scanner plugin in ORT that integrates NOMOS, FOSSology’s primary license analysis agent. |
| 37 | +Ensure the plugin adheres to ORT's existing scanner interface and lifecycle. |
| 38 | + |
| 39 | +### Configure Scanning Parameters ### |
| 40 | +Define and expose configuration options in ORT to support custom NOMOS parameters (e.g., scanning modes, agent-specific options). |
| 41 | +Ensure the scanning behavior is easily customizable by end users via configuration files. |
| 42 | + |
| 43 | +### Integration with FOSSology Server ### |
| 44 | +Implement communication with a standalone FOSSology server using its REST API in ORT. |
| 45 | +Handle job creation, status polling, and result retrieval through HTTP endpoints. |
| 46 | +Ensure reliable handling of asynchronous scan jobs and large file uploads. |
| 47 | + |
| 48 | +### Enable Customizable FOSSology Integration ### |
| 49 | +Allow users to configure: Server URL and credentials |
| 50 | + |
| 51 | + |
| 52 | +### Add Unit Tests ### |
| 53 | +Write comprehensive unit test cases to validate plugin functionality. |
| 54 | +Conform to ORT's test architecture and quality standards. |
0 commit comments