EarwigBot

EarwigBot ay isang Python robot na pag-edit ng Wikipedia at nakikipag-ugnayan sa mga taong higit sa IRC. & Nbsp; ay nagbibigay ng file na ito ng pangunahing pangkalahatang-ideya ng kung paano i-install at setup ng bot; mas detalyadong impormasyon ay matatagpuan sa mga doc / directory (magagamit online sa PyPI).
History
Pagpapaunlad nagsimula, batay sa Pywikipedia framework, sa unang bahagi ng 2009. Pag-apruba para sa kanyang kamao gawain, isang paglabag sa copyright detector, dala ay ang Mayo, at ang mga bot ay tumatakbo ang tuloy-tuloy na mula pa nang (na may pagbubukod sa Jan / Pebrero 2011). Ito ay kasalukuyang humahawak ng ilang mga patuloy na mga gawain mula sa pagbuo ng mga istatistika upang malinis kategorya, at on-demand na mga gawain tulad ng WikiProject template pag-tag. Mula noong nagsimula ito sa pagtakbo, ng bot ay gumawa ng higit sa 50,000 mga pag-edit.
Isang proyekto upang muling isulat ito mula sa simula ay nagsimula sa unang bahagi ng Abril 2011, kaya gumagalaw ang layo mula sa Pywikipedia framework at nagbibigay-daan para sa mas pangkalahatang code, mas mahusay na pagsasama sa pagitan ng mga bahagi bot, at mas madaling pagpapanatili.
Pag-install
Ang paketeng ito ay naglalaman ng core earwigbot, sapat na lumilipad ang isip na ito ay dapat kapaki-pakinabang at nako-customize ng sinuman sa pagpapatakbo ng isang bot sa isang MediaWiki site. Dahil ito ay bahagi-based, ang mga bahagi IRC maaaring hindi paganahin kung ninanais. IRC command at mga gawain bot partikular sa aking mga halimbawa ng EarwigBot na Masama ang pakiramdam ko kakailanganin ang average na user ay magagamit mula sa imbakan earwigbot-plugin.
Ito ay inirerekomenda upang magpatakbo ng mga pagsubok na yunit ng bot ng bago i-install. Patakbuhin ang python setup.py pagsubok mula sa root directory ng proyekto. Tandaan na nangangailangan ng ilang mga pagsubok ng koneksyon sa internet, at maaaring tumagal ng iba pa ng isang habang upang tumakbo. Coverage ay kasalukuyang halip hindi kumpleto.
I-setup
Nag-iimbak ng bot ang data nito sa isang "nagtatrabaho direktoryo", kabilang ang config file at mga database. Ito ay din ang lokasyon kung saan mo ilalagay ang mga custom na IRC command at mga gawain bot, na ipinaliwanag sa ibang pagkakataon. Hindi mahalaga kung saan direktoryong ito ay, hangga't ang bot na maaaring isulat dito.
Simulan ang bot na may earwigbot path / sa / working / dir, o lamang earwigbot kung ang pagtatrabaho na direktoryo ay ang kasalukuyang direktoryo. Ito ay mapapansin na walang config.yml file ay umiiral at magdadala sa iyo sa pamamagitan ng proseso ng pag-setup.
Sa kasalukuyan ay walang paraan upang i-edit ang config.yml file mula sa loob ng bot na ito ay nai nalikha, ngunit YAML ay isang napaka-simple format, kaya dapat mong magagawang gumawa ng anumang mga kinakailangang pagbabago sa iyong sarili. Tingnan ang paliwanag ng YAML sa Wikipedia para sa tulong.
Pagkatapos ng pag-setup, ang mga bot ay magsisimula. Ibig sabihin nito ay ito makakonekta sa mga server ng IRC ito ay nai-configure para sa, mga gawain bot iskedyul upang tumakbo sa partikular na mga oras, at pagkatapos ay maghintay para sa mga tagubilin (tulad ng mga utos sa IRC). Para sa isang listahan ng mga command, sabihin ang "! Help" (mga utos ay mga mensaheng may prefix na isang tandang padamdam).
Maaari mong itigil ang bot na ito sa anumang oras gamit ang Control + C, katulad ng itigil mo ang isang normal na programa Python, at ito ay subukan upang lumabas nang ligtas. Maaari mo ring gamitin ang "! Tumigil" na command sa IRC.
Pag-customize
Nagtatrabaho direktoryo ng bot ay naglalaman ng isang command subdirectory at mga gawain subdirectory. Pasadyang IRC command maaaring ilagay sa dating, samantalang ang mga custom na mga gawain wiki bot pumunta sa huli. Pagbuo ng mga pasadyang module ay ipinaliwanag sa ibaba, at nang mas detalyado sa pamamagitan ng dokumentasyon ng bot sa PyPI (o sa docs / dir).
Tandaan na ang mga custom na utos ay sasapaw sa built-in na command at mga gawain na may parehong pangalan.
Bot at BotConfig
earwigbot.bot.Bot ay pangunahing klase ng EarwigBot. Wala kang iyong sarili upang magbigay ng halimbawa na ito, ngunit ito ay mabuti upang maging pamilyar sa mga katangian nito at mga pamamaraan, dahil ito ay ang pangunahing paraan upang makipag-ugnayan sa iba pang mga bahagi ng bot. Ang isang bot na bagay ay naa-access bilang isang katangian ng command at mga gawain (ibig sabihin, self.bot).
earwigbot.config.BotConfig impormasyon tindahan configuration para sa mga bot. Docstring nito ay nagpapaliwanag kung ano ang bawat katangian ay ginagamit para sa, ngunit mahalagang bawat "node" (isa sa config.components, wiki, irc, utos, gawain, at metadata) na mapa sa isang seksyon ng config.yml file ng bot na. Halimbawa, kung config.yml Kasama ang isang bagay tulad ng:
irc:
& Nbsp; frontend:
& Nbsp; bumingaw: MyAwesomeBot
& Nbsp; mga channel:
& Nbsp; - "## earwigbot"
& Nbsp; - "#channel"
& Nbsp; - "# ibang-channel"
... Pagkatapos config.irc ["frontend"] ["bumingaw"] ay magiging "MyAwesomeBot" at config.irc ["frontend"] ["channel"] habilin maging ["## earwigbot", "#channel", "# ibang-channel"].
Pasadyang IRC utos
Pasadyang mga utos ay subclasses ng earwigbot.commands.Command na i-override ng proseso Command ng () (at opsyonal na check () o sa pag-setup ()) method.
May malawak na seleksyon ng built-in na command at plugin upang kumilos bilang sample code at / o bigyan ng mga ideya bot Ang. Magsimula sa pagsubok, at pagkatapos ay tingnan ang chanops at afc_status para sa ilang higit pang mga kumplikadong mga script.
Pasadyang mga gawain bot
Custom na mga gawain ay subclasses ng earwigbot.tasks.Task na i-override ang Gawain ng run () (at opsyonal na-set up ()) method.
Tingnan ang built-in wikiproject_tagger gawain para sa isang medyo simple gawain, o ang afc_statistics plugin para sa isang mas komplikado.
Ang Wiki toolset
Sagot EarwigBot na ang Pywikipedia balangkas ay ang Wiki (earwigbot.wiki) toolset, na talagang i-access sa pamamagitan ng bot.wiki.
bot.wiki ay nagbibigay ng tatlong mga paraan para sa pamamahala ng mga Site - get_site (), add_site (), at remove_site (). Mga Site mga bagay na ito lamang kumakatawan sa isang MediaWiki site. Ang isang halimbawa ng EarwigBot (ibig sabihin, isang solong direktoryo ng pagtatrabaho) ay inaasahan na nauugnay sa isang solong site o pangkat ng mga site gamit ang parehong impormasyon sa pag-login (tulad ng lahat ng WMF wiki sa CentralAuth).
Mag-load ng iyong default na site (ang isa na iyong pinili sa panahon ng pag-setup) sa site = bot.wiki.get_site ().
Hindi lahat ng mga aspeto ng toolset ay sakop sa mga doc. Galugarin nito code at docstrings upang malaman kung paano gamitin ito sa isang mas hands-on fashion. Para sa sanggunian, bot.wiki ay isang halimbawa ng earwigbot.wiki.SitesDB nakatali sa sites.db file sa direktoryo ng pagtatrabaho ng bot ni

Mga Kinakailangan :.

• Python