Authentication can be accomplised through either a three-legged oAuth flow or via xAuth where a username and password are exchanged directly for a user token and secret.

That token and secret is then used to sign requests on behalf of the user. A user’s credentials should never be stored and are not needed. You should favor a three legged auth flow if your application can support it. For testing purposes, or for applications where a redirect flow is prohibitive, you can use the xauth class to generate the token pair needed to sign Reader API requests.

Client Documentation

class readability.auth.xauth

Returns an OAuth token tuple that can be used with clients.ReaderClient.

  • base_url_template – Template for generating Readability API urls.
  • consumer_key – Readability consumer key, otherwise read from READABILITY_CONSUMER_KEY.
  • consumer_secret – Readability consumer secret, otherwise read from READABILITY_CONSUMER_SECRET.
  • username – A username, otherwise read from READABILITY_USERNAME.
  • password – A password, otherwise read from READABILITY_PASSWORD.