Manuel:Pywikibot/Installation

This page is a translated version of the page Manual:Pywikibot/Installation and the translation is 100% complete.
Cette page vous aidera à débuter avec Pywikibot, soit sur votre ordinateur, sur Toolforge, ou en utilisant PAWS: un shell web.
Sous PAWS

PAWS : un shell web est la manière la plus simple pour débuter avec Pywikibot. Aucune installation n'est nécessaire, tout passe par une page Web et un terminal en ligne pour envoyer les commandes.

Sur votre ordinateur

Vous trouverez ci-dessous un manuel pour vous aider à installer et à utiliser Pywikibot sur votre ordinateur. Il y a quatre étapes principales dans ce processus :

"Toolforge" fournit une infrastructure de type cloud sur les serveurs Wikimédia, permettant d'y faire fonctionner des robots d'une manière continue ou en suivant une programmation temporelle.

Installer Python

Télécharger Python et l'installer à partir de https://www.python.org/downloads/.

Si vous avez déjà Python d'installé, la commande python --version permet d'afficher sa version dans le terminal et de vérifier qu'il est à jour. Pour savoir si Python version 3 ou supérieur est installé, exécutez python3 --version dans une console.

Ubuntu 19.04 et ultérieurs sont livrées avec les versions 2 et 3 installées. Python v2 s'exécute par défaut en utilisant la commande de terminal python; pour utiliser la v3, utilisez la commande python3.

Python 3.7 ou supérieur est nécessaire actuellement pour exécuter le robot. Sur Windows, n'oubliez pas de modifier la variable d'environnement PATH pour que Python et pip fonctionnent correctement.

Installer les dépendances

Des paquets supplémentaires sont nécessaires pour exécuter Pywikibot. Exécutez la commande suivante pour installer ces paquets :

$ python -m pip install "requests>=2.20.1"
$ python -m pip install "mwparserfromhell>=0.5.2"
$ python -m pip install packaging

Pour Python 3.7, un package supplémentaire est nécessaire. Installez-le avec:

$ python -m pip install importlib_metadata

Un parseur de marquage MediaWiki alternatif peut être installé avec:

$ python -m pip install "wikitextparser>=0.47.5"

See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start

Installer Pywikibot

$ python -m pip install pywikibot

Si vous utilisez pip, utilisez pwb à la place de python pwb.py dans les exemples ci-dessous.

Télécharger la version courante de Pywikibot stable : .tar.gz, .zip.

Décompresser le fichier téléchargé, par exemple dans ~/pywikibot ou dans %USERPROFILE%\pywikibot.

Vous pouvez, d'une manière similaire, récupérer la dernière version avec Git ou un client SVN à partir de Gerrit, voir Manuel:Pywikibot/Gerrit . C'est la manière de faire recommandée pour utiliser Pywikibot, pour les opérateurs actifs et pour les développeurs.

D'autres versions sont disponibles sur https://pywikibot.toolforge.org/.

Mettre à jour Pywikibot

Maintenez l'environnement de développement de vos robots à jour. De nouvelles versions sont livrées en continu et sont disponibles au même endroit.

Si vous utilisez une version de Git ou de SVN, vous pouvez ignorer cette note. Sinon, soyez conscient que, avant d'installer une nouvelle version, il vous appartient de sauvegarder vos fichiers et vos scripts de configuration (user-config.py, les fichiers de famille, ou les scripts adaptés que vous auriez pu créer ou modifier, ainsi que les fichiers de dump XML courants que vous utilisez pour un wiki).

Décompresser la nouvelle version en remplaçant l'ancienne et ses fichiers.

Configurer Pywikibot

Ouvrez une fenêtre Terminal sur les systèmes de type Unix (Linux/BSD/Solaris) ou une fenêtre de commandes (cmd) sous Windows (cliquez sur le bouton Windows, tapez « cmd.exe », puis faites « Exécuter en tant qu'administrateur » ; sinon, Windows peut vous interdire de modifier des fichiers et des répertoires dans le but de protéger vos données), et modifiez le répertoire dans lequel vous avez décompressé Pywikibot :

Famille Unix (Linux/BSD/Solaris) :
$ cd ~/core
Windows :
$ c:
$ cd "%USERPROFILE%\pywikibot"

Remplacer l'emplacement par celui où vous avez décompressé Pywikibat.

Continuer avec la commande suivante pour générer le fichier de configuration utilisateur :

$ python pwb.py generate_user_files

Suivez les indications pour configurer Pywikibot.

Enfin, lancez la commande suivante pour vous connecter à votre wiki :

$ python pwb.py login

Utilisation sur des Wikis tiers

Pywikibot est pré-configuré pour fonctionner sur un grand nombre de wikis, mais il est possible que le vôtre ne figure pas sur la liste. Voir Manual:Pywikibot/Use on third-party wikis pour la démarche permettant de configurer Pywikibot sur votre wiki.

Plus d'options de configuration

Pywikibot propose de nombreux paramètres de configuration pour modifier le comportement de votre robot. Vous pouvez modifier ces paramètres dans le fichier « user-config.py ». Tous les paramètres utilisables sont listés sur config.py.

Configuration du serveur mandataire (proxy)

Pywikibot s'appuie sur les requests pour communiquer avec le web. Vous pouvez utiliser les variables d'environnement HTTP_PROXY et HTTPS_PROXY pour que les requêtes utilisent un serveur mandataire ou proxy. Veuillez vous référer à la documentation sur les requêtes pour plus d'informations.

Exécuter un script

Pywikibot est installé avec de nombreux scripts dans le dossier scripts. Vous pouvez tous les exécuter à partir de la commande suivante :

$ python pwb.py [name of the script]

Pour en savoir plus sur la manière d'exécuter les scripts Pywikibot de base, voir :

La liste de ces scripts est disponible sur Manuel:Pywikibot/Scripts et doc.wikimedia.org/pywikibot.

Autres dépendances

La plupart des scripts ne nécessitent pas de paquets logiciels supplémentaires, mais certains d'entre-eux ne fonctionneront pas sans certains paquets. Ils sont listés sur requirements.txt, avec leurs dépendances.

Pour installer les dépendances de certains scripts, utilisez pip et lancez la commande suivante :

$ python -m pip install [name of the package]

Sinon, vous pouvez aussi lancer la commande suivante pour installer toutes les dépendances pour l'ensemble des scripts en une seule fois :

$ python -m pip install -r requirements.txt


Si vous avez besoin de plus d'aide pour configurer votre Pywikibot, consultez le canal IRC #pywikibot connecter ou la liste de diffusion pywikibot@.