Merge branch 'master' into develop

This commit is contained in:
Sam Schott 2020-04-03 20:49:03 +01:00
commit da244279d6
4 changed files with 9 additions and 3 deletions

View File

@ -96,6 +96,8 @@ In the above case, this will be "Dropbox (Personal)" and "Dropbox (Work)".
## Contribute
A documentation for developers is available at
[https://maestral-dropbox.readthedocs.io](https://maestral-dropbox.readthedocs.io).
The following tasks could need your help:
- [ ] Packaging for non-macOS platforms.

View File

@ -13,4 +13,5 @@ This section gives an overview of Maestral's modules:
maestral.oauth <oauth>
maestral.errors <errors>
maestral.daemon <daemon>
maestral.cli <cli>
utils/index

View File

@ -5,6 +5,10 @@
(c) Sam Schott; This work is licensed under a Creative Commons
Attribution-NonCommercial-NoDerivs 2.0 UK: England & Wales License.
This module is responsible for authorization and token store in the system keyring. It
provides a higher level user interface and uses the OAuth 2 implicit grant flow from
:module:`utils.oauth_implicit` to perform the actual auth flow.
"""
# system imports
import logging
@ -26,7 +30,7 @@ logger = logging.getLogger(__name__)
class OAuth2Session:
"""
OAuth2Session provides OAuth2 login and token store. To authenticate with Dropbox,
OAuth2Session provides OAuth 2 login and token store. To authenticate with Dropbox,
run ``get_auth_url`` first and direct the user to visit that URL and retrieve an auth
token. Verify the provided auth token with ``verify_auth_token`` and save it in the
system keyring together with the corresponding Dropbox ID by calling ``save_creds``.

View File

@ -136,8 +136,7 @@ class DropboxOAuth2FlowImplicit(DropboxOAuth2FlowImplicitBase):
:meth:`finish` to prevent request forgery.
:param str url_state: Any data that you would like to keep in the URL through the
authorization process. This exact value will be returned to you by
:meth:`finish`.
authorization process.
:returns: The URL for a page on Dropbox's website. This page will let the user
'approve' your app, which gives your app permission to access the user's
Dropbox account. Tell the user to visit this URL and approve your app.