Manuel:Pywikibot/login.py

login.py est le programme Python qui connecte au système le compte utilisateur exécutant le pywikibot en utilisant les données qui se trouvent dans user-config.py .

Connexion en tant que robot

Les robots génèrent des résultats adaptés et nécessitent donc moins d'attention que ceux demandés par les autres modifications. Avec un compte utilisateur dédié pour les programmes des robots, les modifications faites de cette façon sont masquées sur la page typique des modifications récentes. Le statut de robot est donné par la communauté, si elle comporte déjà des dresseurs de robots.

Comment se déroule la connexion

Dans le fichier user-config.py il y a trois composants :

1. la langue : mylang
2. la famille : family ; indiquant le nom du wiki, tel que wikipedia ou wiktionary
3. le nom d'utilisateur : username ; pouvant être n'importe quel compte utilisateur, mais il est préférable qu'il soit enregistré comme exécutant des robots.

Pour se connecter à tous les projets / toutes les langues, figurant dans user-config.py, vous pouvez utiliser l'option -all, et si le même mot de passe est utilisé dans tous ces projets, il peut être combiné avec -pass pour que le programme ne vous le redemande pas à chaque site.

$ python pwb.py login -all -pass

vous connectera à tous les projets présents dans user-config.py, en utilisant le même mot de passe partout. Pour l'instant, l'option -pass n'est pas utilisable. (T102477) A la place vous devez utiliser le fichier des mots de passe. Créez un fichier avec un texte tel que '("en", "wikipedia", "User", "password")' (vous pouvez utiliser plusieurs lignes). Puis ajoutez dans votre fichier user-config.py la ligne password_file = "chemin_du_fichier_des_mots_de_passe" . Après cela Pywikibot utilisera les données de ce fichier pour se connecter. You should make user-config.py and password file unreadable for others (chmod 600 user-config.py) before adding secrets to it.

Déconnexion

$ python pwb.py login -logout

Connexion avec OAuth

Pywikibot permet de se connecter en utilisant l'authentification OAuth au lieu du mot de passe. La fonctionnalité OAuth nécessite un site avec Extension:OAuth installé et correctement configuré. OAuth est plus sécurisé (les mots de passe ne sont pas envoyés sur internet, il peut être invalidé à tout moment, et les droits de l'utilisateur robot peuvent être restreints) et de manière générale devrait être préféré par rapport au mode de connexion standard. Voir Manual:Pywikibot/OAuth pour la façon de l'utiliser (ne concerne pas login.py).

Si pour quelque raison vous souhaitez que votre robot se connecte en tant qu'application OAuth multi utilisateur (ce qui n'est pas recommandé mais par exemple d'anciens MediaWiki pourraient ne pas supporter les applications dédiées propriétaire), vous pouvez utiliser login.py pour cela, avec l'option -oauth. Le processus se déroule en plusieurs étapes :

1. Connectez-vous à meta avec le compte de votre robot. Créez une OAuth app dans Special:OAuthConsumerRegistration/propose si ce n'est pas déjà fait, et enregistrez la clé consommateur et le secret En attendant que T323849 soit résolu, seule la version 1.0a est prise en charge.
2. Exécutez python pwb.py login -oauth.
3. Saisir la clé consommateur OAuth
4. Saisir le mot de passe utilisateur OAuth
5. Authentifier l'utilisateur au travers de son navigateur web. Eventuellement copiez l'URL du terminal si le navigateur web ne s'ouvre pas automatiquement.
6. Entrez dans le terminal la chaîne de réponse à la requête quand l'authentication est réussie. Par exemple : oauth_verifier=xxx&oauth_token=yyy
7. Copiez/collez dans user-config.py les données générées d'entréee d'authentification.

-logout, -pass, -force, -pass:XXXX et -sysop ne sont pas compatibles avec -oauth.

Arguments globaux disponibles

Ces options remplaceront celles définies dans le fichier de configuration user-config.py .

Options globales

Paramètre	Description	Nom du paramètre de configuration dans user-config.py
-dir:PATH	Lit les données de configuration du robot dans le dossier donné par PATH, au lieu du dossier par défaut.
-config:fichier	Nom du fichier de configuration utilisateur. Default is user-config.py.	user-config.py
-lang:xx	Définit la langue du wiki sur lequel vous voulez travailler, en outrepassant la configuration de user-config.py. xx doit être le code de la langue (exemple : fr).	mylang
-family:xyz	Définit la famille du wiki sur lequel vous voulez travailler, tel que wikipedia, wikitionary, wikitravel... Cela outrepassera la configuration de user-config.py.	family
-user:xyz	Se connecter en tant qu'utilisateur xyz au lieu du nom d'utilisateur par défaut.	usernames
-daemonize:xyz	Rend le contrôle immédiatement au terminal et redirige la sortie standard (stdout) et la sortie en erreur (stderr) vers le fichier xyz (seulement utilisé pour les robots qui n'ont pas besoin de l'entrée standard (stdin) ).
-help	Affiche le texte d'aide.
-log	Active l'enregistrement des journaux de connexion, en utilisant le nom de fichier par défaut "nom_du_script-bot.log" dans le sous dossier logs.	log
-log:xyz	Active l'enregistrement des logs dans un fichier avec xyz pour nom.	logfilename
-nolog	Désactive l'enregistrement des logs (activé par défaut)
-maxlag	Définir le maxlag, en secondes. Reporte les modifications du robot lors de périodes de latence du serveur. La valeur par défaut est celle de config.py.	maxlag
-putthrottle:n -pt:n -put_throttle:n	Définit le temps minimum (en secondes) que le robot doit attendre entre deux enregistrements de pages.	put_throttle
-debug:item -debug	Active le fichier de log et incluant plus particulièrement les données de débogage pour l'élément item (1er cas) ou pour tous les éléments (2nd cas)	debug_log
-verbose -v	Demande au robot d'être plus verbeux ce qui peut aider pour le débogage.	verbose_output
-cosmeticchanges -cc	Inverse et outrepasse la valeur du paramètre cosmetic_changes de config.py ou de user-config.py (l'active si rien n'est mentionné dans ces fichiers). Tous les autre paramètres et restrictions restent inchangés.	cosmetic_changes
-simulate	Désactiver l'écriture sur serveur. Utile pour les tests et le débogage de nouveau code (si utilisé, ne fait aucun changement réel, mais montre ce qui aurait été changé).	simulate
-<variable de configuration>:n	Vous pouvez utilisez toutes les variables numériques de configuration données en tant qu'options et les modifier avec une ligne de commande.