jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154287?usp=email )
Change subject: Doc: Add a table of login methods
......................................................................
Doc: Add a table of login methods
Bug: T396204
Change-Id: I8a087096dba7e0ba2829ded2e052ae83ddc591f1
---
M docs/api_ref/login.rst
1 file changed, 55 insertions(+), 0 deletions(-)
Approvals:
jenkins-bot: Verified
Xqt: Looks good to me, approved
diff --git a/docs/api_ref/login.rst b/docs/api_ref/login.rst
index c5d12cf..14d4998 100644
--- a/docs/api_ref/login.rst
+++ b/docs/api_ref/login.rst
@@ -2,5 +2,60 @@
:mod:`login` module
*******************
+Pywikibot supports several login methods to authenticate with
+MediaWiki-based wikis. Here is an overview of Pywikibot login methods:
+
+.. list-table::
+ :header-rows: 1
+ :align: left
+
+ * - Method
+ - Secure
+ - Auto login
+ - Use Cases / Notes
+ - API References
+ * - BotPassword
+ - ✅✅
+ - ✅
+ - Preferred for most bots; safe, scoped credentials
+ - :class:`login.ClientLoginManager` :class:`login.BotPassword`
+ * - OAuth
+ - ✅✅
+ - ✅
+ - For complex bots, shared apps, or broader API access
+ - :class:`login.OauthLoginManager`
+ * - 2FA Login
+ - ✅✅
+ - ❌
+ - 2FA support e.g for interactive admin scripts
+ - :class:`login.ClientLoginManager`
+ * - Login with email token
+ - ✅
+ - ❌
+ - Email token login e.g. for semi-automated bots or user supporting
scripts
+ - :class:`login.ClientLoginManager`
+ * - Manual login
+ - ❌
+ - ❌
+ - No longer supported on Wikimedia sites
+ - :class:`login.ClientLoginManager`
+ * - Cookie-based login
+ - ➖
+ - ✅
+ - Session reuse ogin; not a standalone method
+ - :class:`comms.http.PywikibotCookieJar`
+ * - CentralAuth SUL login
+ - ➖
+ - ✅
+ - Automatic across Wikimedia projects once logged in
+ -
+
+.. seealso::
+ - :mod:`pywikibot.scripts.login`
+ - :mod:`pywikibot.scripts.generate_user_files`
+ - :manpage:`BotPasswords`
+ - :api:`Login`
+
+
.. automodule:: login
:synopsis: Library to log the bot in to a wiki account
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1154287?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: I8a087096dba7e0ba2829ded2e052ae83ddc591f1
Gerrit-Change-Number: 1154287
Gerrit-PatchSet: 1
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
