EarwigBot

EarwigBot is 'n Python robot wat wysigings Wikipedia en interaksie met mense oor IRC & nbsp;. Hierdie lêer bied 'n basiese oorsig van hoe die bot te installeer en setup; meer inligting is geleë in die / directory docs (aanlyn beskikbaar by PyPI).
Geskiedenis
Ontwikkeling begin, gebaseer op die Pywikipedia raamwerk, in die vroeë 2009 Goedkeuring vir sy vuis taak, 'n kopieregskending detector, is uitgevoer in Mei, en die bot is reeds konsekwent sedert (met die uitsondering van Jan / Feb 2011). Dit hanteer tans verskeie lopende take wat wissel van statistieke geslag tot kategorie opruim, en on-demand take soos WikiProject sjabloon kodering. Aangesien dit begin hardloop, het die bot gemaak meer as 50,000 wysigings.
'N Projek om dit te herskryf van nuuts af begin vroeg in April 2011, dus weg van die Pywikipedia raamwerk beweeg en toe vir minder oorkoepelende kode, beter integrasie tussen bot dele, en makliker onderhoud.
Installasie
Hierdie pakket bevat die kern earwigbot, onttrek genoeg dat dit bruikbaar en aanpas deur enigiemand bestuur van 'n bot op 'n MediaWiki webwerf moet wees. Aangesien dit komponent-gebaseerde, kan die IRC komponente afgeskakel word indien verlang. IRC opdragte en bot take spesifiek vir my geval van EarwigBot dat ek die gemiddelde gebruiker voel nie nodig is beskikbaar by die bewaarplek earwigbot-plugins.
Dit is aanbeveel dat die bot se eenheid toetse uit te voer voordat die installering van. Begin luislang setup.py toets van die projek se hoofdmap. Let daarop dat sommige toetse vereis 'n internet konneksie, en ander kan 'n rukkie neem om te hardloop. Dekking is tans eerder onvolledig.
Setup
Die bot slaan sy data in 'n "werk gids", insluitend sy config lêer en databasisse. Dit is ook die plek waar jy persoonlike IRC opdragte en bot take, wat later verduidelik word sal plaas. Dit maak nie saak waar hierdie gids is, so lank as wat die bot kan skryf om dit te.
Begin die bot met earwigbot pad / na / werk / rig, of net earwigbot indien die werk gids is die huidige gids. Dit sal sien dat daar geen config.yml lêer bestaan ​​en neem jou deur die proses vir die opstel.
Daar is tans geen manier om die config.yml lêer van binne die bot nadat dit geskep is om te verander nie, maar YAML is 'n baie eenvoudige formaat, so jy moet in staat wees om enige nodige veranderinge te maak jouself. Check uit die verduideliking van YAML op Wikipedia vir hulp.
Na opstelling sal die bot begin. Dit beteken dit aansluit by die IRC servers dit ingestel vir, skedule bot take uit te voer op spesifieke tye, en dan wag vir instruksies (soos opdragte op IRC). Vir 'n lys van instruksies, sê "help!" (Bevele is boodskappe voorafgegaan met 'n uitroepteken).
Jy kan die bot te eniger tyd met Control + C, dieselfde stop as jy stop om 'n normale Python program, en dit sal probeer om veilig te verlaat. Jy kan ook gebruik maak van die "! Ophou" opdrag op IRC.
aanpas
Die bot se gids werk bevat 'n bevele subdirectory en 'n take subdirectory. Custom IRC opdragte kan in die voormalige geplaas word, terwyl persoonlike wiki bot take gaan in die laasgenoemde. Die ontwikkeling van persoonlike modules word hieronder verduidelik, en in meer detail deur die bot se dokumentasie oor PyPI (of in die docs / r).
Let daarop dat persoonlike instruksies sal ignoreer ingeboude opdragte en take met dieselfde naam.
Bot en BotConfig
earwigbot.bot.Bot is EarwigBot se hoof klas. Jy hoef nie om dit te instansieer jouself, maar dit is goed vertroud met die eienskappe en metodes te wees, want dit is die belangrikste manier met ander dele van die bot te kommunikeer. A Bot voorwerp is toeganklik as 'n kenmerk van opdragte en take (dws, self.bot).
earwigbot.config.BotConfig winkels konfigurasie inligting vir die bot. Sy docstring verduidelik wat elke kenmerk gebruik word nie, maar in wese elke "node" (een van config.components, wiki, irc, opdragte, take en metadata) kaarte op 'n gedeelte van die bot se config.yml lêer. Byvoorbeeld, as config.yml sluit iets soos:
irc:
& Nbsp; frontend:
& Nbsp; Nick: MyAwesomeBot
& Nbsp; kanale:
& Nbsp; - "## earwigbot"
& Nbsp; - "# kanaal"
& Nbsp; - "# ander-kanaal"
... Dan config.irc ["frontend"] ["Nick"] sal "MyAwesomeBot" en config.irc ["frontend"] ["kanale"] sal wees ["## earwigbot", "# kanaal" te wees, "# ander-kanaal"].
Custom IRC opdragte
Custom opdragte is subklasse van earwigbot.commands.Command dat Command se proses () (en opsioneel tjek () of die opstel van ()) metodes omseil.
Die bot het 'n wye verskeidenheid van ingeboude in opdragte en plugins as voorbeeld kode op te tree en / of idees te gee. Begin met die toets, en dan check chanops en afc_status vir 'n paar meer ingewikkeld skrifte.
Custom bot take
Custom take is subklasse van earwigbot.tasks.Task wat oorheers Taak se lopie () (en opsioneel opstel ()) metodes.
Sien die ingeboude wikiproject_tagger taak vir 'n relatief eenvoudige taak, of die afc_statistics plugin vir 'n meer ingewikkelde een.
Die wiki Toolset
EarwigBot se antwoord op die Pywikipedia raamwerk is die Wiki Toolset (earwigbot.wiki), wat jy sal hoofsaaklik toegang deur bot.wiki.
bot.wiki bied drie metodes vir die hantering van Sites - get_site (), add_site (), en remove_site (). Plekke is voorwerpe wat net verteenwoordig 'n MediaWiki site. 'N enkele geval van EarwigBot (dws 'n enkele werk gids) verwag om met 'n enkele site of groep webwerwe met behulp van dieselfde login info (soos alle WMF wikis met CentralAuth).
Laai jou verstek webwerf (die een wat jy opgetel tydens die opstel) met webwerf = bot.wiki.get_site ().
Nie alle aspekte van die toolset word gedek in die dokumente. Verken sy kode en docstrings om te leer hoe om dit te gebruik in 'n meer praktiese wyse. Vir verwysing, bot.wiki is 'n voorbeeld van earwigbot.wiki.SitesDB wat gekoppel is aan die sites.db lêer in die bot se werk gids

Vereistes :.

• Python