Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Fix a few typos #41

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Fix a few typos #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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)
Expand Down