Handbuch:Pywikibot/Compat/Installation

Python-Version

Für Wikimedia-Projekte, die den Compat-Zweig verwenden, wird dringend die Verwendung von Python Version 2.7.2 oder höher empfohlen.

Zwei Versionen von Pywikibot

Es gibt zwei Zweige, die aktiv weiterentwickelt werden. Du kannst zwischen folgenden wählen:

• Core (früher rewrite), der deine erste Wahl sein sollte. Wenn du dir nicht sicher bist, was du wählen sollst, nimm diesen Zweig.
• Compat (früher trunk) ist eine ältere Version des Frameworks, die nicht aktiv weiterentwickelt wird. Es gibt Grenzfälle, in denen sie dennoch nützlich sein könnte. Compat konnte bereits unter MediaWiki 1.13 und früheren Versionen bearbeiten, noch bevor MediaWiki über eine API verfügte, und es enthält einige Skripte, die im Kern noch nicht verfügbar sind (siehe die Kompatibilitätsliste). Wenn du jedoch WikiMedia-Wikis bearbeiten möchtest, beachte, dass Compat veraltet ist.

Pywikibot mit Git herunterladen

Für Compat (früher "trunk")

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

SVN

Für Compat (früher trunk)

svn co https://github.com/wikimedia/pywikibot-compat/trunk compat cd compat svn co https://github.com/wikimedia/pywikibot-i18n/trunk i18n

Um den Code für den Compat-Zweig zu aktualisieren:

svn up compat/trunk
cd compat
svn up i18n

Abhängigkeiten

Das Pywikibot-Framework ist ein ziemlich großer und komplexer Code und einige Skripte benötigen externe Python-Module (Bibliotheken) aus anderen Quellen, um ordnungsgemäß zu funktionieren. Die Abhängigkeiten können manuell oder automatisch installiert werden (wird vom Kern noch nicht unterstützt). Sollten während der Installation (von Abhängigkeiten) Probleme auftreten, erstelle einen Bug-Report oder schreibe an die Mailingliste pywikipedia-l.

Automatisch (empfohlen)

Sofern verfügbar, ist dies die empfohlene Vorgehensweise, da dadurch auf allen Rechnern eine identische Konfiguration erreicht wird. Du musst lediglich nach der Installation dein bevorzugtes Skript ausführen (zum Beispiel python pwb.py clean_sandbox.py -simulate) und Pywikibot fragt, ob du fehlende Pakete installieren möchtest, und stellt dir anschließend Fragen zur Konfiguration deiner lokalen Kopie. Pakete werden, wenn möglich, über die Paketverwaltung des Betriebssystems installiert (gilt nur für Linux, nicht für Windows). Falls sie nicht gefunden werden können, werden sie als Archiv von der Originalquelle heruntergeladen, extrahiert und installiert. Im Zuge dieses Prozesses müssen einige Pakete leicht modifiziert werden, damit sie nahtlos mit Pywikibot funktionieren. Für diese Modifikation wird ein zusätzliches Binärtool namens patch (patch.exe unter Windows) benötigt. Leider ist dies von MS nicht verfügbar; wir können jedoch eine Portierung des ursprünglichen Linux-Codes verwenden (gnuwin32 patch.exe).

Erwähnenswert ist hierbei, dass - trotz des "Installationsmodus" der OS-Paketverwaltung - alle Dateien lokal im Verzeichnis externals/ von Pywikibot installiert werden. Dies ist eine sehr nützliche Funktion für Benutzer, die keine Berechtigung haben, Software auf ihrem System zu installieren, z. B. Nicht-Administratoren.

Manuell (für Experten)

Um die benötigten Pakete manuell zu installieren, musst du zunächst wissen, welche. Eine vollständige Liste aller benötigten Module findet sich in externals/__init__.py und enthält:

• framework core code:
  • i18n [git submodule]
  • spelling [git submodule]
  • httplib2 [git submodule]
  • BeautifulSoup.py [included since important]
  • patch.exe
• abhängig davon, welches Skript verwendet wird:
  • 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)

Welche du wirklich benötigst, hängt stark vom Skript ab, das du ausführen möchtest - wenn du dir nicht sicher bist, verwende den oben genannten automatischen Modus. Um die korrekte Installation zu überprüfen, führe einfach ein Bot-Skript aus. Wenn die Abhängigkeiten erfüllt sind, funktioniert alles einwandfrei, andernfalls meldet das Framework einen Fehler und fragt, ob fehlende Pakete automatisch installiert werden sollen.

Für Compat-Veröffentlichung (früher trunk)

1. Klicke mit der rechten Maustaste auf dein bevorzugtes Verzeichnis und führe "SVN Checkout..." aus
2. Wähle "URL of repository" und füge die URL https://github.com/wikimedia/pywikibot-compat/trunk ein
3. Wähle "Checkout directory und ändere das Standardverzeichnis, das <dein bevorzugtes Verzeichnis>/pywikibot-compat ist, z. B. in <dein bevorzugtes Verzeichnis>/svn-compat, wenn du möchtest.
4. Bestätige mit [ OK ]

Nun müssen wir die vom Framework verwendeten externen Bibliotheken installieren. Dafür gibt es verschiedene Möglichkeiten, z. B. erneut mit dem Checkout-Befehl. Eine weitere Möglichkeit ist die Verwendung von Properties, ähnlich wie bei der Core-Veröffentlichung.

Installation des Bot-Codes

Compat

Führe folgendes aus:

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

Wie bereits im Abschnitt Kern oben beschrieben, musst du nun Pywikibot einrichten. Wähle einen der folgenden Prozesse, um dein System zu konfigurieren:

• Führe python generate_user_files.py aus
• Führe dein bevorzugtes Bot-Skript (z. B. python pwb.py clean_sandbox.py -simulate) in einem frischen Klon aus, wodurch dir einige Fragen zur Konfiguration deiner lokalen Kopie gestellt werden, beantworte diese sorgfältig, um fortzufahren.
• Falls du bereits Konfigurationsdateien aus einer früheren Version besitzt, kannst du diese vorhandenen Dateien an die entsprechenden Stellen kopieren (z. B. pywikibot-compat/).

Siehe diesen Artikel für weitere Informationen zur Konfiguration deines Bots, einschließlich der manuellen Erstellung der Dateien. Du kannst alle externen Abhängigkeiten manuell einrichten, wenn du möchtest - dies ist jedoch in Compat nicht erforderlich, siehe Handbuch:Pywikipediabot/Installation#Abhängigkeiten. Du musst schließlich auch das Passwort für deinen Bot eingeben. Du hast nun die Konfiguration von Compat abgeschlossen und kannst mit der Einrichtung des Webspeichers und der auszuführenden Jobs fortfahren.