Flask blueprint to connect to a MediaWiki OAuth server
Project description
flask-mwoauth
Flask blueprint to run OAuth against MediaWiki's extension:OAuth.
Note: The python-mwoauth library is more actively maintained, and also contains basic flask support. Please consider using
python-mwoauth
directly if it supports your use case.
The blueprint adds these uris:
- /login - runs the OAuth handshake and returns the user to /
- /login?next=/someurl will return the user to /someurl
- /logout - clears the users' access tokens
- /logout?next=/someurl will return the user to /someurl
- /oauth-callback - callback from MW to finish the handshake
The users' OAuth key and secret are stored in the session.
In addition, flask-mwoauth adds a few convenience functions:
-
get_current_user(cached=True)
reports who the current user is. To confirm the user is still logged in (e.g. tokens have not been revoked), call it with cached=False. -
request(api_query)
submits an request through the API, using the users' access tokens. For instance,
result = request({'action': 'query', 'meta': 'userinfo'})
fetches https://www.mediawiki.org/w/api.php?action=query&meta=userinfo and returns the result as Python dict, e.g.
{u'batchcomplete': u'', u'query': {u'userinfo': {u'id': 31344, u'name': u'Valhallasw'}}}
If you are authorized to access other wikis (e.g. en.wikipedia.org, although you authorized via mediawiki.org), you can run a request there using
result = request({'action': 'query', 'meta': 'userinfo'}, url='https://en.wikipedia.org/w/api.php')
For more information on using the api, please check the api documentation at https://www.mediawiki.org/wiki/API:Main_page
The example app
An example app is implemented in demo.py
.
- Go to https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose and fill in the following values:
- Application name: test app
- Application description: test app for flask-mwoauth
- OAuth "callback" URL: http://localhost:5000/oauth-callback
- Contact email address:
- Leave all other values default.
- Click 'Propose consumer'. You now get a message stating
Your OAuth consumer request has been received.
You have been assigned a consumer token of and a secret token of . Please record these for future reference."
-
Then
$ python setup.py develop $ python demo.py NOTE: The callback URL you entered when proposing an OAuth consumer probably did not match the URL under which you are running this development server. Your redirect back will therefore fail -- please adapt the URL in your address bar to http://localhost:5000/oauth-callback?oauth_verifier=...etc Consumer key: <the consumer key you got> Consumer secret: <the consumer secret you got>
You may need to re-enter the key and secret if the app reloads.
-
Go to http://localhost:5000/ and click 'login'.
Projects using flask-mwoauth
To see how flask-mwoauth is used in applications, you can take a look at:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file flask-mwoauth-0.4.76.tar.gz
.
File metadata
- Download URL: flask-mwoauth-0.4.76.tar.gz
- Upload date:
- Size: 8.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.1.0 requests-toolbelt/0.9.1 tqdm/4.33.0 CPython/3.6.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3723f251712e7cfe000d3ac06c51e970d59ab776ed75300dea910248e39e7de8 |
|
MD5 | 67370de1207600c25659d17426ece95a |
|
BLAKE2b-256 | f83e803af56b230b7343b0d81b5d37a6b6349b18cd8fce7da7a6155cd1ed240a |