Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.06 KB

README.rst

File metadata and controls

76 lines (51 loc) · 2.06 KB

goodreads_api_client

A lightweight wrapper around the Goodreads API

PyPi page link -- version https://travis-ci.org/mdzhang/goodreads-api-client-python.svg?branch=master PyPi page link -- MIT license PyPi page link -- Python versions Code Climate RTD Docs

Installation

$ pip install goodreads_api_client

Usage

>>> import goodreads_api_client as gr
>>> client = gr.Client(developer_key='<YOUR_DEVELOPER_KEY>')
>>> book = client.Book.show('1128434')
>>> keys_wanted = ['id', 'title', 'isbn']
>>> reduced_book = {k:v for k, v in book.items() if k in keys_wanted}
>>> reduced_book
{'id': '1128434', 'title': 'The Last Wish (The Witcher, #1)', 'isbn': '0575077832'}

Resources

Rationale

There are a number of Goodreads API wrapper libraries out there, but most are either abandoned or the code is some combination of odd, undocumented, untested, or incomplete in its API coverage.

Contributing

To install locally

$ make install

And to test

$ make test