Handbuch:Pywikibot/Installation

Diese Seite hilft dir, mit Pywikibot loszulegen, sowohl auf dem eigenen Computer, auf Toolforge oder indem du PAWS (Pywikibot: A Web Shell) verwendest.

Mit PAWS

PAWS: A Web Shell ist der einfachste Weg um Pywikibot zu starten. Hier ist keine Installation nötig und du kannst ein Web-Interface nutzen, um den Bot zu steuern.

Pywikibot auf PAWS betreiben

Auf deinem eigenen Computer

Unten befindet sich eine Anleitung, die dir dabei hilft, Pywikibot einzurichten und auf deinem eigenen Computer zu betreiben. Vier Hauptschritte leiten dich durch diesen Prozess:

• Python installieren
• Pywikibot installieren
• Pywikibot konfigurieren
• Ein Script laufen lassen

Auf Toolforge

Toolforge bietet dir eine stabile Hosting-Infrastruktur, die es dir erlaubt, einen Bot kontinuierlich oder nach einem Zeitplan laufen zu lassen.

Pywikibot auf Toolforge betreiben

Handbuch:Pywikibot
Schnelle Übersicht Installation Betreibung auf PAWS Betreibung auf Windows Betreibung auf Toolforge Konfiguration und Skripte user-config.py Globale Optionen Generator- und Filteroptionen i18n Skripte Verwendungen Wikidata Nicht-Wikimedia-Wikis Entwicklung Weitere Hilfe Mehr... »

Python installieren

Lade dir Python von https://www.python.org/downloads/ herunter und installiere es.

Wenn du Python bereits installiert hast, prüfe bitte, ob du eine aktuelle Version nutzt. Gib dazu in einer Konsole folgenden Befehl ein:

python --version To discover if Python version 3 or above is installed, run python3 --version in a console.

Ubuntu 19.04 and up comes with versions 2 & 3 installed. Python v2 runs by default using terminal command python; to use v3, use terminal command python3.

Hast du Python Python 3.5.3 or higher installiert, so ist deine Version aktuell genug.

Auf Windows bitte nicht vergessen, die PATH-Umgebungs-Variable zu modifizieren um Python und pip richtig zum Laufen zu bekommen

Installiere Erweiterungen

Damit Pywikibot läuft, wird ein Zusatzpaket namens „requests“ benötigt. Verwende pip (bereits installiert, wenn du Python 2.7.9 oder höher verwendest) oder Python ab Version 3.4. Gib folgenden Befehl zur Installation des Pakets ein:

pip install requests

$ pip install "requests>=2.20.1"

In addition a MediaWiki markup parser is required. Please install (at least) one of them:

$ pip install "mwparserfromhell>=0.5.0"

or

$ pip install "wikitextparser>=0.47.5"

or both.

Installiere Pywikibot

$ pip install pywikibot

Warnung:

The last version of the zip-file is currently (14. Juli 2022(2022-07-14)) broken, it contains __metadata__.py instead of version string.

Lade dir aktuelle Pywikibot stable herunter: .tar.gz, .zip.

Python 2.7 users should download the stable python2 branch: .tar.gz, .zip instead.

Entpacke die geladene Datei, beispielsweise nach ~/pywikibot oder C:\Users\benutzername\pywikibot.

Alternativ kann man die neueste Version mit git oder svn client von Gerrit beziehen, siehe Handbuch:Pywikibot/Gerrit . Dies wird empfohlen für aktive Botbetreiber und Entwickler, die Pywikibot verwenden.

Andere Versionen sind unter https://pywikibot.toolforge.org/ verfügbar.

Pywikibot aktualisieren

Halte dein Botstruktur aktuell. Neue Versionen werden laufend veröffentlicht und sind am selben Ort verfügbar.

Nutzer von git oder svn release können diesen Hinweis überspringen. Andernfalls ist es notwendig vor der Installation einer neuen Version die Konfigurationsdateien und Skripte (user-config.py, Family-Dateien oder angepasste Skripte, die erstellt oder geändert wurden, und den aktuellen XML-Dump, der als Wiki verwendet wird) zu sichern.

Entpacke die neue Version über die alte Version und überschreibe damit alle Dateien.

Pywikibot konfigurieren

Öffne das „Terminal“ in einem Unix-System(Linux/BSD/Solaris) bzw. die „Eingabeaufforderung“ unter Windows (normalerweise im „System“- oder „Zubehör“-Ordner im Startmenü unter „Alle Programme“). Wechsle in das Verzeichnis, in das der Pywikibot entpackt wurde.

Unix-Systeme (Linux/BSD/Solaris):

$ cd ~/core

Windows:

$ c:
$ cd "\Users\username\pywikibot"

Natürlich musst du den Pfad durch den Pfad ersetzen, wohin Pywikibot entpackt wurde.

Fahre fort mit folgendem Befehl, um die Dateien für die Benutzerkonfiguration zu erstellen:

$ python pwb.py generate_user_files

Folge der Anzeige zur Konfiguration von Pywikibot.

Mit folgendem Befehl meldest du dich schließlich an deinem Wiki an:

$ python pwb.py login

Verwendung auf fremden Wikis

Pywikibot ist für viele Wikis voreingestellt, aber eventuell nicht für das, auf dem du arbeiten willst. Siehe Manual:Pywikibot/Use on third-party wikis für die Konfiguration von Pywikibot für das fremde Wiki.

Weitere Konfigurationseinstellungen

Pywikibot stellt eine Vielzahl von Optionen vor, die das Verhalten deines Bots ändern. Diese Einstellungen kannst du in der Datei user-config.py vornehmen. Siehe config.py für die Liste aller verfügbaren Parameter.

Proxy-Konfiguration

Pywikibot relies on requests for communicating with the web. You can use HTTP_PROXY and HTTPS_PROXY environment variables to make requests use a proxy server. Refer to requests' documentation for more info.

Ein Script ausführen

Das Pywikibot-Paket enthält zahlreiche Scripts im Verzeichnis „scripts“. Sie werden folgendermaßen ausgeführt:

$ python pwb.py [name of the script]

Ein Verzeichnis aller Scripts findet sich unter Handbuch:Pywikibot/Skripte .

Weitere Module

Die meisten Scripts brauchen keine zusätzlichen Pakete, aber einige laufen nicht ohne. In requirements.txt sind sie zusammen mit den benötigten Modulen aufgeführt.

Um ein Modul für ein Script zu installieren, verwende „pip“ mit folgendem Befehl:

$ pip install [name of the package]

Du kannst mit folgendem Befehl auch alle Module für alle Scripts auf einmal installieren:

$ pip install -r requirements.txt

If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel ^connect or pywikibot@ mailing list.