From 7eb8d13f2aa07db1c87a3186c7b871ffd8cc1e94 Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Sun, 1 Aug 2021 07:34:19 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - README.md Fixes: - Should read `except` rather than `exepct`. - Should read `oauthlib` rather than `ouathlib`. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9bf3195..7d72664 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ - [ApiResponse](#apiresponse), [StreamResponse](#streamresponse) objects - [Informative exceptions](#informative-exceptions) - [Easily customizable through subclassing](#customize-and-extend-through-subclassing) - - [Built on top of the excellent requests and requests-ouathlib libraries](#credits) + - [Built on top of the excellent requests and requests-oauthlib libraries](#credits) ### Installation @@ -73,7 +73,7 @@ for data in response.stream(): The concept behind `birdy` is so simple and awesome that it just had to be done, and the result is a super light weight and easy to use API client, that covers the whole Twitter REST API in just a little under 400 lines of code. -To achieve this, `birdy` relies on established, battle tested python libraries like `requests` and `requests-ouathlib` to do the heavy +To achieve this, `birdy` relies on established, battle tested python libraries like `requests` and `requests-oauthlib` to do the heavy lifting, but more importantly it relies on Python's dynamic nature to automatically construct API calls (no individual wrapper functions for API resources needed). This allows `birdy` to cover all existing Twitter API resources and any future additions, without the need to update `birdy` itself. Includes full support for both **OAuth1** (user) and **OAuth2** (application) authentication workflows. @@ -347,7 +347,7 @@ There are 4 types of exceptions in `birdy` all subclasses of base `BirdyExceptio `TwitterApiError` subclass - `TwitterRateLimitError` raised when rate limit for resource is reached, `TwitterApiError` subclass -`TwitterApiError` and `TwitterClientError` instances (exepct for access token retrieval errors) provide a informative error description which includes the resource URL and request method used (very handy when tracking errors in logs), also available is the following: +`TwitterApiError` and `TwitterClientError` instances (except for access token retrieval errors) provide a informative error description which includes the resource URL and request method used (very handy when tracking errors in logs), also available is the following: ```python exception.request_method # HTTP method used to make the request (GET or POST)