Manual:Pywikibot/Installation/fr

Installation initiale
En fonction de la branche que vous voulez installer et de de votre système d'exploitation, vous devez faire les choses suivantes :
 * 1) Télécharger Python (pour les utilisateurs de Windows) ou le mettre à jour si nécessaire (utilisateurs de Mac).
 * 2) Installer httplib2 (seulement pour "core", si vous utilisez "compat" ce n'est pas nécessaire).
 * 3) Télécharger Pywikibot.

Télécharger Python

 * Les systèmes Unix: en général, ils diposent d'une version suffisament récente de Python (2.5 pour la branche compat, 2.7 pour la branche core). vérifiez grâce à


 * Mac OS X 10.8+: has a version of Python that is recent enough to run pywikibot. If you run an older OS X, or are unsure, download and install Python 2.7.10 from http://www.python.org/downloads/


 * Windows: download and install the latest release Python 2.7.10 from http://www.python.org/downloads/


 * Version de Python : les versions suivantes de Python sont prises en charge :

Due to a Unicode bug in the underlying python library, Python version 2.7.2 or higher is strictly recommended for Wikimedia projects using the Compat branch, and Python 2.7.0 and 2.7.1 are not supported using the Core branch. See also the requirements for a bot, which describes needed python version and pywikibot branches.

Deux versions de pywikibot
Il existe deux branches en développement actif. Vous pouvez choisir parmi :
 * Core (auparavant rewrite), qui devrait être votre premier choix. Si vous ne savez pas quoi choisir, prenez cette branche.
 * Compat (formerly trunk) is an older version of the framework that is not actively maintained. There are limit scenarios where it might still be useful.  Compat was able to edit on MediaWiki 1.13 and earlier, even before MediaWiki had an API, and it includes a few scripts that are not available on core yet (see the compatibility list). However, if are going to edit WikiMedia wikis, compat is deprecated.

Télécharger Pywikibot
La manière la plus simple de télécharger Pywikibot est d'utiliser la dernière version compilée. Téléchargez juste le fichier ZIP de Pywikibot sur votre ordinateur et décompressez-le - aucune installation n'est requise.

Télécharger Pywikibot avec Git
Pour une installation avec Git vous devriez exécuter :
 * Pour "core" (anciennement "rewrite")
 * Pour "compat" (anciennement "trunk")

L'option  installe automatiquement les sous-modules nécessaires. Il y en a à l'heure actuelle deux : i18n pour la traduction des messages et spelling pour l'orthographe. Si vous n'utilisez pas cette option, vous devrez les installer à part après le clonage. Il y a deux commandes (i18n est vraiment nécessaire même pour les robots en anglais) :

Télécharger Pywikibot avec SVN
Si vous ne voulez pas utiliser Git vous pouvez aussi utiliser SVN :
 * Pour "core" (anciennement "rewrite")

Windows users may use the GUI extension TortoiseSVN, see next section below.

Pour installer à partir de SVN vous devriez lancer


 * Pour core (anciennement rewrite)
 * Pour "compat" (anciennement "trunk")

Télécharger Pywikibot avec TortoiseSVN pour les utilisateurs de Windows
TortoiseSVN est une extension du shell graphique windows pour travailler avec SVN. Vous pouvez télécharger la version actuelle sur http://tortoisesvn.net/downloads.html. Si vous utilisez TortoiseSVN suivez ces instructions :


 * For core release (formerly rewrite)
 * 1) Right-click on your preferred directory and execute
 * 2) Choose   and paste the URL
 * 3) Choose   and change the default directory which is   e.g. to   if you like.
 * 4) Confirm with
 * Now we have to install external libraries used by the framework. There are different ways to do that e.g. again with the checkout command. Another way is using properties. You may set it manually but it is very easy to use the preference file named .svnprops coming with the framework which sets all the needed properties:


 * 1) Right-click your working directory
 * 2) Select the last item in the drop list which might be folder's
 * 3) Select   tab and click on   button
 * 4) click   and select the file   in your framework folder
 * 5) Confirm with   for property settings
 * 6) Confirm with   for folder properties
 * 7) Now right-click onto your working copy and select   to download the external libraries.


 * For compat release (formerly trunk)
 * 1) Right-click on your prefered directory and execute
 * 2) Choose   and paste the URL
 * 3) Choose   and change the default directory which is   e.g. to   if you like.
 * 4) Confirm with
 * Now we have to install external libraries used by the framework. There are different ways to do that e.g. again with the checkout command. Another way is using properties in a similar way as in core release.


 * Mettre à jour la copie de travail
 * Cliquer droit sur votre le répertoire de votre pywikibot et choisissez

