Skip to content

Commit 9bbd045

Browse files
snowskeletonmkb79
andauthoredAug 22, 2022
Grammar check on authorization.rst (#105)
* Update authorization.rst Minor grammar and syntax tweaks. * Update authorization.rst fix spelling errors Co-authored-by: mkb79 <[email protected]>
1 parent f213edf commit 9bbd045

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed
 

‎docs/source/auth/authorization.rst

+22-23
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ Information
66
===========
77

88
Clients are authorized using OpenID in Authorization Code Flow with PKCE.
9-
Once a client has successfully authorized to Amazon, they are get an
9+
Once a client has successfully authorized to Amazon, they receive an
1010
`authorization code` for device registration to Audible/Amazon.
1111

1212
.. _authorization:
1313

1414
Authorization
1515
=============
1616

17-
For an example how to authorize please take a look at :ref:`hello_library`.
17+
For an example on authorization, please take a look at :ref:`hello_library`.
1818

1919
CAPTCHA
2020
-------
@@ -24,7 +24,7 @@ CAPTCHA
2424
Init cookies added to login function to prevent CAPTCHAs in most cases.
2525

2626
Authorization requires answering a CAPTCHA in some cases. By default Pillow is used
27-
to show captcha and an user prompt will be provided to enter your answer, which
27+
to show captcha and a user prompt will be provided to enter your answer, which
2828
looks like::
2929

3030
Answer for CAPTCHA:
@@ -48,7 +48,7 @@ external service), like so::
4848
2FA (OTP Code)
4949
--------------
5050

51-
If two-factor authentication (2FA) is activated a user prompt will be provided
51+
If two-factor authentication (2FA) is activated, a user prompt will be provided
5252
using `input` to enter your one time password (OTP), which looks like::
5353

5454
"OTP Code: "
@@ -66,7 +66,7 @@ A custom callback can be provided, like so::
6666
otp_callback=custom_otp_callback
6767
)
6868

69-
If you have to enter a otp often and don't care about security you can use
69+
If you have to enter an OTP often and don't care about security, you can use
7070
the `pyotp <https://pypi.org/project/pyotp/>`_ package with a custom callback
7171
like so::
7272

@@ -78,14 +78,14 @@ like so::
7878
otp = TOTP(secret)
7979
return str(otp.now())
8080

81-
Another approach for submit the OTP is to append the current OTP to the password.
81+
Another approach is to append the current OTP to the password.
8282

8383
CVF Code
8484
--------
8585

86-
If 2FA is deactivated and amazon detects some security risks (too many logins
86+
If 2FA is deactivated and Amazon detects some security risks (too many logins
8787
in short times, etc.) you will be asked for a verify code (CVF). In that case,
88-
amazon sends you a Mail or SMS with a code, you have to enter here::
88+
amazon sends you an email or SMS with a code, which you enter here::
8989

9090
"CVF Code: "
9191

@@ -105,15 +105,13 @@ A custom callback can be provided, like so::
105105
Approval Alert
106106
--------------
107107

108-
Some users report, that authorize to audible gives them an approval alert and
109-
you will receive an email from amazon. Since audible v0.5 you will get an user
110-
prompt which looks like::
108+
Some users report that trying to authorize with audible gives them an approval alert and an email from amazon.
109+
Since audible v0.5 you will get a user prompt which looks like::
111110

112111
"Approval alert detected! Amazon sends you a mail."
113112
"Please press enter when you approve the notification."
114113

115-
Please approve the amazon email notification and press enter (or another key)
116-
to proceed.
114+
Please approve the email/SMS, and press any key to continue.
117115

118116
.. versionadded:: 0.5.1
119117

@@ -124,7 +122,7 @@ A custom callback can be provided, like so::
124122
def custom_approval_callback():
125123
126124
# You can let python check for the received Amazon mail and
127-
# open the approval link. The login function wait until
125+
# open the approval link. The login function waits until
128126
# the callback function is executed. The returned value will be
129127
# ignored by the login function.
130128
@@ -147,21 +145,21 @@ To handle the login with a external browser or program logic you can do the foll
147145
148146
auth = audible.Authenticator.from_login_external(locale=COUNTRY_CODE)
149147

150-
By default, this code print out the login url for the selected country code. Now you have
151-
to copy and paste this code into a web browser (or a custom program) and authorize yourself.
148+
By default, this code prints out the login url for the selected country code.
149+
Paste this url into a web browser or use it programatically to authorize yourself.
152150
You have to enter your credentials two times (because of missing init cookies).
153-
On first time, the password can be a random one.
154-
On second time, you have to solve a captcha before you can submit the login form with your
155-
correct password.
156-
After authorize successfully you will end in an error page (not found). This is correct.
157-
Please copy the url from the address bar from your browser and paste the url to the input
158-
field of the python code. This url looks like
151+
First time, the password can be a random one.
152+
Second time, you have to solve a captcha before you can submit the login form and
153+
you must use your correct password.
154+
After loggin in, you will end in an error page (not found). This is correct.
155+
Copy the url from the address bar from your browser and paste the url into the input
156+
field of the python code. It will look something like
159157
"https://www.amazon.{domain}/ap/maplanding?...&openid.oa2.authorization_code=..."
160158

161159
.. note::
162160
If you have `playwright <https://pypi.org/project/playwright/>`_ installed and
163161
use the default ``login_url_callback``, a new browser is opened, where you can
164-
authorize to your account,
162+
authorize to your account.
165163

166164
.. note::
167165

@@ -187,3 +185,4 @@ A custom callback can be provided (for example open the url in a webbrowser dire
187185
login_url_callback=custom_login_url_callback
188186
)
189187

188+

0 commit comments

Comments
 (0)
Please sign in to comment.