Podręcznik:Pywikibot/Instalacja
Poniżej znajduje się instrukcja, która pomoże Ci skonfigurować i uruchomić Pywikibota na swoim komputerze. Ten proces składa się z czterech kroków:
Pywikibot |
---|
|
Instalowanie Pythona
Pobieranie i instalowanie Pythona z https://www.python.org/downloads/.
Make absolutely certain that you check the box at the bottom of the install wizard asking if you want to add Python to PATH!
That will allow you to access Python from any command prompt just by typing the keyword python
.
Jeśli masz już zainstalowany Python, sprawdź, czy Twoja wersja jest wystarczająco aktualna, uruchamiając python --version
w konsoli.
Dla sprawdzenia, czy zainstalowany jest język Python w wer. 3 lub nowszej, uruchom w konsoli python3 --version
.
Ubuntu 19.04 i nowsze są dostarczane z zainstalowanymi wersjami 2 i 3.
Python v2 działa domyślnie przy użyciu polecenia terminala python
; aby użyć wer. 3, użyj polecenia terminala python3
.
Wymagany jest Python 3.7 lub nowszy do uruchomienia bota, ale zalecany jest Python 3.8 lub nowszy. W systemie Windows nie zapomnij zmodyfikować zmiennej środowiskowej PATH, dla poprawnego działania Python'a i pip.
Instalowanie zależności
Do uruchomienia Pywikibota wymagane są dodatkowe pakiety Uruchom następujące polecenie, aby zainstalować te pakiety:
$ python -m pip install "requests>=2.20.1"
$ python -m pip install "mwparserfromhell>=0.5.2"
$ python -m pip install packaging
W przypadku Pythona 3.7 wymagany jest dodatkowy pakiet. Zainstaluj za pomocą:
$ python -m pip install importlib_metadata
Alternatywny analizator znaczników MediaWiki może zostać zainstalowany z:
$ python -m pip install "wikitextparser>=0.47.5"
See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start
Instalowanie Pywikibota
$ python -m pip install pywikibot
Jeśli używasz pip, użyj pwb
zamiast python pwb.py
w poniższych przykładach.
Pobierz aktualnego Pywikibot stable: .tar.gz, .zip.
Rozpakować pobrane pliki, na przykład w ~/pywikibot
lub %USERPROFILE%\pywikibot
.
Alternatywnie, można odzyskać najnowszą wersję za pomocą klienta git lub svn z Gerrit, patrz Manual:Pywikibot/Gerrit#For users . Jest to zalecany sposób korzystania z Pywikibota przez aktywnych operatorów botów i programistów.
Inne wersje są dostępne tu: https://pywikibot.toolforge.org/.
Aktualizowanie Pywikibota
Dbaj by boty były aktualizowane na bieżąco. Nowe wersje są wydawane w sposób ciągły i są dostępne w tym samym miejscu.
Jeśli używasz wydania git lub svn, możesz pominąć tę uwagę. W przeciwnym razie pamiętaj o konieczności utworzenia kopii zapasowej plików konfiguracyjnych i skryptów (user-config.py, dowolnego pliku rodziny lub niestandardowego skryptu, który mogłeś utworzyć lub zmienić, a także dowolnego bieżącego pliku zrzutu XML, którego używasz na wiki) przed zainstalowaniem nowej wersji.
Rozpakuj nową wersję na starej nadpisując wszystkie pliki.
Konfigurowanie Pywikibota
Otwórz Terminal w systemie uniksopodobnym (Linux/BSD/Solaris) lub Wiersz poleceń w systemie Windows (zwykle w folderach Windows, Akcesoria, Wszystkie aplikacje lub menu Wszystkie programy w menu Start) i zmień katalog na lokalizację, w której rozpakowałeś Pywikibota:
- Uniksopodobne (Linux/BSD/Solaris):
$ cd ~/core
- Windows:
$ c: $ cd "%USERPROFILE%\pywikibot"
Zamień lokalizację na tę, w której rozpakowałeś Pywikibota.
Kontynuuj, wykonując następujące polecenie, aby wygenerować plik konfiguracyjny użytkownika:
$ python pwb.py generate_user_files
Postępuj zgodnie z instrukcją, aby skonfigurować Pywikibota.
Na koniec uruchom następujące polecenie, aby zalogować się do swojej wiki:
$ python pwb.py login
Use on third-party wikis
Pywikibot jest wstępnie skonfigurowany dla dużej liczby wiki, lecz być może akurat nie dla tej, nad którą chcesz pracować. Zobacz Manual:Pywikibot/Use on third-party wikis aby dowiedzieć się, jak skonfigurować Pywikibot dla swojej wiki.
Więcej opcji konfiguracyjnych
Pywikibot zapewnia szeroką gamę opcji konfiguracyjnych pozwalających zmienić zachowanie Twojego bota. Możesz zmienić te ustawienia w pliku user-config.py. Zobacz config.py, aby poznać listę wszystkich parametrów, których możesz użyć.
Konfiguracja Proxy
Pywikibot wykorzystuje żądania $ do komunikacji z siecią.
Możesz użyć zmiennych środowiskowych HTTP_PROXY
i HTTPS_PROXY
, do tworzenia żądań korzystajacych z serwera proxy.
Więcej informacji znajdziesz w requests' documentation.
Uruchomienie skryptu
W pakiecie z Pywikibotem dostarczana jest spora ilość skryptów, znajdujących się w katalogu skrypty. Możesz uruchomić to wszystko za pomocą:
$ python pwb.py [name of the script]
Aby dowiedzieć się więcej o uruchamianiu podstawowych skryptów Pywikibota, zobacz:
- Warsztat nt. Małego zestawu narzędzi wiki do uruchamiania podstawowych skryptów Pywikibota.
- Materiały do samodzielnej nauki oparte na warsztatach z małych zestawów narzędzi wiki
- Podręcznik warsztatowy bazujący na warsztatach z małych zestawów narzędzi wiki
Lista wszystkich skryptów jest dostępna w Manual:Pywikibot/Scripts i doc.wikimedia.org/pywikibot.
Inne zależności
Większość skryptów nie wymaga dodatkowych pakietów, ale kilka z nich nie będzie działać bez nich. Są one wymienione w requirements.txt wraz z ich zależnościami.
Aby zainstalować zależności dla jakiegoś skryptu użyj pip i uruchom następującą komendę:
$ python -m pip install [name of the package]
Alternatywnie uruchom następującą komendę, aby zainstalować wszystkie zależności dla wszystkich skryptów naraz:
$ python -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.