blob: 9de0167d9ead5c4f824b8e8ab1ae821dc4e76222 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
# Spandx
A ruby API for interacting with the https://spdx.org software license catalogue.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'spandx'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install spandx
## Usage
To fetch the latest version of the catalogue data from [SPDX](https://spdx.org/licenses/licenses.json).
```ruby
catalogue = Spandx::Spdx::Catalogue.latest
catalogue.each do |license|
puts license.inspect
end
```
To load an offline copy of the data.
```ruby
path = File.join(Dir.pwd, 'licenses.json')
catalogue = Spandx::Spdx::Catalogue.from_file(path)
catalogue.each do |license|
puts license.inspect
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/cibuild` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mokhan/spandx.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