Raccourci en ligne de commande
Pour que votre code puisse être développé à l'extérieur du répertoire pywikibot source, ajouter quelque chose comme: à un fichier qui est lancé à l'initialisation, par exemple ~/.bashrc - il n'est ainsi pas nécessaire de retaper l'export PYTHONPATH à chaque connexion. Adapter évidemment les chemins à votre installation.

De la même manière, la variable PYWIKIBOT_DIR peut être incluse pour donner le répertoire dans lequel les informations utilisateurs sont stockées (et principalement le fichier user-config.py qui contient les données d'identification du robot).

Utilisateurs de Windows : créer un raccourci
Créer un raccourci rapide vers la console en ligne de commandes (utilisateurs de Windows) :

Si vous installez Pywikibot dans un dossier comme "Mes documents", il serait ennuyeux d'utiliser à chaque fois la commande "chdir" pour aller dans le dossier pour exécuter les robots.

Sur Windows, vous pouvez créer un raccourci qui ouvrira la console et que vous pouvez utiliser pour exécuter facilement des robots. Suivez simplement ces étapes pour en créer un :
 * 1) Faites un clic droit sur le dossier où Pywikibot est installé.
 * 2) Cliquez sur "Créer un raccourci". Une nouvelle icône avec la flèche indicatrice sera crééée.
 * 3) Faites un clic droit sur le nouveau raccourci, et cliquez sur "Propriétés".
 * 4) Dans la fenêtre des propriétés, dans le champ "Cible", tapez "cmd.exe".
 * 5) Dans le champ "Démarrer dans" entrez l'adresse complète du dossier de Pywikibot.
 * 6) Cliquez sur "OK".
 * 7) Cliquez sur le raccourci et cmd.exe s'ouvre avec le chemin d'accès déjà affiché.
 * Si vous faites F5 pour actualiser la fenêtre (ou que vous ré-ouvrez les propriétés du raccourci), vous remarquerez que l'icône aura changée.

Mise-à-jour
La suite logiciel pywikibot est un logiciel en perpétuel version bêta. Des corrections de bogues, de nouvelles options, de nouveaux comportements et des changements dans le logiciel Mediawiki conduisent à la sortie régulière de nouvelles versions et nécessitent que le code soit mis à jour. Mettez donc à jour votre branche régulièrement (tous les jours ou au moins une fois par semaine).

Mettre à jour l'installation à partir des sauvegardes journalières

 * Si vous utilisez une version "journalière", le processus est un peu plus compliqué. Vous devez re-télécharger une archive de cette page. Avant de l'installer, sauvegardez votre fichier de configuration et vos scripts  (user-config.py, un fichier définition de famille de wiki, un script personnel que vous auriez créé, et tout export XML que vous utilisez pour un wiki). Remplacez votre répertoire pywikibot par la nouvelle version. Restaurez vos fichiers personnels. Si vous avez un doute, n'écrasez rien mais garder une sauvegarde entière de votre ancien répertoire, pour être sur de ne rien perdre d'important.

