Google Git
Sign in
fuchsia / third_party / github.com / google / licenseclassifier / fa339fa6f73e61036e56f3bb6ac02d7074fde43b
commitfa339fa6f73e61036e56f3bb6ac02d7074fde43b[log] [tgz]
authorBill Neubauer <wcn@google.com>Wed Feb 09 11:52:27 2022 -0800
committerBill Neubauer <wcn@google.com>Wed Mar 16 15:38:28 2022 -0700
tree044cc460b1408976b6fda0af52b29badc8a79058
parent0c505735c0b4f6c4d0acb9fdca8f08532e1fc240 [diff]
Fork the licenses content into a new assets directory to more flexibly support
content for matching.

Rather than encoding both the type of file and variant name in a single file,
the types are now the top-level directory, the common name of the asset is a
subdirectory, and each file in the directory is a variant that matches the
asset. This makes populating content easier to reason about and allows for easy
extensibility of the type of content that is matched.

The code that uses this new arrangement will be a follow-up CL, since this CL
is purely a branching effort to put content in a new configuration.

PiperOrigin-RevId: 427532245
295 files changed
tree: 044cc460b1408976b6fda0af52b29badc8a79058
  1. commentparser/
  2. internal/
  3. licenses/
  4. serializer/
  5. stringclassifier/
  6. tools/
  7. v2/
  8. .travis.yml
  9. CHANGELOG
  10. classifier.go
  11. classifier_test.go
  12. CONTRIBUTING.md
  13. file_system_resources.go
  14. forbidden.go
  15. go.mod
  16. go.sum
  17. LICENSE
  18. license_type.go
  19. README.md
README.md

License Classifier

Build status

Introduction

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

Adding a new license is straight-forward:

  1. Create a file in licenses/.

    • The filename should be the name of the license or its abbreviation. If the license is an Open Source license, use the appropriate identifier specified at https://spdx.org/licenses/.
    • If the license is the “header” version of the license, append the suffix “.header” to it. See licenses/README.md for more details.

  2. Add the license name to the list in license_type.go.

  3. Regenerate the licenses.db file by running the license serializer:

    $ license_serializer -output licenseclassifier/licenses

  4. Create and run appropriate tests to verify that the license is indeed present.

Tools

Identify license

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)

License serializer

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.