EarwigBot

EarwigBot je Python robot, který upravuje Wikipedii a interaguje s lidmi přes IRC. & Nbsp; Tento soubor obsahuje základní přehled o tom, jak nainstalovat a nastavit bot; Podrobnější informace se nachází v adresáři docs / (k dispozici on-line na PyPI).
Historie
Vývoj začal na základě rámce Pywikipedia, na začátku roku 2009. Schválení pro jeho pěsti úkol, detektor porušení autorských práv, byla provedena v květnu a bot běží trvale od té doby (s výjimkou Jana / únor 2011). V současné době se zabývá několik rozpracované úkoly, v rozmezí od statistiky výroby do kategorie vyčištění a úkoly na vyžádání, jako jsou šablony označování WikiProject. Vzhledem k tomu, rozběhl, bot učinil více než 50.000 úprav.
Projekt přepsat to od začátku začal na počátku dubna 2011 se tak vzdaluje od rámce Pywikipedia a umožňuje celkově nižší kód, lepší integrace mezi bot částmi a snadnější údržbu.
Instalace
Tento balíček obsahuje základní earwigbot, tak odebírány, že by mělo být použitelné a přizpůsobitelné kýmkoliv běží bota na MediaWiki místě. Vzhledem k tomu, že je založený na komponentách, komponenty IRC lze vypnout v případě potřeby. IRC příkazy a bot úkoly specifické pro mé instance EarwigBot, že nemám pocit, průměrný uživatel bude potřebovat jsou k dispozici od úložných earwigbot-plugins.
Je doporučeno spustit unit testy bot před instalací. Spusťte python setup.py zkoušku z kořenového adresáře projektu. Všimněte si, že některé testy vyžadují připojení k internetu, a další může chvíli trvat spustit. Pokrytí je v současné době poměrně neúplný.
Nastavení
Bot ukládá data do "pracovního adresáře", včetně jeho konfiguračním souboru a databází. To je také místo, kde se umístí vlastní příkazy IRC a bot úkoly, které budou vysvětleny později. Nezáleží na tom, kde je tento adresář, pokud bot do ní lze zapisovat.
Spusťte bot s earwigbot cesta / k / pracovní / dir, nebo jen earwigbot, pokud je pracovní adresář je aktuální adresář. To jistě všimnete, že žádná config.yml soubor existuje, a vás provede procesem instalace.
V současné době neexistuje způsob, jak upravit soubor config.yml zevnitř bot poté, co byl vytvořen, ale YAML je velmi jednoduchý formát, takže byste měli být schopni provést nezbytné změny sami. Podívejte se na vysvětlení YAML na Wikipedii o pomoc.
Po nastavení, bude bot začne. To znamená, že se připojí k IRC serverů bylo nakonfigurovány pro, plán bot úkolů běžet v určitou dobu, a pak čekat na instrukce (jako příkazy na IRC). Pro seznam příkazů, říkat "Pomoc!" (Příkazy jsou zprávy s předponou vykřičníkem).
Můžete zastavit bot kdykoli s Ctrl + C, stejně jako zastavit normální Python programu, a bude se snažit, aby bezpečně ukončit. Můžete také použít "! Quit" příkaz na IRC.
Vlastní
Pracovní adresář bot je obsahuje příkazy podadresář a úkoly podadresář. Příkazy Custom IRC mohou být umístěny v bývalé, zatímco vlastní wiki bot úkoly jít do druhé. Rozvoj vlastních modulů je vysvětleno níže, a podrobněji prostřednictvím dokumentaci bota o PyPI (nebo v docs / r).
Všimněte si, že vlastní příkazy přepíše vestavěné příkazy a úkoly se stejným názvem.
Bot a BotConfig
earwigbot.bot.Bot je hlavní třídou EarwigBot je. Nemusíte se instanci to sami, ale je dobré, aby se seznámili s jeho atributy a metody, protože to je hlavní způsob, jak komunikovat s ostatními částmi bot. Bot Objekt je přístupný jako atribut příkazů a úkolů (tj self.bot).
informace o konfiguraci ukládá earwigbot.config.BotConfig pro bota. Jeho dokumentačního řetězce vysvětluje, co každý atribut se používá pro, ale v podstatě každý "uzel" (jedna z config.components, wiki, IRC, příkazů, úkolů a metadata), mapuje úseku config.yml souboru bota. Například, pokud config.yml obsahuje něco jako:
IRC:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& nbsp; kanály:
& Nbsp; - "## earwigbot"
& Nbsp; - "# kanál"
& Nbsp; - "# jiný-channel"
... Pak config.irc ["rozhraní"] ["nick"], bude "MyAwesomeBot" a config.irc ["Frontend"] ["kanály"] se ["## earwigbot", "# kanál", "# jiný kanál"].
Příkazy Vlastní IRC
Vlastní příkazy jsou podtřídy earwigbot.commands.Command, že mají přednost před proces příkazu () (a případně kontrola () nebo nastavení) () metody.
Bot má široký výběr vestavěných příkazů a pluginů, aby jednala jako ukázkový kód a / nebo dát nápady. Začněte s testem, a pak se podívejte se operátoři kanálu a afc_status pro některé složitější skripty.
Vlastní bot úkoly
Vlastní úkoly jsou podtřídy earwigbot.tasks.Task, že mají přednost před úkolem je run () (a případně nastavení) () metody.
Podívejte se na vestavěné wikiproject_tagger úkol poměrně jednoduchým úkolem, nebo afc_statistics Earth pro složitější jeden.
Wiki Toolset
EarwigBot odpověď na rámce Pywikipedia je Wiki Toolset (earwigbot.wiki), který se bude přistupovat zejména prostřednictvím bot.wiki.
bot.wiki poskytuje tři metody pro řízení provozů - get_site (), add_site () a remove_site (). Stránky jsou objekty, které prostě představují MediaWiki místo. Jedna instance EarwigBot (tedy jednoho pracovního adresáře), očekává se, že se vztahují k jedné nebo ve skupině stránek pomocí stejné přihlašovací údaje (jako všechny wiki WMF s CentralAuth).
Vložte výchozí stránky (ten, který jste si vybral během instalace) se stránkou = bot.wiki.get_site ().
Ne všechny aspekty sady nástrojů jsou zahrnuty v Docs. Prozkoumejte svůj kód a docstrings se naučit, jak ji používat ve více hands-on módy. Pro srovnání, bot.wiki je instance earwigbot.wiki.SitesDB vázána na soubor sites.db v pracovním adresáři bota

Požadavky na :.

• Python