Manual:Pywikibot/OAuth


 * See also the more detailed Wikimedia-specific tutorial.

MediaWiki supports OAuth v1.0a and v2.0 as methods of authentication, but Pywikibot only supports v1.0a.

More information about OAuth support of MediaWiki: OAuth/For Developers

Requirements

 * The wiki where you want to use the bot needs Extension:OAuth installed and configured properly
 * Python library mwoauth
 * Register your bot. The OAuth tokens could be generated at . In case of a wikifarm, this needs to be the central wiki of the farm. In case of Wikimedia, it's m:Special:OAuthConsumerRegistration/propose. You need to check the option ""

Configuration
OAuth tokens are set in  of user-config.py: Use the site's host URL as the key of dict to specifying OAuth tokens. Also, Pywikibot supports wildcard '*' as the prefix of URL: Pywikibot will match the best OAuth tokens for requests.

You should make user-config.py unreadable for others before adding OAuth tokens/secrets to it.

Usage
When there's OAuth tokens matched in user-config.py, Pywikibot will disable password login automatically and use OAuth tokens for authentication instead.

NOTE: Using OAuth will block logout function.