mirrors
/
licensee
mirror of https://github.com/licensee/licensee.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
885 Commits 19 Branches 104 Tags 46 MiB
Ruby 98.8%
Shell 1%
Dockerfile 0.2%
Go to file
Ben Balter df0737334c
test bin 		2018-02-06 10:46:58 -05:00
.github Update .github/config.yml 2017-10-24 10:21:20 -04:00
bin use Thor for CLI 2018-01-25 15:29:15 -05:00
docs more explicit documentation 2017-12-31 10:37:38 -08:00
lib test bin 2018-02-06 10:46:58 -05:00
script use Thor for CLI 2018-01-25 15:29:15 -05:00
spec test bin 2018-02-06 10:46:58 -05:00
vendor/choosealicense.com update vendored licenses 2018-01-02 10:49:35 -05:00
.bowerrc initial commit 2014-08-16 12:39:40 -04:00
.coveralls.yml add coveralls 2016-09-25 19:56:53 -04:00
.gitignore use Thor for CLI 2018-01-25 15:29:15 -05:00
.rspec convert tests to rspec 2016-09-25 18:42:36 -04:00
.rubocop.yml use Thor for CLI 2018-01-25 15:29:15 -05:00
.travis.yml Test against ruby 2.5.0 2018-01-09 15:28:00 +00:00
Gemfile drop active support 2016-12-27 15:09:50 -05:00
LICENSE.md Bump to 2017 2017-06-26 13:39:26 -04:00
licensee.gemspec use Thor for CLI 2018-01-25 15:29:15 -05:00

docs/README.md

Licensee

A Ruby Gem to detect under what license a project is distributed.

Build Status Gem Version Coverage Status PRs Welcome

The problem

  • You've got an open source project. How do you know what you can and can't do with the software?
  • You've got a bunch of open source projects, how do you know what their licenses are?
  • You've got a project with a license file, but which license is it? Has it been modified?

The solution

Licensee automates the process of reading LICENSE files and compares their contents to known licenses using a several strategies (which we call "Matchers"). It attempts to determine a project's license in the following order:

  • If the license file has an explicit copyright notice, and nothing more (e.g., Copyright (c) 2015 Ben Balter), we'll assume the author intends to retain all rights, and thus the project isn't licensed.
  • If the license is an exact match to a known license. If we strip away whitespace and copyright notice, we might get lucky, and direct string comparison in Ruby is cheap.
  • If we still can't match the license, we use a fancy math thing called the Sørensen–Dice coefficient, which is really good at calculating the similarity between two strings. By calculating the percent changed from the known license to the license file, you can tell, e.g., that a given license is 95% similar to the MIT license, that 5% likely representing legally insignificant changes to the license text.

Special thanks to @vmg for his Git and algorithmic prowess.

Installation

gem install licensee or add gem 'licensee' to your project's Gemfile.

Documentation

See the docs folder for more information. You may be interested in:

Semantic Versioning

This project conforms to semver. As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision. For example:

spec.add_dependency 'licensee', '~> 1.0'

This means your project is compatible with licensee 1.0 up until 2.0. You can also set a higher minimum version:

spec.add_dependency 'licensee', '~> 1.1'