td-ameritrade-python-api icon indicating copy to clipboard operation
td-ameritrade-python-api copied to clipboard

Authentication-workflow section in readme is unclear

Open clarson99 opened this issue 3 years ago • 4 comments

The authentication-workflow section of the readme is unclear. It suggests running a file from VS Code, but it never says what file to run.

clarson99 avatar Nov 25 '21 03:11 clarson99

The python code to run is the code just under Usage:

# Import the client
from td.client import TDClient

# Create a new session, credentials path is required.
TDSession = TDClient(
    client_id='<CLIENT_ID>',
    redirect_uri='<REDIRECT_URI>',
    credentials_path='<PATH_TO_CREDENTIALS_FILE>'
)

# Login to the session
TDSession.login()

# Grab real-time quotes for 'MSFT' (Microsoft)
msft_quotes = TDSession.get_quotes(instruments=['MSFT'])

# Grab real-time quotes for 'AMZN' (Amazon) and 'SQ' (Square)
multiple_quotes = TDSession.get_quotes(instruments=['AMZN','SQ'])

alanoatwork avatar Nov 29 '21 18:11 alanoatwork

I think it would be helpful if you added something like 'The python code to run is the code just under Usage' to step 1 in https://github.com/areed1192/td-ameritrade-python-api#authentication-workflow

If you are reading the authentication workflow, it is not clear what code to run to trigger the oauth path.

clarson99 avatar Nov 29 '21 18:11 clarson99

You would need to appeal to a higher authority. I'm just an observer, not a developer for this library.

alanoatwork avatar Nov 30 '21 16:11 alanoatwork

Thank you @alanoatwork

akshaygulabrao avatar Jul 07 '22 20:07 akshaygulabrao