wikimelon

Wikimelon

Wikimelon is a lightweight Ruby wrapper on the Wikidata API. Code follow the spirit/approach of the Gem serrano, and indeed much of the wrapping utility is copied 1:1 from that repo, thanks @sckott.

Installation

Add this line to your application's Gemfile:

gem 'wikimelon'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install wikimelon

Usage

Queries

Run a Wikidata query:

query = "
SELECT ?human ?humanLabel ?zoobank WHERE {
  ?human wdt:P31 wd:Q5.
  ?human wdt:P2006 ?zoobank.
  SERVICE wikibase:label { bd:serviceParam wikibase:language "[AUTO_LANGUAGE],en". }
} LIMIT 100 OFFSET 0
"
Wikimelon.query(query) #  => MultiJson object

Entities

Fetch data on an item:

entity_id = "Q13"
Wikimelon.entity(entity_id) #  => MultiJson object

Fetch data on a property:

entity_id = "P31"
Wikimelon.entity(entity_id) #  => MultiJson object

Fetch data on an entity with a specific revision ID:

entity_id = "Q13"
Wikimelon.entity(entity_id, revision_id: 109) #  => MultiJson object

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, update the CHANGELOG.md, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

The gem is available as open source under the terms of the MIT license. You can learn more about the MIT license on Wikipedia and compare it with other open source licenses at the Open Source Initiative.

Code of Conduct

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