User

GoodreadsUser

GoodreadsUser is a BetterReads object for interfacing with user data from Goodreads.

Properties

  • gid: Goodreads user id (type: int)
  • user_name: Goodreads handle for the user (type: string)
  • name: User’s name (type: string)
  • link: URL for the user profile on Goodreads (type: string)
  • image_url: URL for the user’s profile image (type: string)
  • small_image_url: URL for a smaller version of the user’s profile image (type: string)

Key Functions and Usage

Get a user using the GoodreadsClient

>>> from betterreads.client import GoodreadsClient
>>> gc = GoodreadsClient(os.environ.get("GOODREADS_KEY"), os.environ.get("GOODREADS_SECRET"))
>>> user = gc.user(user_id=12345)
>>> user.name
u'Example McTesterson'
>>> user.user_name
u'FlyMcTesterson63'

list_groups

Get a list of all the GoodreadsGroups to which a user belongs

params:

  • page (int, default=1)

return: list of GoodreadsGroup objects

owned_books

Get a list of GoodreadsOwnedBook belonging to a user

params:

  • page (int, default=1)

return: list of GoodreadsOwnedBook objects

reviews

Get a list of a user’s GoodreadsReview

params:

  • page (int, default=1)

return: list of GoodreadsReview objects

shelves

Get a list of user’s GoodreadsUserShelf objects

params:

  • page (int, default=1)

return: list of GoodreadsUserShelf objects

per_shelf_reviews

Get a list of GoodreadsBook objects belonging to a particular GoodreadsUserShelf

params:

  • page (int, default=1)
  • per_page (int, default=200)
  • shelf_name (string, default=”read)

return: list of GoodreadsReview objects