EarwigBot

EarwigBot是一個Python機器人編輯維基百科和人民對IRC交互與NBSP;此文件提供了有關如何安裝和設置機器人的基本概述;更詳細的信息，位於docs /目錄（可在網上的PyPI）。
歷史
開發開始，立足於Pywikipedia框架，在2009年初批准其拳頭任務，違反版權探測器，進行了五月，和機器人已運行一貫以來（除月/ 2011年2月）。目前，它處理一些日常任務，從統計數據代類清理，並按需任務，如最實用的中文模板標記。自從它開始運行，該機器人已取得超過50,000編輯。
一個項目從頭重寫它始於2011年4月上旬，從而逐漸遠離Pywikipedia框架，並允許更少的總體代碼，機器人部件之間更好的融合，也更容易維護。
安裝
這個軟件包包含了核心earwigbot，抽象不夠，它應該是可用的和可定制的任何人都運行在的MediaWiki站點一個機器人。因為它是基於組件的，如果需要在IRC組件可以被禁用。可從存儲庫earwigbot-插件IRC命令，並具體到EarwigBot，我不覺得普通用戶需要的我的實例機器人的任務。
它建議在安裝之前運行機器人的單元測試。從項目的根目錄下運行python setup.py測試。請注意，某些測試需要一個互聯網連接，和其他人可能需要一段時間才能運行。覆蓋率是目前相當不完整的。
設置
殭屍其存儲在一個“工作目錄”的數據，包括它的配置文件和數據庫。這也是在那裡你將會把自定義的IRC命令和殭屍的任務，這將在後面解釋的位置。這不要緊，這個目錄是，只要機器人可以寫入。
開始earwigbot路徑機器人/到/工作/目錄，或者只是earwigbot如果工作目錄是當前目錄。它會發現，沒有config.yml文件是否存在，並引導您完成安裝過程。
目前還沒有辦法從編輯已創建後機器人內config.yml文件，但YAML是一個非常簡單的格式，所以你應該能夠使自己的任何必要的修改。查看YAML的解釋維基百科上的幫助。
設置完成後，機器人將開始。這意味著它會連接到已配置，調度機器人任務，在特定時間運行的IRC服務器，然後等待指令（如命令對IRC）。有關命令的列表，說！“幫助”（命令前面加上一個感嘆號消息）。
你可以停止機器人在任何時候控制+ C，相同停止正常的Python程序，它會試圖安全地退出。您還可以在IRC使用！“跳槽”的命令。
自定義
機器人的工作目錄中包含的命令子目錄和任務的子目錄。定制IRC命令可以放置在前者，而定制維基機器人任務進入後者。開發自定義模塊解釋如下，並更詳細地通過機器人的文檔PyPI上（或文檔/目錄）。
需要注意的是自定義命令將覆蓋內置命令和任務具有相同的名稱。
博特和BotConfig
earwigbot.bot.Bot是EarwigBot的主類。你不必實例化這個自己，但它的好，熟悉它的屬性和方法，因為它是與機器人的其他部位進行溝通的主要途徑。殭屍對象訪問的命令和任務（即self.bot）的屬性。
earwigbot.config.BotConfig存儲配置信息的機器人。其文檔字符串解釋了每個屬性用於，但本質上每一個“節點”（config.components，維基，IRC，命令，任務之一，和元數據）映射到機器人的config.yml文件的一個部分。例如，如果config.yml包括類似：
IRC：
＆NBSP;前端：
＆NBSP;尼克：MyAwesomeBot
＆NBSP;渠道：
＆NBSP; - “## earwigbot”
＆NBSP; - “#channel”
＆NBSP; - “＃其它通道”
......那麼config.irc [“前端”] [“尼克”]將“MyAwesomeBot”和config.irc [“前端”] [“通道”]將是[“## earwigbot”，“#channel” “＃其它通道”。
自IRC命令
自定義命令earwigbot.commands.Command的子類覆蓋命令的過程中（）（和可選檢查（）或設置（））的方法。
機器人有一個廣泛的選擇內置的命令和插件作為示例代碼和/或放棄的想法。開始測試，然後檢查chanops和afc_status了一些更複雜的腳本。
定制機器人任務
自定義任務earwigbot.tasks.Task的子類覆蓋任務的run（）（以及可選的設置（））的方法。
見內置wikiproject_tagger任務對於相對簡單的任務，或afc_statistics插件一個更複雜的。
的維基工具集
EarwigBot的答案Pywikipedia框架是維基工具集（earwigbot.wiki），您將主要通過bot.wiki訪問。
bot.wiki提供了三種方法站點的管理 - get_site（），add_site（），和remove_site（）。網站是簡單地代表的MediaWiki站點對象。 EarwigBot的單個實例（即一個工作目錄），預計涉及到一個單一的網站或組使用相同的登錄信息（像所有的WMF維基與CentralAuth）網站。
加載默認站點與站點= bot.wiki.get_site（即在安裝過程中選擇了一個）（）。
沒有工具的各個方面都涵蓋了文檔。探討其代碼和文檔字符串來學習如何使用它在一個更實際的方式。僅供參考，bot.wiki是earwigbot.wiki.SitesDB綁在機器人的工作目錄中的文件sites.db實例

要求：

• 在Python中