/open_philology_client

Client for the APIs of open philology projects like Perseus and Perseids.

Primary LanguageRubyMIT LicenseMIT

OpenPhilologyClient

Build Status Coverage Status Dependency Status

Client for the APIs of open philology projects like Perseus and Perseids.

Installation

Add this line to your application's Gemfile:

gem 'open_philology_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install open_philology_client

Usage

Morphology

morphology = OpenPhilologyClient::Morphology.new
morphology.analyse_word("latin_word_to_analyse")

To provide a custom base url use:

morphology = OpenPhilologyClient::Morphology.new('base url')

The return value of analyse_word is a nested dictionary. If the word is not found nil is returned.

The documentation for the morphological analysis service can be found here.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request