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: A Web Shell (un CLI).
Gnome-system-software-installer.svg
Sous PAWS
PAWS (no text).svg

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 son ordinateur
Computer n screen.svg

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 logo.svg

"Toolforge" vous fournit une infrastructure de nuage stable sur les serveurs Wikimédia vous permettant de 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 possédez déjà Python, la commande python --version permet d'afficher la version dans le terminal et de vérifier qu'elle est à jour. Si vous avez installé Python 3.5 ou supérieur , votre version de Python est suffisamment récente.

Sur Windows, n'oubliez pas de modifier la variable d'environnement PATH pour que Python et pip fonctionnent correctement.

Installer les dépendances

Un paquet supplémentaire, requests, est nécessaire pour exécuter Pywikibot. Utilisez pip, qui est déjà installé si vous avez Python 2.7.9 (ou supérieur) ou 3.4 (ou supérieur). Lancez la commande suivante pour installer ce package :

$ pip install "requests>=2.20.1"

Installer Pywikibot

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

Les utilisateurs de Python 2.7 devraient plutôt télécharger la version python2 stable : .tar.gz, .zip

Décompresser le fichier téléchargé, par exemple dans ~/pywikibot ou dans C:\Users\nom d'utilisateur\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 votre environnement de développement de bots à 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 un 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 "\Users\username\pywikibot"

Cette commande est un exemple. Vous devrez trouver le dossier où vous avez décompressé Pywikibot (lorsque vous avez installé le package, le CLI a publié des informations sur les dossiers où il a installé des fichiers ; cherchez parmi ces dossiers).

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 config2.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]

Une liste complète de ces scripts est disponibles sur Manuel:Pywikibot/Scripts .

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 :

$ 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 :

$ pip install -r requirements.txt


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