RKD (unofficial)

This is the RKD gem. A gem that helps ruby-developers to interact with the vast collection of data from the RKD in a ruby-friendly manner.

Installation

Add this line to your application's Gemfile:

gem 'rkd'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rkd

Usage

Searching for an artist:

artists = RKD::Artist.search("Rembrandt") # returns array of results
artist = artists.first # best hit :)
artist.enrich! # enrich the data from the sparql endpoints

Just getting a single artist

RKD::Artist.find(123)

Retrieving data

Just browse the methods:

artist.birth_place.geoname_id
artist.performances.work.first.place.lat, artist.performances.work.first.place.lon
artist.performances.work.first.place.geoname_id
artist.performances.work.first.date_span.begin # returns a RKD::ImpreciseDate or Date
artist.performances.study.map{|s| s.label}
artist.types # []
artist.name_variants

It is all powered by a combination of a ElasticSearch and SPARQL API call, but now without the hassle of making these queries manually.

Development

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

Contributing

Bug reports and pull requests are welcome on GitHub at https://gitlab.com/murb/rkd/. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Rkd project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.