An open API service indexing awesome lists of open source software.

https://github.com/speciesfilegroup/grbio

An unofficial Ruby gem wrapper on http://grbio.org to faciliate translate to local use/integration.
https://github.com/speciesfilegroup/grbio

Last synced: 8 months ago
JSON representation

An unofficial Ruby gem wrapper on http://grbio.org to faciliate translate to local use/integration.

Awesome Lists containing this project

README

          

# Grbio

Grbio is an unofficial set of utilties that wrap the CSV data available at http://grbio.org. It provides simple methods to download the data, and some methods to examine it. They also include a template generator to turn the data into Rails migrations. A Rails engine dervied from this approach is forthcoming elsewhere.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'grbio'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install grbio

## Usage

See also specs.

```
require 'grbio'
Grbio.download_resources # => downloads to /tmp/*.csv

Grbio::RailsMigration.institutions_migration # => a Rails migration, with column header nastiness fixed
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/SpeciesFileGroup/grbio.

## License

The gem is available as open source under the terms of the [University of Illinois/NCSA Open Source License](http://opensource.org/licenses/MIT).