Sha256: 3b4231b7fd642da9f10c4a47e3ce24ab95053927f6efb905f5b25c86d44f8e97
Contents?: true
Size: 1.28 KB
Versions: 1
Compression:
Stored size: 1.28 KB
Contents
[![Code Climate](https://codeclimate.com/github/phereford/DPLibrary.png)](https://codeclimate.com/github/phereford/DPLibrary) # DPLibrary A simple ruby API wrapper around the [Digital Public Library of America](http://http://dp.la/info/developers/) ## Installation Add this line to your application's Gemfile: gem 'DPLibrary' And then execute: $ bundle Or install it yourself as: $ gem install DPLibrary ## Configuration 1. Acquire an API KEY from dp.la. To do this, simply run the following command from your terminal (replace YOUR_EMAIL with your email): ``` curl -v -XPOST http://api.dp.la/v2/api_key/YOUR_EMAIL@example.com ``` You will receive an email with an api key (should take less than 5 minutes). 2) Before making any api calls you will need to set your api key in your application. To do that, do the following: ``` DPLibrary.api_key = '<API KEY GOES HERE>' ``` If you are using a rails app, putting this in a config/initializer makes the most sense. ## Usages ## ToDo's * Write Tests * Write up usage documentation * Dry up lib files ## 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
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
DPLibrary-0.0.1 | README.md |