commit | 9af65096d7ceb845f034197c5f6b762894c680eb | [log] [tgz] |
---|---|---|
author | Bill Neubauer <wcn@google.com> | Mon Aug 22 11:54:55 2022 -0700 |
committer | Bill Neubauer <bill.neubauer@gmail.com> | Fri Sep 16 10:06:11 2022 -0700 |
tree | b64f8d5894a9b05cf285fda107a7ce487efd695e | |
parent | bbfad6347cd1f2f7e28fb20144f64d60c700181b [diff] |
Make the public facing API be implemented in terms of io.Reader rather than []byte. This allows for larger files or other inputs to be handled without requiring the full contents to be stored in memory at one time. PiperOrigin-RevId: 474376181
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.