A Ruby Gem to detect under what license a project is distributed.
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:
Copyright (c) 2015 Ben Balter), we’ll assume the author intends to retain all rights, and thus the project isn’t licensed.
Special thanks to @vmg for his Git and algorithmic prowess.
gem install licensee
To use licensee programmatically in your own Ruby project, add
gem 'licensee' to your project’s
To run licensee directly from source:
gem install bundler bundle install bundle exec bin/licensee
On Windows, the last line needs to include the Ruby interpreter:
bundle exec ruby bin\licensee
Licensee also comes with a Dockerfile if you prefer to run Licensee within a Docker container:
git clone https://github.com/licensee/licensee && cd licensee
docker build . --tag licensee
docker run licensee [COMMAND](see command line usage)
Example (detecting the license of
rails/rails on GitHub):
docker run licensee detect rails/rails --remote
See the docs folder for more information. You may be interested in:
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'