Google Git
Sign in
android / platform / external / licenseclassifier / 3a2684d
commit3a2684d3d6811c6d35c2f1bb76a2b4945e4f2f08[log] [tgz]
authorMatt Gaunt <matt@gauntface.co.uk>Fri Apr 19 12:01:19 2019 -0700
committerRobert <rspier@users.noreply.github.com>Fri Apr 19 12:01:19 2019 -0700
tree693a9eb101bf2b5020bf75f41a9a94ea78bb9e6a
parentbf7f529a082f0880e643b96d9948331251ba5cbb [diff]
Update .travis.yml (#8)

* Update .travis.yml

Only run travis tests on the latest go version

* Update .travis.yml

Adding 1.11 and 1.12
1 file changed
tree: 693a9eb101bf2b5020bf75f41a9a94ea78bb9e6a
  1. commentparser/
  2. internal/
  3. licenses/
  4. serializer/
  5. stringclassifier/
  6. tools/
  7. .travis.yml
  8. CHANGELOG
  9. classifier.go
  10. classifier_test.go
  11. CONTRIBUTING.md
  12. file_system_resources.go
  13. forbidden.go
  14. LICENSE
  15. license_type.go
  16. 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.