From cc473caf06b28de4c60aca1718da76862cbf7739 Mon Sep 17 00:00:00 2001 From: Apurva Chitnis Date: Mon, 26 Aug 2019 23:35:20 +0100 Subject: [PATCH] improve redirect wording and fix minor bugs --- docs/index.rst | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 6283ed8..91fd31e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -99,16 +99,18 @@ generate an authorization token that indicates that the user has granted permission for your application to perform the given task. You will need to register your app to get the credentials necessary to make authorized calls. -Even if your script does not have an accessible URL you need to specify one -when registering your application where the spotify authentication API will -redirect to after successful login. The URL doesn't need to work or be -accessible, you can specify "http://localhost/", after successful login you -just need to copy the "http://localhost/?code=..." URL from your browser -and paste it to the console where your script is running. +Even if your script does not have an accessible URL you will need to specify one +when registering your application which the Spotify authentication server will +redirect to after successful login. The URL doesn't need to be publicly +accessible, so you can specify "http://localhost/", and after succesfully +authenticating your app, you can simply copy the +"http://localhost/?code=..." URL from your browser and paste it to the +console where your script is running. Register your app at `My Applications -`_. +`_ and register the +redirect URI mentioned in the above paragragh. *spotipy* supports two authorization flows: @@ -127,7 +129,6 @@ To support the **Authorization Code Flow** *Spotipy* provides a utility method ``util.prompt_for_user_token`` that will attempt to authorize the user. You can pass your app credentials directly into the method as arguments:: - util.prompt_for_user_token(username,scope,client_id='your-app-redirect-url',client_secret='your-app-redirect-url',redirect_uri='your-app-redirect-url') or if you are reluctant to immortalize your app credentials in your source code, you can set environment variables like so:: @@ -140,7 +141,7 @@ Call ``util.prompt_for_user_token`` method with the username and the desired scope (see `Using Scopes `_ for information about scopes) and credentials. This will coordinate the user authorization via -your web browser and ask for the SPOTIPY_REDIRECT_URI you were redirected to +your web browser and callback to the SPOTIPY_REDIRECT_URI you were redirected to with the authorization token appended. The credentials are cached locally and are used to automatically re-authorized expired tokens.