Handbuch:Pywikibot/Installation
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:
 |
| Pywikibot |
|---|
|
Python installieren
Lade dir Python von https://www.python.org/downloads/ herunter und installiere es.
Stelle unbedingt sicher, dass du das Kästchen am Ende des Installationsassistenten ankreuzt, bei dem du gefragt wirst, ob du Python zum PATH hinzufügen möchtest!
Damit kannst du von jeder beliebigen Kommandozeile aus auf Python zugreifen, indem du einfach das Schlüsselwort python3 eingibst.
Wenn du Python bereits installiert hast, prüfe bitte, ob du eine aktuelle Version nutzt. Gib dazu in einer Konsole folgenden Befehl ein:
python3 --version
Um herauszufinden, ob Python Version 3 oder höher installiert ist, starte python3 --version in einer Konsole.
Ubuntu 19.04 und höher sind mit Versionen 2 & 3 installiert.
Python v2 läuft standardmäßig mit Terminalbefehl python; um v3 zu verwenden, verwenden Sie Terminalbefehle python3.
Python 3.8 or higher is currently required to run the bot, but Python 3.9 or higher is recommended. Auf Windows bitte nicht vergessen, die PATH-Umgebungs-Variable zu modifizieren, um Python und pip richtig zum Laufen zu bekommen.
Erweiterungen installieren
Für den Betrieb von Pywikibot sind zusätzliche Pakete erforderlich. Installiere diese Pakete mit dem folgenden Befehl:
$ python3 -m pip install "requests>=2.20.1"
$ python3 -m pip install "mwparserfromhell>=0.5.2"
$ python3 -m pip install packaging
Für Python 3.7 ist ein zusätzliches Paket erforderlich. Installiere es mit:
$ python3 -m pip install importlib_metadata
Ein alternativer MediaWiki-Markup-Parser kann mit folgendem Befehl installiert werden:
$ python3 -m pip install "wikitextparser>=0.47.5"
See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start
Pywikibot installieren
$ python3 -m pip install pywikibot
Wenn du pip verwendest, benutze in den folgenden Beispielen pwb statt python3 pwb.py.
Lade den aktuellen Pywikibot stable-Zweig herunter: .tar.gz, .zip.
Entpacke die geladene Datei, beispielsweise nach ~/pywikibot oder %USERPROFILE%\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 "%USERPROFILE%\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:
$ python3 pwb.py generate_user_files
Folge der Anzeige zur Konfiguration von Pywikibot. Du musst ein Passwort erstellen.
Mit folgendem Befehl meldest du dich schließlich in deinem Wiki an:
$ python3 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.
Du kannst diese Einstellungen in der Datei user-config.py ändern.
Siehe config.py für die Liste aller verfügbaren Parameter.
Proxy-Konfiguration
Pywikibot ist auf requests angewiesen, um mit dem Web zu kommunizieren.
Du kannst die Umgebungsvariablen HTTP_PROXY und HTTPS_PROXY nutzen, um Anfragen über einen Proxy-Server zu leiten.
Siehe die Dokumentation von requests für mehr Informationen.
Ein Script ausführen
Das Pywikibot-Paket enthält zahlreiche Scripts im Verzeichnis „scripts“. Sie werden folgendermaßen ausgeführt:
$ python3 pwb.py [name of the script]
Weitere Informationen zum Ausführen grundlegender Pywikibot-Skripte findest du unter:
- Ein kleiner Wiki-Toolkit-Workshop zum Ausführen grundlegender Pywikibot-Skripte
- Selbst-Lernmaterialien basierend auf dem Workshop „Kleine Wiki-Toolkits“
- Workshop-Handbuch basierend auf dem Workshop „Kleine Wiki-Toolkits“
Ein Verzeichnis aller Scripts findet sich unter Handbuch:Pywikibot/Skripte und doc.wikimedia.org/pywikibot.
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:
$ python3 -m pip install [name of the package]
Du kannst mit folgendem Befehl auch alle Module für alle Scripts auf einmal installieren:
$ python3 -m 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.