API Documentation¶
Goodreads API Client¶
Goodreads API Client is a non-official Python client for Goodreads <http://www.goodreads.com/>.
This part of the documentation covers the interfaces of goodreads_api_client.
Main Interface¶
You’ll primarily use goodreads_api_client via the Client
it provides.
-
class
goodreads_api_client.
Client
(developer_key: str, developer_secret: str = None, base_url: str = None)[source]¶ Makes API Calls to the Goodreads API <https://goodreads.com/api>.
All other endpoints are provided through resource attributes on the Client
Resources¶
goodreads_api_client.resources¶
Holds classes for each Goodreads API Resource a user can interact with via the Goodreads API
-
class
goodreads_api_client.resources.
Author
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'author'¶
-
-
class
goodreads_api_client.resources.
Book
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'book'¶
-
-
class
goodreads_api_client.resources.
Comment
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
class
goodreads_api_client.resources.
Event
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'event'¶
-
-
class
goodreads_api_client.resources.
Group
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'group'¶
-
-
class
goodreads_api_client.resources.
ReadStatus
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'read_status'¶
-
-
class
goodreads_api_client.resources.
Recommendation
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
class
goodreads_api_client.resources.
Review
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'review'¶
-
-
class
goodreads_api_client.resources.
Series
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'series'¶
-
-
class
goodreads_api_client.resources.
Shelf
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
class
goodreads_api_client.resources.
Topic
(transport=None)[source]¶ Bases:
goodreads_api_client.resources.base.Resource
-
resource_name
= 'topic'¶
-
Lower-Level Classes¶
-
class
goodreads_api_client.transport.
Transport
(developer_key: str, developer_secret: str = None, base_url: str = None)[source]¶ Makes requests to Goodreads API and applies transform to response.
-
access_token_url
¶
-
gr
¶
-
req
(method: str = 'GET', endpoint: str = None, params: dict = None, data: dict = None, transform: str = 'xml', uses_oauth: bool = False)[source]¶
-
request_token_url
¶
-
session
¶
-
Exceptions¶
goodreads_api_client.exceptions¶
Contains goodreads_api_client’s exceptions.
-
exception
goodreads_api_client.exceptions.
GoodreadsApiClientException
[source]¶ Bases:
Exception
Base exception
-
exception
goodreads_api_client.exceptions.
OauthEndpointNotImplemented
[source]¶ Bases:
goodreads_api_client.exceptions.GoodreadsApiClientException
OAuth not yet supported by this library
-
exception
goodreads_api_client.exceptions.
ExtraApiPermissionsRequired
[source]¶ Bases:
goodreads_api_client.exceptions.GoodreadsApiClientException
Must contact Goodreads for extra perms to use endpoint