commit | 006e5cbc150d70483f4b4911fc7703d8e522f0b0 | [log] [tgz] |
---|---|---|
author | Bill Neubauer <wcn@google.com> | Wed Mar 02 11:11:37 2022 -0800 |
committer | Bill Neubauer <wcn@google.com> | Wed Mar 16 15:40:12 2022 -0700 |
tree | db415900291a3b68308d7cd65c750833daafd40d | |
parent | 0ae8c6436993ad2e16c43e0ad11789005a170d14 [diff] |
Updates the classifier's report structure to include information about the detected variant of a match. This information is plumbed through into the text report of the identify_license tool. Note that this currently isn't plumbed into the JSON report because I can't determine what might break as a result of that. Will follow up on this, but wanted to get this initial version done to support basic diagnostics. PiperOrigin-RevId: 431983634
The license classifier is a library and set of tools that can analyze text to determine what type of license it contains. It searches for license texts in a file and compares them to an archive of known licenses. These files could be, e.g., LICENSE
files with a single or multiple licenses in it, or source code files with the license text in a comment.
A “confidence level” is associated with each result indicating how close the match was. A confidence level of 1.0
indicates an exact match, while a confidence level of 0.0
indicates that no license was able to match the text.
Adding a new license is straight-forward:
Create a file in licenses/
.
.header
” to it. See licenses/README.md
for more details.Add the license name to the list in license_type.go
.
Regenerate the licenses.db
file by running the license serializer:
$ license_serializer -output licenseclassifier/licenses
Create and run appropriate tests to verify that the license is indeed present.
identify_license
is a command line tool that can identify the license(s) within a file.
$ identify_license LICENSE LICENSE: GPL-2.0 (confidence: 1, offset: 0, extent: 14794) LICENSE: LGPL-2.1 (confidence: 1, offset: 18366, extent: 23829) LICENSE: MIT (confidence: 1, offset: 17255, extent: 1059)
The license_serializer
tool regenerates the licenses.db
archive. The archive contains preprocessed license texts for quicker comparisons against unknown texts.
$ license_serializer -output licenseclassifier/licenses
This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.