EarwigBot

EarwigBot este un robot Python care editează Wikipedia și interacționează cu oamenii de peste IRC. & Nbsp; Acest fișier oferă o prezentare generală de bază de modul de instalare și configurare bot; informații mai detaliate se află în docs / directorul (disponibil online la PyPI).
Istoric
Dezvoltarea a început, pe baza cadrului Pywikipedia, la începutul anului 2009. Aprobarea pentru sarcina sa pumn, un detector încălcare a drepturilor de autor, a fost efectuat în luna mai, iar botul a fost difuzate în mod constant de atunci (cu excepția Ian / februarie 2011). Se ocupa în prezent mai multe sarcini în curs de desfășurare, de la generație la statisticile categorie de curatare, si sarcini la cerere, cum ar fi WikiProject șablon de marcare. Din moment ce a început să alerge, botul a făcut peste 50.000 de modificări.
Un proiect pentru a rescrie de la zero a început la începutul lunii aprilie 2011, se deplasează astfel departe de cadrul Pywikipedia și pentru a permite cod mai puțin de ansamblu, o mai bună integrare între părți bot, și întreținere mai ușoară.
Instalare
Acest pachet conține earwigbot de bază, captate destul că ar trebui să fie ușor de utilizat și personalizabil de către oricine care rulează un bot pe un site MediaWiki. Având în vedere că se bazează pe componente, componentele IRC poate fi dezactivată dacă se dorește. Comenzi IRC și sarcini bot specifice instanță mea de EarwigBot care eu nu simt utilizatorul mediu va avea nevoie de sunt disponibile din depozit earwigbot-plugin-uri.
Este recomandat pentru a rula teste unitare botului înainte de a instala. Rulați piton încercare setup.py din directorul rădăcină al proiectului. Rețineți că unele teste necesită o conexiune la internet, iar altele pot dura un timp pentru a rula. Acoperirea este în prezent destul de incomplete.
Configurare
Bot stochează datele sale într-un "director de lucru", inclusiv de fișier de configurare și baze de date. Aceasta este, de asemenea, locul unde veți plasa comenzi IRC personalizat și sarcini bot, care vor fi explicate mai târziu. Nu contează unde acest director este, atâta timp cât bot poate scrie la ea.
Incepe bot cu calea earwigbot / a / de lucru / dir, sau pur și simplu earwigbot dacă directorul de lucru este directorul curent. Se va observa că nu există nici un dosar config.yml și luați prin procesul de configurare.
Momentan nu există o modalitate de a edita fișierul config.yml din cadrul bot după ce a fost creat, dar YAML este un format foarte simplu, deci ar trebui să fie capabil să facă orice modificări necesare tine. Check out explicația de YAML pe Wikipedia pentru ajutor.
După instalare, botul va începe. Acest lucru înseamnă că va conecta la serverele IRC care a fost configurat pentru, sarcinile program bot pentru a rula la anumite momente, iar apoi așteptați pentru instrucțiuni (ca comenzi pe IRC). Pentru o listă de comenzi, spune "! Help" (comenzi sunt mesaje prefixate cu semnul exclamării).
Puteți opri bot în orice moment cu Control + C, la fel ca și te oprești un program normal Python, și va încerca să ieși în siguranță. Puteți folosi, de asemenea, comanda "! Ieși" pe IRC.
Personalizarea
Directorul de lucru bot conține un subdirector comenzi și un subdirector sarcini. Comenzile IRC personalizate pot fi plasate în fosta, în timp ce sarcinile personalizate wiki bot merge în acesta din urmă. Dezvoltarea modulelor personalizate este explicat mai jos, și mai în detaliu prin documentația bot pe PyPI (sau în docs / dir).
Rețineți că comenzi personalizate va înlocui comenzile și sarcinile încorporate cu același nume.
Bot și BotConfig
earwigbot.bot.Bot este de clasa principala EarwigBot lui. Nu trebuie să instantiate acest lucru singuri, dar e bine să fie familiarizați cu atributele și metodele sale, deoarece aceasta este principala cale de a comunica cu alte părți ale bot. Un obiect Bot este accesibil ca un atribut de comenzi și sarcini (de exemplu, self.bot).
earwigbot.config.BotConfig informații de configurare de magazine pentru bot. Docstring sa explică ceea ce fiecare atribut este folosit pentru, dar, în esență fiecare "nod" (unul din config.components, wiki, IRC, comenzi, sarcinile și metadate) harti la o secțiune a fișier config.yml botului. De exemplu, dacă config.yml include ceva de genul:
irc:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& nbsp; canale:
& Nbsp; - "## earwigbot"
& Nbsp; - "#canal"
& Nbsp; - "# alte canale"
... Apoi config.irc ["interfață"] ["nick"] va fi "MyAwesomeBot" și config.irc ["frontend"] ["canale"] va fi ["## earwigbot", "#canal", "# alte canale"].
Comenzi IRC personalizată
Comenzile personalizate sunt subclase ale earwigbot.commands.Command care suprascriu proces de comandă a lui () (și verificare, opțional () sau de configurare ()) metode.
Bot are o selecție largă de comenzi și plugin-uri încorporate în a acționa în calitate de mostre de cod și / sau pentru a oferi idei. Începeți cu testul, iar apoi a verifica afară Op-ii si afc_status pentru unele script-uri mai complicate.
Sarcini bot personalizată
Sarcini personalizate sunt subclase ale earwigbot.tasks.Task care suprascriu centrare Sarcina lui () (și eventual de configurare ()) metode.
Vezi sarcina wikiproject_tagger built-in pentru o sarcină relativ simplă, sau afc_statistics plug-in pentru unul mai complicat.
Wiki Toolset
Răspunsul EarwigBot la cadrul de Pywikipedia este Toolset Wiki (earwigbot.wiki), care va avea acces, în principal prin intermediul bot.wiki.
bot.wiki oferă trei metode de gestionare a site-uri - get_site (), add_site (), și remove_site (). Site-urile sunt obiecte care reprezintă pur și simplu un site MediaWiki. O singură instanță de EarwigBot (de exemplu, un director de lucru unic) este de așteptat să se refere la un singur site sau grup de site-uri folosind aceleași informații de conectare (la fel ca toate wiki WMF cu centralauth).
Încărcați site-ul dvs. implicit (cel care ai ales în timpul configurării) cu site-ul = bot.wiki.get_site ().
Nu toate aspectele legate de set de instrumente sunt acoperite în docs. Exploreaza cod și docstrings sarcina de a învăța cum să-l folosească într-un hands-on mai mult de moda. Pentru referință, bot.wiki este o instanță de earwigbot.wiki.SitesDB legat la dosar sites.db în directorul de lucru botului

Cerințe :.

• Python