EarwigBot

EarwigBot é um robô Python que edita Wikipedia e interage com pessoas com mais de IRC & nbsp;. Este arquivo fornece uma visão geral de como instalar e configurar o bot; informações mais detalhadas está localizado no diretório / docs (disponível online em PyPI).
História
O desenvolvimento começou, com base no quadro Pywikipedia, em 2009. A aprovação precoce para sua tarefa punho, uma violação de direitos autorais detector, foi realizado em maio, e o bot foi executado de forma consistente desde então (com exceção de Jan / Fev 2011). Ele atualmente lida com várias tarefas em andamento que vão desde a geração de estatísticas a categoria de limpeza e tarefas on-demand, como WikiProject modelo tagging. Desde que comecei a correr, o bot fez mais de 50.000 edições.
Um projeto para reescrevê-lo a partir do zero começou no início de abril de 2011, afastando-se assim do quadro Pywikipedia e permitindo a menos código geral, uma melhor integração entre as peças de bot, e manutenção mais fácil.
Instalação
Este pacote contém o earwigbot core, abstraído o suficiente para que ele deve ser utilizável e personalizável por qualquer pessoa executando um bot em um site MediaWiki. Uma vez que é baseado em componentes, os componentes de IRC pode ser desativado se o desejar. Comandos de IRC e tarefas bot específico para a minha instância de EarwigBot que eu não sinto o usuário médio vai precisar estão disponíveis a partir do repositório earwigbot-plugins.
É recomendado para executar testes de unidade do bot antes de instalar. Executar teste setup.py python a partir do diretório raiz do projeto. Observe que alguns testes exigem uma conexão de internet, e outros podem demorar um pouco para ser executado. A cobertura é actualmente bastante incompleto.
Configuração
O bot armazena seus dados em um "diretório de trabalho", incluindo o seu arquivo de configuração e bancos de dados. Este também é o local onde você irá colocar os comandos custom IRC e tarefas bot, que serão explicados mais tarde. Não importa onde esse diretório é, enquanto o bot pode escrever para ele.
Comece o bot com earwigbot caminho / para / trabalho / dir, ou apenas earwigbot se o diretório de trabalho é o diretório atual. Ele vai notar que nenhum arquivo config.yml existe e levá-lo através do processo de configuração.
Atualmente, não há maneira de editar o arquivo config.yml de dentro do bot depois de ter sido criada, mas YAML é um formato muito simples, por isso você deve ser capaz de fazer as alterações necessárias por conta própria. Confira a explicação do YAML no Wikipedia para obter ajuda.
Após a instalação, o bot irá começar. Isso significa que ele irá se conectar aos servidores de IRC tem sido configurados para, tarefas cronograma bot para executar em horários específicos, e depois esperar por instruções (como comandos no IRC). Para obter uma lista de comandos, diga "ajuda!" (Comandos são mensagens prefixados com um ponto de exclamação).
Você pode parar o bot a qualquer momento com Control + C, mesmo que você parar um programa normal Python, e vai tentar sair com segurança. Você também pode usar o comando "! Quit" no IRC.
Personalizar
Diretório de trabalho do bot contém um subdiretório comandos e um subdiretório tarefas. Comandos de IRC personalizado pode ser colocado na primeira categoria, enquanto tarefas wiki bot personalizados ir para o último. Desenvolvimento de módulos personalizados é explicado abaixo, e em mais detalhe através de documentação do bot em PyPI (ou no docs / dir).
Note-se que comandos personalizados irá substituir os comandos e tarefas internas com o mesmo nome.
Bot e BotConfig
earwigbot.bot.Bot é a principal classe de EarwigBot. Você não tem que instanciar este mesmo, mas é bom estar familiarizado com seus atributos e métodos, porque é a principal maneira de se comunicar com outras partes do bot. Um objeto Bot é acessível como um atributo de comandos e tarefas (ou seja, self.bot).
earwigbot.config.BotConfig armazena informações de configuração para o bot. Sua Docstring explica o que cada atributo é utilizado para, mas, essencialmente, cada "nó" (um dos config.components, wiki, irc, comandos, tarefas, e metadados) mapeia para uma seção de arquivo config.yml do bot. Por exemplo, se config.yml inclui algo como:
irc:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& nbsp; canais:
& Nbsp; - "## earwigbot"
& Nbsp; - "#canal"
& Nbsp; - "# outros canais"
... Então config.irc ["frontend"] ["nick"] será "MyAwesomeBot" e config.irc ["frontend"] ["canais"] será ["## earwigbot", "#canal", "# outros canais"].
Comandos de IRC Personalizado
Comandos personalizados são subclasses de earwigbot.commands.Command que substituem processo de Command () (e verificação opcionalmente () ou Configurar ()) métodos.
O bot tem uma vasta selecção de comandos e plugins embutidos para atuar como código de amostra e / ou para dar ideias. Comece com o teste e, em seguida, confira chanops e afc_status de alguns scripts mais complicados.
Tarefas bot Personalizado
Tarefas personalizadas são subclasses de earwigbot.tasks.Task que se sobrepõem a corrida de tarefas () (e, opcionalmente, de Instalação ()) métodos.
Veja o built-in tarefa wikiproject_tagger para uma tarefa relativamente simples, ou as afc_statistics plugins para um mais complicado.
O Wiki Toolset
A resposta de EarwigBot ao quadro Pywikipedia é o Wiki Toolset (earwigbot.wiki), que você irá acessar principalmente através bot.wiki.
bot.wiki fornece três métodos para a gestão de Sites - get_site (), add_site (), e remove_site (). Sites são objetos que representam simplesmente um site MediaWiki. Uma única instância do EarwigBot (ou seja, um único diretório de trabalho) é esperado para se relacionar com um único site ou grupo de sites que usam a mesma informação de login (como todos os wikis WMF com CentralAuth).
Coloque seu site padrão (aquele que você escolheu durante a instalação) com o site = bot.wiki.get_site ().
Nem todos os aspectos do conjunto de ferramentas são cobertos nos docs. Explore o seu código e docstrings para aprender a usá-lo de uma forma mais fashion hands-on. Para referência, bot.wiki é uma instância de earwigbot.wiki.SitesDB vinculado ao arquivo sites.db no diretório de trabalho do bot

Requisitos :.

• Python