Skip to content

Commit e02311b

Browse files
authored
Merge pull request #315 from Prakash-Mishra-9ghz/week-progress
docs(blog): Add project details, Community Bonding, Week 1 & 2 blog posts
2 parents d191381 + 151efa3 commit e02311b

File tree

5 files changed

+168
-1
lines changed

5 files changed

+168
-1
lines changed

docs/2025/oss-review-toolkit/index.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,53 @@
22
sidebar_position: 6
33
title: Introduction
44
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.
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Community Bonding
3+
author: Prakash Mishra
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2025 Prakash Mishra <prakashmishra9921@gmail.com>
9+
-->
10+
11+
# Comunity Bonding Meetings and Activities
12+
13+
## Community Meeting 1 (Introductory)
14+
15+
*(May 12, 2025)*
16+
17+
### Attendees
18+
19+
Complete FOSSology Community including
20+
- Org admins
21+
- Mentors of all the projects
22+
- Contributors for GSoC 2025
23+
24+
### Discussion
25+
26+
- This session marked the beginning of the GSoC 2025 community bonding phase.
27+
- It served as an opportunity for contributors, mentors, and org admins to connect and lay the groundwork for the upcoming summer.
28+
- Everyone took turns introducing themselves, highlighting their backgrounds and prior involvement with open source.
29+
- The FOSSology team shared key insights into the project structure, goals, and how the community collaborates.
30+
- Slack was chosen as the main channel for staying in touch and coordinating activities.
31+
- The meeting wrapped up with an open Q&A to ensure clarity and address early questions from participants.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Week 1
3+
author: Prakash Mishra
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2025 Prakash Mishra <prakashmishra9921@gmail.com>
9+
-->
10+
11+
# Week 01 Meetings and Activities
12+
13+
## Integration of ORT with FOSSology Sync Meeting 1
14+
15+
*(June 2, 2025)*
16+
17+
### Attendees
18+
19+
- [Prakash Mishra](https://github.com/Prakash-Mishra-9ghz)
20+
- [Kaushlendra Pratap](https://github.com/Kaushl2208)
21+
- [Gaurav Mishra](https://github.com/gmishx)
22+
23+
### Discussion
24+
25+
- Attended the first sync meeting with mentors to plan the initial phase of ORT and FOSSology integration.
26+
- Mentors suggested reviewing the ORT developer guide and understanding how tools like ScanCode integrate with ORT.
27+
- With a basic understanding now in place, I’ve identified specific tasks I’ll start working on to begin the work in the upcoming weeks.
28+
29+
30+
### Progress
31+
32+
- Read through the ORT developer guide to understand its architecture and how scanner integrations are structured.
33+
- Reviewed documentation for ScanCode to learn from existing scanner integrations.
34+
- Interacted with the ORT community via Slack to introduce myself and seek guidance. The community shared helpful documentation.
35+
- Mentor also advised brushing up on Kotlin, as ORT is primarily written in it. Spent time revisiting Kotlin basics and common patterns used in the project.
36+
37+
38+
### Next Steps
39+
40+
- Continue studying relevant plugins and Kotlin code to guide implementation.
41+
- Raise any blockers in the next sync meeting or community channels.
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
title: Week 2
3+
author: Prakash Mishra
4+
---
5+
<!--
6+
SPDX-License-Identifier: CC-BY-SA-4.0
7+
8+
SPDX-FileCopyrightText: 2025 Prakash Mishra <prakashmishra9921@gmail.com>
9+
-->
10+
11+
# Week 02 Meetings and Activities
12+
13+
## Integration of ORT with FOSSology Sync Meeting 2
14+
15+
*(June 9, 2025)*
16+
17+
### Attendees
18+
19+
- [Prakash Mishra](https://github.com/Prakash-Mishra-9ghz)
20+
- [Kaushlendra Pratap](https://github.com/Kaushl2208)
21+
22+
### Discussion
23+
24+
- Participated in the second weekly sync meeting with mentor.
25+
- Shared updates on my interaction with the ORT community and the guidance I received around integrating external scanners.
26+
- Brought up a key question about how Nomos works as a standalone tool and whether it can be invoked directly.
27+
- Mentor pointed me to the right resources for understanding Nomos as a standalone tool — including how to build it, use its flags, and interpret its output.
28+
29+
### Progress
30+
- Successfully built Nomos as a standalone tool on my local system.
31+
- Tested Nomos independently on sample files to understand its CLI interface and license detection capabilities.
32+
- Ran Nomos with different flags to evaluate its functionality and output formats:
33+
- `-J`: Produces output in **JSON**, ideal for structured parsing.
34+
- `-S`: Outputs highlighting information in **plain text**, showing the locations of detected licenses and keywords within files — including details like the position (at), length, and index of each match
35+
- `-l`: Ensures full file paths are included in the output.
36+
- `-c` / `-d`: Used for specifying config and scan directories respectively.
37+
- This hands-on testing gave me a clear idea of how to invoke Nomos programmatically and parse its results for integration.
38+
39+
### Next Steps
40+
41+
- Begin creating the initial skeleton or wrapper code to invoke Nomos from within the ORT scanning pipeline.
42+
- Continue referring to existing ORT scanner plugin implementations for structure and integration best practices.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"label": "Weekly Updates",
3+
"position": 2
4+
}

0 commit comments

Comments
 (0)