Newer
Older
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
57
58
59
60
61
# KmRuby
Wraps the kmdata service and provides a CLI interface to it.
The API for this should presently be considered unstable. It is probable that it will be refactored
to wrap the JSON returns a little better and provide more entity specific accessors.
## Versioning
Minor version number changes can break the api
```
1.0, 1.1, 1.2, 1.3, etc.
```
but not point releases:
```
1.0.1, 1.0.2, 1.0.3, etc.
```
The major version number will always match up with the major kmdata version.
## Requirements
Ruby 2.0 or greater
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'kmruby', git: 'https://code.osu.edu/kmdata/kmruby.git'
```
And then execute:
$ bundle
Or install it yourself as:
$ git clone https://code.osu.edu/kmdata/kmruby.git
$ cd kmruby
$ rake install
## CLI Usage
See all commands:
$ kmruby
or
$ kmruby help [command]
to see help documentation for that command.