EarwigBot

EarwigBot е Python робот, който редактира Wikipedia и взаимодейства с хора над IRC & Nbsp;. Този файл се използва за основен преглед на това как да инсталирате и настроите бота; по-подробна информация се намира в Docs / директория (достъпно онлайн на PyPI).
<Силен> История
Започва развитие, на базата на рамката Pywikipedia, в началото на 2009 г. за одобряване на неговата юмрук задача, нарушение на авторски права детектор, се провежда през месец май и ботът е работила оттогава неотлъчно (с изключение на януари / февруари 2011 г.). В момента тя се занимава няколко текущи задачи, вариращи от статистиката поколение на категория почистване и задачи по заявка като случили маркиране шаблон. Тъй като тя се затича, ботът е направил над 50 000 редакции.
Един проект, за да го пренапише от нулата започна в началото на април 2011 г., като по този начин се отдалечават от рамките Pywikipedia и дава възможност за по-малко цяло код, по-добра интеграция между Bot части, и по-лесен за поддръжка.
<Силен> Монтаж
Този пакет съдържа сърцевина earwigbot, отвлечено достатъчно, че тя трябва да бъде използваема и персонализация от всеки работещ бот на сайт MediaWiki. Тъй като е компонент на базата на компонентите IRC може да се деактивира, ако се желае. IRC команди и ботовете задачи, специфични за моя случай на EarwigBot, че аз не се чувствам средния потребител ще трябва са достъпни през хранилището earwigbot-приставки.
Това е препоръчително да се прави изследвания на дялове на бота, преди да инсталирате. Изпълнете тест питон setup.py от проекта главната директория. Имайте предвид, че някои тестове изискват интернет връзка, а други може да отнеме известно време, за да работи. Покритие в момента е доста непълна.
<Силен> Setup
Роботът съхранява своите данни в "работна директория", включително неговата конфигурационния файл и бази данни. Това е и мястото, където ще поставите обичай IRC команди и ботовете задачи, които ще бъдат обяснени по-късно. Няма значение, когато тази директория е, толкова дълго, колкото бота да пиша за него.
Започнете бота с earwigbot път / до / работна / реж, или просто earwigbot ако работната директория е текущата директория. Тя ще забележите, че не съществува config.yml файл и ви преведе през процеса на настройка.
В момента няма начин да редактирате config.yml файл от рамките на бота, след като е бил създаден, но YAML е един много прост формат, така че трябва да бъде в състояние да направи необходимите промени себе си. Вижте обяснението на YAML на Wikipedia за помощ.
След настройка, ботът ще започне. Това означава, че ще се свърже с IRC сървъри е бил конфигурирани за, график Bot задачи за изпълнение в определено време, след което изчакайте, за инструкции (като команди на IRC). За списък от команди, кажете "Помощ!" (Команди са съобщения за префикс удивителен знак).
Можете да спрете бота по всяко време с Control + C, същата като сте спрели нормална програма Python, и ще се опита да излезете безопасно. Можете също да използвате "! Напусна" командата на IRC.
<Силен> Персонализиране
Работна директория на бота съдържа команди поддиректория и поддиректория задачи. Потребителски IRC команди могат да бъдат поставени в първия, докато потребителски задачи уики Bot отиват в последната. Разработването на собствени модули е обяснено по-долу, и по-подробно чрез документиране на бота на PyPI (или в Документи / реж).
Имайте предвид, че потребителски команди препокриват вградени команди и задачи със същото име.
Bot и BotConfig
earwigbot.bot.Bot е основният клас EarwigBot си. Не е нужно да се конкретни примери това себе си, но е добре да бъде запознат с неговите атрибути и методи, защото това е основният начин за комуникация с други части на бота. A Bot обект е достъпен като атрибут на команди и задачи (т.е., self.bot).
earwigbot.config.BotConfig информация за конфигурацията на магазини за бота. Нейната docstring обяснява какво всеки атрибут се използва за, но по същество всеки "възел" (един от config.components, уики, IRC, команди, задачи и метаданни) карти за участък от config.yml файл на бота. Например, ако config.yml включва нещо като:
IRC:
& Nbsp; интерфейса:
& Nbsp; Ник: MyAwesomeBot
& Nbsp; канали:
& Nbsp; - "## earwigbot"
& Nbsp; - "#channel"
& Nbsp; - "# друг канал"
... Тогава config.irc ["интерфейса"] ["Ник"] ще бъде "MyAwesomeBot" и config.irc ["интерфейса"] ["канали"] ще бъде ["## earwigbot", "# канал", "# друг канал"].
Потребителски IRC команди
Потребителски команди са подкласове на earwigbot.commands.Command, които да заместват процес командване () (и евентуално проверка () или настройка ()) методи.
Роботът разполага с богат избор на вградените команди и плъгини да действа като примерен код и / или да даде идеи. Започнете с тест, а след това се провери chanops и afc_status за някои по-сложни скриптове.
Потребителски Bot задачи
Потребителските задачи са подкласове на earwigbot.tasks.Task, които да заместват Изпълни задачата си () (и евентуално настройка ()) методи.
Вижте вградения wikiproject_tagger задачата за относително проста задача, или на afc_statistics плъгин за един по-сложен.
<Силен> The Wiki Инструментариум
Отговорът EarwigBot към рамката Pywikipedia е Wiki Инструментариум (earwigbot.wiki), които ще имате достъп главно чрез bot.wiki.
bot.wiki предлага три метода за управлението на обектите - get_site (), add_site (), и remove_site (). Сайтове са обекти, които просто представляват сайт MediaWiki. Един случай на EarwigBot (т.е. единичен работна директория) се очаква да бъдат свързани с една обект или група от обекти, използващи една и съща информация за вход (като всички WMF файл с CentralAuth).
Заредете вашия сайт подразбиране (този, който сте избрали по време на инсталацията) със сайта = bot.wiki.get_site ().
Не всички аспекти на набор от инструменти са обхванати в Документи. Разгледайте своя код и docstrings да научите как да го използва в по-практически мода. За справка, bot.wiki е пример за earwigbot.wiki.SitesDB обвързани с файла sites.db в работната директория на бота

<силни> Изисквания :.

• Python