Mettre à jour avec git

 * Si vous avez utilisé Git pour télécharger Pywikibot, vous devrez aller dans son dossier et exécuter la commande suivante :


 * Si vous utilisez une version compilée, le processus est un peu plus compliqué. Vous devez re-télécharger une copie complète via [$pwb_nightly ce lien]. Avant de l'installer, sauvegardez vos fichiers de configuration et vos scripts (user-config.py, tout fichier "family" ou script personnalisé que vous auriez créé, et tout fichier XML de dump que vous utiliseriez actuellement pour un wiki). Remplacez votre dossier Pywikibot par la nouvelle version que vous venez de télécharger. Restaurez vos fichiers de configuration. Si vous n'êtes pas sûr de ce que vous faites, n'effacez rien mais gardez une sauvegarde de votre ancien dossier Pywikibot, pour éviter de perdre tout fichier important.

Mise-à-jour automatique sur Wikimedia Labs ou Toolserver
Pour les mises à jour automatique, vous pouvez créer un script bash update à la racine et y insérer les commandes suivantes, Pour les Labs WMF (dans le groupe approprié): puis lancer  et insérer ce qui suit pour lancer votre bot tous les jours 00:00AM (minuit): Notez bien: dans ces codes, yourservicegroup est le nom de votre groupe de service (sans -local).

Pour une mise à jour automatique dans toolserver il est simplement nécessaire de faire la même chose en remplacant "/data/project/yourservicegroup/" par "/data/project/yourusername/" avec yourusername ... votre nom d'utilisateur !

Mise à jour de svn
Pour mettre à jour le code : Pour mettre à jour le code (branche compat) :

mettre à jour avec TortoiseSVN
Mettre à jour la copie de travail est très simple: clic-droit sur le répertoire et choisir

Core
Use  package management system to install dependencies. It is included by Python 2.7.9 and Python 3.4. To install all dependencies just run the following command:

For a single package use:

To uninstall a single package use:

Compat
Le framework de Pywikibot est un code plutôt gros et complexe et en tant que tel il nécessite des modules externes de Python (librairies) issus d'autres sources, et également pour fonctionner correctement. Les dépendances peuvent être installées manuellement ou automatiquement (pas encore supporté par "core").

Si un problème survient pendant l'installation des dépendances, veuillez fournir un fichier de rapport de bogue ou écrire à la maillist de Pywikipedia-l.

Automatique (recommandé)
Si possible, c'est le moyen recommandé. Le résultat sera identique sur toute les machines. Vous devez simplement exécuter votre script favori après l'installation, par exemple  et pywikibot vous demandera si vous voulez installez installer les paquets manquants, et continuera de poser des questions sur la manière dont vous voulez configurer votre copie.

Les paquets seront installés si possible à partir du gestionnaire de l'OS (tous les Linux, pas les Windows). Si les paquets sont introuvables, ils seront téléchargés en tant qu'archive depuis la source originale, extraits et installés. Aucours de ce processus, quelques paquets doivent être légèrement modifiés pour qu'ils travaillent sans problèmes avec pywikibot. Cette modification nécessite un programme appelé patch (patch.exe sous windows). Malheureusement il n'est pas disponible par défaut sous windows, il est cependant possible d'utiliser cette version adaptée (gnuwin32 patch.exe)

Il est utile de mentionner que - malgré l'utilisation des installation par gestionnaire de paquet OS - tous les fichiers sont installés localement dans des répertoires externals/ de pywikibot. C'est une fonctionnalité très utile pour les utilisateurs qui n'ont pas les permissions d'installer des logiciels sur le système, par exemple les non administrateurs.

Manuelle (utilisateurs experts)
Pour installer à la main les paquets nécessaires, vous devez d'abord les identifier. Une liste exhaustive externals/__init__.py est disponible. Elle contient: Ceux qui vous sont nécessaires dépendent beaucoup des fonctionnalité que vous cherchez à exploiter. Si vous n'êtes pas sur, utilisez le mode automatique décrit ci-dessus. Si les dépendances sont satisfaites tout se déroulera sans encombre, dans le cas contraire le cadriciel se plaindra et demandera si il doit installer automatiquement les paquets manquants.
 * le code "core" du cadriciel:
 * i18n [git submodule]
 * spelling [git submodule]
 * httplib2 [git submodule]
 * BeautifulSoup.py [included since important]
 * patch.exe
 * En fonction du script qui seront utilisés:
 * opencv, opencv/haarcascades [git submodule]
 * pycolorname [git submodule]
 * irclib
 * mwparserfromhell
 * parse-crontab
 * odfpy
 * openpyxl
 * python-colormath
 * jseg, jseg/jpeg-6b
 * mlpy
 * music21
 * ocropus
 * pydmtx
 * py_w3c
 * zbar
 * (slic)
 * (bob, xbob_flandmark)

