Python 3 wrapper for Goodreads API
|Build Status| |Coverage Status| |Documentation Status| |Primary Code Style| |Secondary Code Style|
This package provides a Python interface for the
Goodreads API <http://goodreads.com/api>__. Using it, you can do pretty much
anything that Goodreads allows through their public API.
This package is largely Python 2 compatible, but is only officially supported for Python 3.
BetterReads is an expansion of the goodreads2 package available on PyPi. That package is no longer maintained and needed some updates to be usable. The name is just cheeky and cute, and not to imply that this project is substantially better than any other project. Someday I hope it's succeeded by a Python package called BestReads.
Major updates in this new project:
- Use https for Oauth - goodreads now requires this and previous packages' Oauth requests always fail
- Add convenience method to get all of a user's reviews for a specific shelf
- Some opinionated development changes. For example
- No longer making live API calls in unit tests
black code style <https://github.com/ambv/black>__ across the board
- More robust
This package depends on the following packages:
They can be installed using
sudo pip install -r requirements.txt
If you want to contribute to this package, you will need to install the packages in ``requirements-dev.txt` as well.
To install, run the following command from the top-level package directory.
sudo python setup.py install
The first thing is to request an API key from Goodreads
here <https://www.goodreads.com/api/keys>__. Once you have it, you can
create a client instance to query Goodreads.
.. code:: python
from goodreads import client gc = client.GoodreadsClient(<api_key>, <api_secret>)
To access some of the methods, you need
.. code:: python
access_token_secret are different
from developer key and secret. For the development step, you can call
the same function with no parameters to get authorization. It will open
a URL pointing a Goodreads page for OAuth permission. For your
application, you can direct the user to that particular URL, ask them
to authorize your app and save the returning
access_token_secret in your database.
This package provides a Python interface for most Goodreads API methods. Here are a few examples demonstrating how to access data on Goodreads.
Let's access the first book added to Goodreads! It is the book with id 1. .. code:: python book = gc.book(1) Once you have the ``GoodreadsBook`` instance for the book, you can access data for the queried book. .. code:: python >>> book.title u'Harry Potter and the Half-Blood Prince (Harry Potter, #6)' >>> authors = book.authors >>> authors.name u'J.K. Rowling' >>> book.average_rating u'4.49' Authors
You can get information about an author as well.
.. code:: python
>>> author = gc.author(2617) >>> author.name u'Jonathan Safran Foer' >>> author.works_count u'13' >>> author.books [Extremely Loud and Incredibly Close, Everything Is Illuminated, Eating Animals, Tree of Codes, Everything is Illuminated & Extremely Loud and Incredibly Close, The unabridged pocketbook of lightning, The Future Dictionary of America, A Convergence of Birds: Original Fiction and Poetry Inspired by Joseph Cornell, New American Haggadah, The Sixth Borough]
User data can be retrieved by user id or username. .. code:: python >>> user = gc.user(1) >>> user.name u'Otis Chandler' >>> user.user_name u'otis' >>> user.small_image_url u'http://d.gr-assets.com/users/1189644957p2/1.jpg' Groups
Let's find a group discussing Python and get more information about it.
.. code:: python
>>> g = gc.find_groups("Python") >>> g = groups >>> g['title'] u'The Computer Scientists' >>> group = gc.group(g['id']) >>> group.description u'Only for Committed Self Learners and Computer Scientists Who are Starving for Information, and Want to Advance their Skills Through: Reading, Practicing and Discussion Computer Science and Programming Books.'
Goodreads API also allows to list events happening in an area. .. code:: python >>> events = gc.list_events(21229) >>> event = events >>> event.title u'Books and Cocktails' >>> event.address u'120 N. Front St.' >>> event.city u'Wrightsville' Documentation ------------- Read more about this package `here <http://goodreads.readthedocs.org/en/latest/>`__. Contribution ------------ If you find an API method that is not supported by this package, feel free to create a Github issue. Also, you are more than welcome to submit a pull request for a bug fix or additional feature. For more detail on contributing to this project and setting up your local dev environment, check out `our contribution guide <CONTRIBUTING.rst>`__. License ------- `MIT License <http://opensource.org/licenses/mit-license.php>`__ Acknowledgment -------------- Thanks to `Paul Shannon <https://github.com/paulshannon>`__ and `Sefa Kilic <https://github.com/sefakilic>`__ for providing 'goodreads' package at PyPI, and to `Tatiana <https://github.com/tatianass>`__ and `Rehan Khwaja <https://github.com/rkhwaja>`__ for continuing the project as goodreads2. BetterReads couldn't exist without all of you. .. |Build Status| image:: https://travis-ci.org/thejessleigh/betterreads.svg?branch=master :target: https://travis-ci.org/thejessleigh/betterreads :alt: Build Status .. |Coverage Status| image:: https://coveralls.io/repos/github/thejessleigh/betterreads/badge.svg?branch=master :target: https://coveralls.io/github/thejessleigh/betterreads?branch=master :alt: Coverage Status .. |Documentation Status| image:: https://readthedocs.org/projects/betterreads/badge/?version=latest :target: http://betterreads.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |Primary Code Style| image:: https://camo.githubusercontent.com/28a51fe3a2c05048d8ca8ecd039d6b1619037326/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64652532307374796c652d626c61636b2d3030303030302e737667 :target: https://github.com/ambv/black :alt: Primary Code Style - Black .. |Secondary Code Style| image:: https://img.shields.io/badge/code_style-prettier-ff69b4.svg :target: https://github.com/prettier/prettier :alt: Secondary Code Style - Prettier
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size betterreads-0.4.1-py3-none-any.whl (15.7 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size betterreads-0.4.1.tar.gz (14.8 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for betterreads-0.4.1-py3-none-any.whl