Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Collect gem licenses.
Ruby
Branch: master
Failed to load latest commit information.
common_licenses Add additional common licenses and match-able license labels
lib Preparing for next development iteration, 0.2.1.
spec Rubocop insists that I shorten lines
tasks Replace :unknown with 'unknown' so that _all_ missing licenses are re…
.gitignore Gem skeleton.
.rspec Normalize known license names.
.rubocop.yml Upgraded RSpec, added RuboCop.
.rubocop_todo.yml Added gem:licenses:csv Rake task.
.travis.yml
CHANGELOG.md Preparing for next development iteration, 0.2.1.
CONTRIBUTING.md Added CHANGELOG, CONTRIBUTING.
Gemfile Use HTTPS for rubygems.org
LICENSE Rudimentary implementation 0.1.0.
README.md Added gem:licenses:csv Rake task.
Rakefile Load/install Rake tasks via Gem::Licenses.install_tasks.
VERSION Preparing for next development iteration, 0.2.1.
gem-licenses.gemspec

README.md

Gem-Licenses

Build Status

Gem-licenses is an attempt to collect license information from project's gems. Similar to 3licenses.

Motivation

The overwhelming majority of 3rd party licenses require the application that uses them to reproduce the license verbatim in an artifact that is installed with the application itself. For instance, the BSD license states the following.

“Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.”

Are you currently copying individual license.txt files "by hand" or are you including license text in your documentation with copy/paste? This project aims at improving this situation.

Usage

Include gem-licenses in your project's Gemfile.

group :development, :test do
  gem 'gem-licenses'
end

Install Rake tasks from Rakefile.

Gem::Licenses.install_tasks

To list licenses try the following Rake task.

rake gem:licenses

To write a CSV file of gems + licenses.

rake gem:licenses:csv['licenses.csv']

Contributing

See CONTRIBUTING.

License

This project is licenced under the MIT license, see LICENSE for details.

Copyright

Copyright (c) Daniel Doubrovkine, 2011-2015, Artsy, Inc.

Something went wrong with that request. Please try again.