EarwigBot

EarwigBot egy Python robot, amely szerkeszti Wikipedia és együttműködik az emberek több mint IRC. & Nbsp; Ez a fájl egy alapvető áttekintést, hogyan kell telepíteni és beállítani a bot; Részletesebb információ található a docs / könyvtár (online elérhető PyPI).
Előzmények
Fejlődés kezdődött, amely a Pywikipedia keret, 2009 elején saját elismer öklét feladata, megsérti a szerzői jogokat érzékelő, végezték május, és a bot már működik folyamatosan, amióta (kivéve a január / február 2011). Jelenleg kezeli több folyamatban lévő fűzése statisztikák nemzedékről kategóriában razzia, és on-demand feladatokat, mint WikiProject sablon tagging. Mivel futni kezdett, a bot tett több mint 50.000 szerkesztések.
A projekt átírni a semmiből kezdődött április elején 2011-ben, így távolodik a Pywikipedia keretet és lehetővé teszi a kisebb, összességében kódot, jobban integrálják a bot alkatrészeket, és megkönnyíti a karbantartást.
Telepítés
Ez a csomag tartalmazza az alapvető earwigbot, kivett elég, hogy meg kell használható és testreszabható bárki fut a bot a MediaWiki webhely. Mivel ez a komponens alapú, az IRC alkatrészeket ki lehet kapcsolni, ha szükséges. IRC parancsok és bot feladatokat adott, hogy én például a EarwigBot, hogy nem érzem az átlagos felhasználónak szüksége lesz állnak a tárolóból earwigbot-plugins.
Javasolt, hogy fut a bot unit tesztek telepítése előtt. Fuss python setup.py tesztet a projekt gyökérkönyvtárában. Ne feledje, hogy néhány tesztet internetkapcsolat szükséges, és mások is eltarthat egy ideig futtatni. Lefedettség jelenleg meglehetősen hiányos.
Beállítások
A bot az adatot a "munka könyvtárba", beleértve a config fájlt és adatbázisok. Ez is a hely, ahol lesz hely egyedi IRC parancsok és bot feladatokat, amelyeket a következő részben később. Nem számít, ahol a könyvtár, amíg a bot tudja-e írni.
Indítsa el a botot earwigbot path / to / munka / dir, vagy csak earwigbot, ha az aktuális könyvtárat az aktuális könyvtár. Úgy vesszük észre, hogy nem config.yml fájl létezik, és végigvezeti a beállítási folyamaton.
Jelenleg nem tudjuk szerkeszteni a config.yml fájlt a bot után jött létre, de YAML egy nagyon egyszerű formában, így képesnek kell lennie arra, hogy végezze el a szükséges változtatásokat magát. Nézze meg a magyarázatot YAML a Wikipedia segítséget.
A telepítés után a bot indul. Ez azt jelenti, hogy csatlakozzon az IRC szerverek azt állítva, menetrend bot feladatok futtatására egyes alkalommal, majd várjon utasításokat (például parancsok az IRC-n). A listát a parancsok, mondjuk "! Help" (parancsok üzenetek előtt egy felkiáltójel).
Akkor megáll a bot bármikor Control + C, ugyanaz, mint abbahagyja a normál Python programot, és akkor megpróbál kilépni biztonságosan. Ön is használja a "! Kilépés" parancsot IRC.
testreszabása
A bot munkakönyvtárába tartalmaz parancsokat könyvtár és a feladatok könyvtárban. Egyedi IRC parancsokat lehet helyezni a korábbi, míg az egyéni wiki bot feladatok bemegy az utóbbi. A fejlődő egyedi modulok alábbiakban olvashatja, és részletesebben a bot dokumentációjának PyPI (vagy a docs / dir).
Ne feledje, hogy egyéni parancsokat felülbírálja beépített parancsok és feladatok az azonos nevű.
Bot és BotConfig
earwigbot.bot.Bot van EarwigBot fő osztályban. Nem kell példányosítani magadnak, de jó, hogy ismeri annak tulajdonságait és módszereket, mert ez a legjobb módja, hogy kommunikáljon más részein a bot. A Bot tárgy elérhető mint attribútum parancsok és feladatok (pl self.bot).
earwigbot.config.BotConfig tárolja a konfigurációkat a bot. A docstring leírja az egyes attribútum az alkalmazott, de alapvetően minden "node" (egyik config.components, wiki, irc, parancsokat, feladatokat, és metaadatok) térképek egy része a bot config.yml fájlt. Például, ha config.yml magában valami ilyesmi:
IRC:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& Nbsp; csatornákon:
& Nbsp; - "## earwigbot"
& Nbsp; - "#channel"
& Nbsp; - "# más-csatorna"
... Akkor config.irc ["frontend"] ["nick"] lesz "MyAwesomeBot" és config.irc ["frontend"] ["csatornák"] nem lehet ["## earwigbot", "#channel", "# más-csatorna"].
Egyedi IRC parancsok
Egyéni parancsok alosztályain earwigbot.commands.Command, amelyek felülírják Command folyamatát () (és adott esetben a check () vagy a setup ()) módszerek.
A bot széles választékát beépített parancsok és beépülő fellépni minta kódját és / vagy ötleteket adni. Kezdje teszt, majd nézd meg opjának és afc_status néhány bonyolultabb szkriptek.
Egyedi bot feladatok
Egyedi feladatok alosztályain earwigbot.tasks.Task, amelyek felülírják a Feladat run () (és adott esetben a setup ()) módszerek.
Lásd a beépített wikiproject_tagger feladat egy viszonylag egyszerű feladat, vagy a afc_statistics plugin egy bonyolultabb egy.
A Wiki eszköztár
EarwigBot válasza a Pywikipedia keret a Wiki eszközkészlet (earwigbot.wiki), amely akkor elsősorban hozzáférés révén bot.wiki.
bot.wiki rendelkezik három kezelési módszereinek a weboldal - get_site (), add_site (), és remove_site (). Oldalak olyan objektumok, egyszerűen egy MediaWiki oldalon. Ha egyetlen esetben EarwigBot (azaz egyetlen munkajegyzéket) várhatóan kapcsolódnak egyetlen vagy csoport helyek ezekkel a bejelentkezési info (mint minden WMF wikik a CentralAuth).
Betölteni az alapértelmezett hely (az egyik, hogy felvette a telepítés során) a site = bot.wiki.get_site ().
Nem minden szempontból a eszközkészlet borítja a docs. Fedezze fel a kódot, és docstrings, hogy megtanulják, hogyan kell használni azt egy hands-on a divat. Referenciaként bot.wiki egy példánya earwigbot.wiki.SitesDB kötve a sites.db fájlt a bot munkakönyvtárába.

követelmények :

• Python