Welcome to the license-coverage-grader wiki!

license-coverage-grader is a command line tool written in python. It take an SPDX document and pointer to the original source files, and determine a "grade" score to quantify how complete the licensing information is at the file level for the code represented by the SPDX document.

What does the license-coverage-grader tool do?

• Determines how compatible an SPDX document is to its original source files
• Determines all source files in a source code package by counting blank lines, comment lines, and physical lines of source code
• Determine a "grade" score to quantify how complete the licensing information is at the file level for the code represented by the SPDX document.

How does it work?

Given an SPDX document and its source code package license-coverage-grader will:-

• Scan the SPDX document and parse the result into XML
• Scan and analyse the source code package
• Use a specialized parser to count physical lines of source code in a source file
• Count all the source files in a given source package
• Count all the source files containing license information found in the source package
• Compute a grade score for the source package

What it doesn't do

The license-coverage-grader tool does not generate an SPDX document by its right. The tool only takes an already made SPDX document and pointer to the original source files to determine a grade score for the source package.