Wikia

Wikia Polska

Komentarze4

Tworzenie bota

Ten poradnik wyjaśnia, jak korzysta się z bota na Wikii przy użyciu oprogramowania Pywikibot.

Jeśli masz już podstawową wiedzę dotyczącą botów, przejdź do tej sekcji.

Wprowadzenie

Gnome-stock person bot.svg

Przeczytaj przynajmniej definicję na stronie Pomoc:Boty, aby zdobyć podstawową wiedzę o botach. Szczególnie powinieneś pamiętać o tym, aby poprosić o flagę bota, zanim zaczniesz go używać do masowego edytowania.

Ten poradnik pokazuje, jak zacząć z botem, jednak poniższe umiejętności mogą się przydać w dalszym użytkowaniu (od najważniejszej):

  1. Znajomość j. angielskiego – do zrozumienia dokumentacji na MediaWiki.org i używania samego bota
  2. Znajomość wyrażeń regularnych – do wykonywania trudniejszych operacji przy użyciu bota
  3. Znajomość programowania w Pythonie – do tworzenia własnych skryptów (dla zaawansowanych)

Nie należy też bać się wiersza poleceń – Pywikibot nie ma graficznego interfejsu.

Instalacja i konfiguracja

Instalacja była testowana na Windows 7. W zależności od używanego systemu operacyjnego poniższe kroki mogą się od siebie nieznacznie różnić, np. użytkownicy Linuksa (w tym ja) prędzej zainstalują potrzebne pakiety z oficjalnych repozytoriów, nie ze strony dewelopera.

Krok 1 – tworzenie konta bota

Utwórz konto, którego nick będzie jednoznacznie wskazywał, kto jest jego operatorem. Na przykład: WedkarskiWedkarskiBot.

Krok 2 – instalacja potrzebnego oprogramowania

Zainstaluj najnowszą wersję Pythona (3.4.3.) z domyślnymi ustawieniami w instalatorze.

Zainstaluj również Gita z domyślnymi ustawieniami w instalatorze, z wyjątkiem zezwolenia na uruchamianie z poziomu wiersza poleceń Windowsa – załącznik nr 1.

Krok 3 – pobieranie Pywikibota

Teraz pobierz paczkę z plikami Pywikibota (link bezpośredni). Wyodrębnij wszystkie pliki, a następnie możesz przenieść zawartość podfolderu core gdzie chcesz – ja preferuję po prostu C:\pywikibot.

Krok 4 – utworzenie skrótu

Jeśli używasz Windowsa, utwórz dodatkowo skrót, za którego pomocą będziesz mógł otwierać wiersz poleceń (cmd.exe) bezpośrednio w folderze z plikami bota.

Aby to zrobić, naciśnij prawym przyciskiem myszy na folderze i wybierz Wyślij do, a następnie Pulpit (utwórz skrót). Teraz przejdź do pulpitu, naciśnij prawym przyciskiem myszy na skrócie i wybierz Właściwości, a następnie zgodnie z załącznikiem nr 2 zmień jego ustawienia.

Krok 5 – instalowanie zależności

Otwórz wcześniej utworzony skrót, wpisz poniższe polecenie i zatwierdź je enterem:

py -m pip install --user --upgrade pip

A następnie:

py -m pip install -r requirements.txt --allow-external pYsearch --allow-unverified pYsearch

Krok 6 – utworzenie dodatkowych plików

Wpisz generate_family_file.py. Zostaniesz najpierw zapytany o podanie pełnego adresu do wikii, np. http://pl.elex.wikia.com, a potem skrótu, np. plelex.

Następnie utwórz plik konfiguracyjny użytkownika – uruchom notatnik, wklej tam poniższy tekst i uzupełnij:

# -*- coding: utf-8  -*-
family = 'nazwa'
mylang = 'pl'
usernames['nazwa']['pl'] = u'nick bota'
sysopnames['nazwa']['pl'] = u'nick'
console_encoding = 'windows-1250'
transliteration_target = 'windows-1250'
  • W miejsce nazwa umieść wcześniej wybrany skrót nazwy wikii.
  • W miejsce nick bota i nick umieść odpowiednio nick bota i Twój nick.

Po uzupełnieniu, wybierz z menu Plik, a następnie Zapisz jako…. Użyj ustawień ze załącznika nr 3 – zwróć uwagę na lokalizację, nazwę, typ i kodowanie.

Teraz Twój bot jest już przygotowany do pracy – gratulacje!

Załączniki

Użycie

Aby przystąpić do pracy z botem, otwórz skrót, a następnie wpisz:

pwb.py login

Zostaniesz wtedy zapytany o podanie hasła do konta bota. Napisz je (będzie niewidoczne) i zatwierdź enterem. Teraz możesz w końcu zlecić swojemu botu jakieś zadanie.

Pełna lista skryptów, których możesz użyć, znajduje się na MediaWiki.org (ang.). Na przykład, replace.py służy do zmieniania jednej frazy na drugą, a redirect.py naprawia podwójne i zerwane przekierowania. Za każdym razem jednak polecenie, jakie trzeba wpisać, sprowadza się do jednego schematu:

pwb.py <nazwa skryptu> <opcje>

Każdy skrypt ma swoje opcje, aby poszerzyć możliwości używania – więcej informacji znajduje się w dokumentacji. Istnieje również kilka opcji uniwersalnych do większości skryptów, za pomocą których wybieramy, na jakich stronach ma się uruchomić. Oto najważniejsze z nich:

Opcja Opis Przykład
start Wszystkie następne alfabetycznie strony po podanej. Wybierając „!”, skrypt uruchomi się na wszystkich stronach. -start:"Krokodyl"
file Lista stron z wybranego pliku. -file:strony.txt
cat Wszystkie strony w wybranej kategorii. -cat:"Owady"
catr Wszystkie strony w wybranej kategorii i jej podkategorach. -catr:"Ssaki"
ns Wszystkie strony w wybranej przestrzeni nazw. -ns:4
page Jedna, konkretna strona. -page:"Żaba"

Przykłady

Przenoszenie wszystkich stron w kategorii „Owady” do „Stawonogi”:

pwb.py category move -from:"Owady" -to:"Stawonogi"

Zmiana każdego użycia w przestrzeni głównej frazy „rzaba” na „żaba”, z opisem zmian „ort.”:

pwb.py replace "rzaba" "żaba" -start:! -summary:"ort."

Dodawanie szablonu {{wzór}} na górę każdej strony z kategorią „Wzorowe artykuły”:

pwb.py add_text -cat:"Wzorowe artykuły" -text:"{{wzór}}" -up

Więcej od Wikii

Losowa wiki