EarwigBot

EarwigBot on Python robotti, joka editoi Wikipedia ja vuorovaikutuksessa ihmisten kanssa yli IRC. & Nbsp; Tämä tiedosto sisältää perustiedot yleiskuvan siitä, miten asentaa ja asennus botti; yksityiskohtaisempaa tietoa sijaitsee docs / hakemisto (saatavilla verkossa osoitteessa PyPI).
Historia
Kehitys alkoi, joka perustuu Pywikipedia puitteista, vuoden 2009 alussa hyväksyminen sen nyrkki tehtävään, tekijänoikeusrikkomuksesta detektori, toteutettiin toukokuussa ja botti on ollut käynnissä jatkuvasti lähtien (lukuun ottamatta tammi / helmikuu 2011). Se on tällä hetkellä käsittelee käynnissä useita tehtävät vaihtelevat tilastoja sukupolvelta luokan siivous, ja on-demand tehtäviä, kuten WikiProject mallin koodaus. Koska se alkoi käynnissä, botti on tehnyt yli 50000 muokkauksia.
Hankkeen kirjoittaa tyhjästä alkoi huhtikuun alussa 2011 näin poispäin Pywikipedia puitteet ja mahdollistaa vähemmän yleistä koodia, parempi integraatio bot osien ja helpompi ylläpito.
Asennus
Tämä paketti sisältää ydin earwigbot, hajamielinen riitä, että se olisi käyttökelpoinen ja muokattavissa kukaan käynnissä bot on MediaWiki päällä. Koska se on komponentti-pohjainen, IRC osat voidaan poistaa käytöstä, jos halutaan. IRC komentoja ja botti tehtäviä erityisiä minun esiintymä EarwigBot että en tunne keskimääräinen käyttäjä tarvitsee ovat saatavilla arkistosta earwigbot-plugins.
On suositeltavaa ajaa botti Osatestit ennen asennusta. Suorita python setup.py testin hankkeen juurihakemistoon. Huomaa, että jotkin testit vaativat internet-yhteyden, ja toiset voivat kestää jonkin aikaa juosta. Kattavuus on tällä hetkellä varsin puutteellinen.
Asetukset
Botti tallentaa tietonsa "working directory", mukaan lukien sen config tiedosto ja tietokantoja. Tämä on myös paikka, jossa voit sijoittaa mukautetun IRC komentoja ja botti tehtäviä, jotka selitetään myöhemmin. Sillä ei ole väliä, jos tämä hakemisto on, niin kauan kuin botti voi kirjoittaa sitä.
Aloita botti earwigbot path / to / työ- / dir, tai vain earwigbot jos työhakemistossa on nykyisen hakemiston. Se huomaa, että ei config.yml tiedosto on olemassa ja vie sinut läpi asennuksessa.
Tällä hetkellä ei ole tapa muokata config.yml tiedoston sisällä botti, kun se on luotu, mutta YAML on hyvin yksinkertainen muoto, joten sinun pitäisi pystyä tekemään tarvittavat muutokset itse. Tutustu selitys YAML Wikipedia apua.
Asennuksen jälkeen botti alkaa. Tämä tarkoittaa, että se muodostaa yhteyden IRC-palvelimet se on määritetty, aikataulu bot tehtäviä suoritettavaksi tiettyinä aikoina, ja sitten odottaa ohjeita (kuten komennot IRC). Saat luettelo komennoista, sano "! Help" (komennot ovat viestejä etuliitteestä huutomerkki).
Voit lopettaa botti milloin tahansa Control + C, sama kuin lopetat normaali Python ohjelma, ja se yrittää poistua turvallisesti. Voit myös käyttää "! Lopettaa" komento IRC.
muokkaaminen
Botti Työhakemistoa sisältää komentoja alihakemisto ja tehtäviä alihakemisto. Custom IRC komentoja voidaan sijoittaa entisen, kun taas custom wiki bot tehtävät mennä jälkimmäisen. Kehittäminen mukautettuja moduulit on selitetty alla, ja tarkemmin läpi botti asiakirjat PyPI (tai docs / dir).
Huomaa, että komentojen ohittavat sisäisiä komentoja ja tehtäviä samalla nimellä.
Bot ja BotConfig
earwigbot.bot.Bot on EarwigBot tärkein luokka. Sinun ei tarvitse instanssia tämän itse, mutta se on hyvä tuntea sen ominaisuuksia ja menetelmiä, koska se on tärkein tapa kommunikoida muiden osien bot. Bot esine pääsee attribuuttina komentoja ja tehtäviä (eli self.bot).
earwigbot.config.BotConfig tallentaa kokoonpanotiedot botti. Sen docstring kerrotaan, mitä kukin ominaisuutta käytetään, mutta pohjimmiltaan jokainen "solmu" (yksi config.components, wiki, irc, komentoja, tehtäviä, ja metatiedot) karttoja osan botti config.yml tiedosto. Jos esimerkiksi config.yml sisältää jotain:
irc:
& Nbsp; frontend:
& Nbsp; nimimerkki: MyAwesomeBot
& Nbsp; kanavat:
& Nbsp; - "## earwigbot"
& Nbsp; - "#kanava"
& Nbsp; - "# muut-kanava"
... Sitten config.irc ["frontend"] ["nimimerkki"] on "MyAwesomeBot" ja config.irc ["frontend"] ["kanavat"] tulee ["## earwigbot", "#kanava", "# muut-kanava"].
Custom IRC komentoja
Custom komennot ovat alaluokkien earwigbot.commands.Command jotka kumoavat Command prosessi () (ja mahdollisesti tarkistaa () tai Setup ()) menetelmät.
Bot on laaja valikoima sisäänrakennettuja komentoja ja liitännäisiä toimia mallikoodin ja / tai antaa ideoita. Aloita testi, ja sitten tarkistaa chanops ja afc_status jostain monimutkaisempia skriptejä.
Custom bot tehtävät
Custom tehtävät ovat alaluokkien earwigbot.tasks.Task jotka kumoavat Tehtävä run () (ja mahdollisesti setup ()) menetelmät.
Katso sisäänrakennettu wikiproject_tagger tehtävä suhteellisen yksinkertaista, tai afc_statistics plugin monimutkaisempi yksi.
Wiki työkalusarja
EarwigBot vastaus Pywikipedia puitteet on Wiki työkalusarja (earwigbot.wiki), joka sinun tulee lähinnä pääsyn kautta bot.wiki.
bot.wiki tarjoaa kolme menetelmiä hallintaan Sites - get_site (), add_site (), ja remove_site (). Sivustot ovat esineitä, jotka yksinkertaisesti ovat MediaWiki sivusto. Kertaalleen EarwigBot (eli yksittäinen työhakemistossa) odotetaan liittyvän yksittäisen sivuston tai ryhmän sivustot käyttämällä samaa kirjautuminen info (kuten kaikki WMF wikit kanssa CentralAuth).
Laita oletuksena päällä (joka nostit asennuksen aikana) ja päällä = bot.wiki.get_site ().
Ei kaikilla työkalusarja käsitellään docs. Tutki sen koodin ja docstrings opetella käyttämään sitä enemmän käytännön muoti. Vertailukohtana, bot.wiki on esiintymä earwigbot.wiki.SitesDB sidottu sites.db tiedosto botti työhakemistosi.

Vaatimukset :

• Python