Installation sur Wikimedia Labs ou Toolserver
Pour installer votre robot sur les serveurs Wikimedia et le lancer depuis cet endroit, familiarisez vous avec l'environnement Wikimedia Labs/Tool Labs.

Lors de l'étape suivante, vous devez obtenir plusieurs comptes (pour labs, pour le projet tools, pour votre outil), fournir une clé ssh, ... La manière de procéder est décrite en détail sur la page Setup pywikibot on Labs.

Le dépot du code de Pywikibot a été migré (de svn) sur git, veuillez vous informer au préalable sur Manual:Pywikipediabot/Gerrit.

Les projets bots d'ici sont obsolètes. Utilisez désormais tools, et pour celà suivez Tools/Help pour obtenir un compte. Créez ensuite votre outil (service group).

Si vous avez utilisé et maitrisé toolserver, un tutoriel de migration migrating from toolserver est disponible.

Vous êtes maintenant prêt à démarre. Indentifiez vous sur le projet tool de Labs: $ ssh USERNAME@tools-login.wmflabs.org basculez vers votre compte d'outil avec maintainer@tools-login:~$ become toolname local-toolname@tools-login:~$

Installer ou cloner maintenant le code de pywikibot pour votre compte outil comme décrit ci dessous.

core
De manière similaire à a procédure décrite dans ce mail: $ git clone --recursive https://gerrit.wikimedia.org/r/pywikibot/core.git pywikibot-core $ cd pywikibot-core

Vous devez maintenant configurer pywikibot. Choisissez l'une des recettes suivante pour configurer votre système:
 * exécuter
 * lancer votre script favori (par exemple ). Dans une installation fraîche une série de question vous est posées et pywikibot génère les fichiers de configuration en fonction des réponses.
 * si vous avez déja des fichiers de configurations datant d'une installation précédente, vous pouvez les copier aux endroits appropriés (par exemple pywikibot-compat/).

Quelques action supplémentaires que vous pourriez devoir accomplir, en fonction des scripts que vous voulez lancer, concernent la configuration des outils externes de manière appropriée - encore manuelle avec "core" $ cd externals $ cat README et suivez les indications.

Vous devrez finalement aussi entre entrer le mot de passe du robot.

Maintenant vous avez terminé la configuration de "core" et vous pouvez continuer à configurer les jobs à exécuter.

compat
Effectuer: $ git clone --recursive https://gerrit.wikimedia.org/r/pywikibot/compat.git pywikibot-compat

Comme décrit dans le manuel d'installation de core  au dessus, vous devez configurer pywikibot. Choisissez entre:
 * exécuter
 * lancer votre script favori (par exemple ). Dans une installation fraîche une série de question vous est posées et pywikibot génère les fichiers de configuration en fonction des réponses.
 * si vous avez déja des fichiers de configurations datant d'une installation précédente, vous pouvez les copier aux endroits appropriés (par exemple pywikibot-compat/).

Voir cet article pour plus de détails sur la configuration du robot, y compris la configuration manuelle. Vous pourriez configurer les outils externes manuellement si vous le souhaitez - mais ce n'est pas nécessaire dans "compat", cf. Manual:Pywikipediabot/Installation pour plus d'infos.

Vous devrez finalement aussi entre entrer le mot de passe du robot.

Maintenant vous avez terminé la configuration de "compat" et vous pouvez continuer à configurer l'espace web et les jobs à exécuter.

