Oauth workflows

[ib-lundgren]

Thought I'd migrate the bulk of the current README to an OAuth1 workflow section of the upcoming docs (#39) to make it more clear/inviting to new comers. Also added a parallel track to the docs section showing how to use OAuth1Session.

Threw together a quick guide showing OAuth2 WebApplication flow with OAuth2Session as well.

Obs! The README changes add links to requests-oauthlib.readthedocs.org which is not yet setup...

[Lukasa]

Yeah, I did think the README was a bit intense.

I think we should use this PR as an umbrella PR for getting the docs into shape.

[ib-lundgren]

It certainly was, served mainly as a crudge all in one guide awaiting docs setup.

Let me know if anything pops out that I should change. I find it easier to preview the file in "raw" mode. If not this should be good to merge once the links are confirmed working in the README and I've included the sections in index.rst.

[Lukasa]

I'm not entirely sure that we should merge this with the TODOs in place. I've enabled the RTD push hook, so the merge will trigger a docs rebuild with the TODOs in place. Not good. We should either replace them with text indicating 'coming later', fill them in, or remove the sections entirely. =)

[ib-lundgren]

Ah yea the todos, will try and write that up tomorrow morning. Also noticed
a minor thing in readme.

Keep suggestions coming :)
On May 22, 2013 7:58 PM, "Cory Benfield" notifications@github.com wrote:

I'm not entirely sure that we should merge this with the TODOs in place.
I've enabled the RTD push hook, so the merge will trigger a docs rebuild
with the TODOs in place. Not good. We should either replace them with text
indicating 'coming later', fill them in, or remove the sections entirely. =)

—
Reply to this email directly or view it on GitHubhttps://github.com//pull/46#issuecomment-18300024
.

[ib-lundgren]

Added a section on token refresh. Changed the other todo to outline available flows with a 'docs coming soon' note.

[Lukasa]

I think these subheaders should be actions, e.g. 'Define the token we will use through the three examples'.

[ib-lundgren]

While these docs certainly aren't perfect I thought they might do more good on readthedocs than sitting as a PR. Merging now and will improve incrementally instead. Same for #49.