domcleal / spdx-licenses

SPDX license and identifier lookup
MIT License
14 stars 12 forks source link
ruby spdx spdx-licenses

spdx-licenses

A Ruby library around the SPDX license data, which provides a set of standard identifiers for open source licenses.

The data is maintained by SPDX. This library redistributes the licenses JSON file.

Installation

$ gem install spdx-licenses

or in your Gemfile:

gem 'spdx-licenses'

Versioning

This gem and its API is versioned according to semver. Minor releases may contain updates to the SPDX License List data.

spdx-licenses SPDX License List
1.0.0 1.2.0
1.1.0 2.4
1.2.0 3.1
1.3.0 3.11-54

Usage

> lic = SpdxLicenses.lookup('Apache-2.0')
> lic.id
"Apache-2.0"
> lic.name
"Apache License 2.0"
> lic.osi_approved?
true
> SpdxLicenses.lookup('Unknown')
nil

> SpdxLicenses.exist?('Apache-2.0')
true
> SpdxLicenses.exist?('Unknown')
false

License

Copyright (c) 2014-2021 Dominic Cleal. Distributed under the MIT license.