Installer l'espace web
Par défaut, le listage de répertoire sur http://tools.wmflabs.org/TOOLNAME est désactivé. Si vous voulez l'autoriser pour tous les utilisateurs, identifiez vous sur le compte de votre outil (comme précédemment décrit) et $ cd ~/public_html $ echo Options +Indexes >> .htaccess

Si vous lancez un robot avec l'option, vous trouverez les journaux dans le répertoire logs. Si vous voulez autoriser tous les utilisateurs à y accéder, tapez $ cd ~/public_html $ mkdir logs $ cd logs $ ln -s ~/pywikibot-core/logs cor

Si vous voulez qu'un type de fichier soit ouvert différemment par votre navigateur, par exemple ceux d'extensions .log soit considérés comme des fihiers texte, utilisez (confer ces instructions) $ echo AddType text/plain .log >> .htaccess et (n'oubliez pas de) subséquemment nettoyer le cache de votre navigateur.

Vous pouvez ensuite envisager votre répertoire cgi-bin $ cd ~/cgi-bin suivez précisément les indications de wikitech:Nova Resource:Tools/Help, même les deux commandes

$ /usr/bin/python     # valid $ /usr/bin/env python # in-vali fonctionnent et font la même chose dans le shell, seule la première est valide et fonctionne ici, la seconde est invalide! un autre point important est que les scripts PHP vont dans public_html, et pas dans cgi-bin. Les scripts python, en revanche peuvent aller soit dans public_html soit dans cgi-bin à votre convenance. Nous recommandons d'utiliser public_html pour les documents et permettre de les lister, alors que cgi-bin devrait être utilisé pour les scripts et être protégé et non listable.

Configurer le lancement des tâches
Pour mettre en place la soumission des tâches que vous voulez exécuter et utiliser le moteur de la grille de calcul, vous devez d'abord consulter gérer et planifier les tâches sur la grille et si vous êtes familier avec l'architecture de Toolserver consultez également Migrer de toolserver.

En général labs utilise SGE et ses commandes comme qsub</tt> et co., c'est expliqué dans ce document qui vous servira à avoir une idée des commandes et de leurs paramètres intéressants.

Un robot tournant perpétuellement (par ex un bot irc) comme (l'entrée cronie</tt> de l'hote de soumission TS):

devient

ou plus simplement

la première expression est bonne pour débugger. Des valeurs mémoires inférieures à 256 Mo ne semblent pas marcher ici, c'est en effet le minimum. Si vous rencontrez des problème avec votre tache comme : Fatal Python error: Couldn't create autoTLSkey mapping vous pouvez tentez d'augmenter la valeur de mémoire - ce qui est également requis ici, parce le script utilise un deuxième fil d'exécution pour l'horodatage et la mesure des temps et qu'il a aussi besoin de mémoire. par conséquent utilisez finalement

Pour créer un fichier crontab pour le lancement de vos taches suivez Planifier les taches a des intervalles régulier avec cron et mettez en place le fichier grace à: $ crontab -e et entrez

Configuration supplémentaire
Plus d'outils pour vous assister ainsi que votre robot:
 * wikitech:Nova Resource:Tools/Help, presque rien à faire mais seulement pour une courte période
 * demander un dépot git/gerrit pour votre outil
 * demandez plus d'espace pour votre extension
 * Git/New repositories/Requests

Créer les fichiers utilisateurs
En guise de dernière étape, vous devez créer les fichiers de configurations utilisateurs. Le principal est. Si vous exécuter votre script favori juste après l'installation,  par exemple, pywikibot va vous poser des questions sur la manière de configurer votre copie locale et va créer ces fichiers. Vous pouvez aussi lancer generate user files.py pour le même résultat.

Lancer sous Windows
Référez vous à la page Manual:Pywikibot/Windows.

Vérifier votre installation
Avec la branche core, lancer la ligne de commande  devrait demander le login et le mot de passe de votre robot, puis notifier Logged in on "somewiki":"lang" as "bot username"</tt>.