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.

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

Add explicit documentation for Google storage `token_file` setting #549

Closed
teddywing opened this Issue Feb 8, 2017 · 5 comments

Comments

Projects
None yet
2 participants
@teddywing

teddywing commented Feb 8, 2017

version 0.14.1
Python 3.5.0
OS X

When trying to configure vdirsyncer for the first time using the google_calendar storage, I didn't set the token_file setting because I couldn't figure out what its value was meant to be.

I ended up doing an OAuth handshake manually to get an access token, which worked at first, until the token expired some time later.

After looking through the code, I realised that vdirsyncer actually does do the OAuth dance, but it was completely not obvious to me beforehand that I should just set token_file to an empty file and have the program do the work.

Can some extra documentation be added to 12c22f1#diff-fd40cf2be7711772de9d8316da038cceR136 (or to the program itself) to clearly explain what to set token_file to?

@untitaker

This comment has been minimized.

Member

untitaker commented Feb 8, 2017

@teddywing

This comment has been minimized.

teddywing commented Feb 10, 2017

Cool, thanks! I'll plan to draft a pull request this weekend.

@untitaker

This comment has been minimized.

Member

untitaker commented Feb 10, 2017

Great!

@untitaker

This comment has been minimized.

Member

untitaker commented Feb 16, 2017

Hey @teddywing any update on this?

@untitaker untitaker closed this in 7f38102 Feb 18, 2017

@untitaker untitaker removed the ready label Feb 18, 2017

@teddywing

This comment has been minimized.

teddywing commented Mar 19, 2017

Sorry I never got back to you on this. I've been a little overwhelmed with work and life recently. Thanks for picking this up and adding the docs!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment