mirrors
/
licensee
mirror of https://github.com/licensee/licensee.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
700 Commits 19 Branches 104 Tags 46 MiB
Ruby 98.8%
Shell 1%
Dockerfile 0.2%
Go to file
Ben Balter 437b0754c2
disambiguate support 		2017-07-17 10:38:15 -04:00
.github Create stale.yml 2017-04-06 13:25:22 -04:00
bin add diff script/ 2017-06-30 16:33:48 -04:00
docs disambiguate support 2017-07-17 10:38:15 -04:00
lib typos 2017-07-05 14:57:18 -07:00
script correct rubocop offenses 2017-06-30 16:39:22 -04:00
spec Merge branch 'master' into ancestor-search 2017-07-05 12:12:11 -04:00
vendor/choosealicense.com update vendored licenses 2017-06-22 09:36:00 -04: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 expose license rules 2016-11-11 15:02:45 -05:00
.rspec convert tests to rspec 2016-09-25 18:42:36 -04:00
.rubocop.yml add diff script/ 2017-06-30 16:33:48 -04:00
.travis.yml Merge branch 'master' into ncndignore 2017-02-21 12:00:16 -05: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 fix rubocop offenses and drop Ruby < 2.1 support 2017-01-22 13:38:41 -05:00

docs/README.md

Licensee

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

Build Status Gem Version Coverage Status

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'