EarwigBot

EarwigBot es un robot de Python que edita Wikipedia e interactúa con las personas mayores de IRC. & Nbsp; Este archivo proporciona una descripción básica de cómo instalar y configurar el bot; Información más detallada se encuentra en el directorio / docs (disponible en línea en PyPI).
Historia
Comenzó el Desarrollo, con base en el marco Pywikipedia, a principios de 2009. La aprobación para su tarea puño, un detector de autor violación, se llevó a cabo en mayo, y el robot ha estado funcionando constantemente desde entonces (con la excepción de enero / febrero de 2011). En la actualidad se encarga de varias tareas en curso que van desde la generación de estadísticas a la categoría de limpieza y tareas en demanda como WikiProject plantilla de marcado. Desde que empezó a correr, el robot ha realizado más de 50.000 ediciones.
Un proyecto para volver a escribir desde cero comenzó a principios de abril de 2011, alejándose así de marco Pywikipedia y permitiendo menos código en general, una mejor integración entre las partes bot, y un mantenimiento más fácil.
Instalación
Este paquete contiene el earwigbot núcleo, resumido suficiente que sea utilizable y personalizable por cualquier persona que ejecute un bot en un sitio de MediaWiki. Dado que es basado en componentes, los componentes de IRC se pueden desactivar si se desea. Comandos de IRC y tareas específicas de bots a mi instancia de EarwigBot que no me siento el usuario medio tendrá que están disponibles en los repositorios earwigbot-plugins.
Se recomienda ejecutar pruebas unitarias del bot antes de instalar. Ejecutar prueba de python setup.py desde el directorio raíz del proyecto. Tenga en cuenta que algunas pruebas requieren una conexión a Internet, y otros pueden tomar un tiempo para funcionar. La cobertura es actualmente bastante incompleta.
Configuración
El robot almacena sus datos en un "directorio de trabajo", incluyendo su archivo de configuración y bases de datos. Este es también el lugar donde se va a colocar los comandos de IRC personalizada y tareas de bots, que se explicarán más adelante. No importa donde este directorio es, siempre y cuando el bot puede escribir en él.
Inicie el bot con trazado earwigbot / a / trabajo / dir, o simplemente earwigbot si el directorio de trabajo es el directorio actual. Se dará cuenta de que no existe ningún archivo config.yml y le llevará a través del proceso de configuración.
Actualmente no existe una manera de editar el archivo config.yml desde dentro del bot después de que se ha creado, pero YAML es un formato muy sencillo, por lo que debe ser capaz de realizar los cambios necesarios a ti mismo. Echa un vistazo a la explicación de YAML en Wikipedia para obtener ayuda.
Después de la configuración, el robot comenzará. Esto significa que se conectará a los servidores de IRC que ha sido configurado para, programar tareas bot para funcionar en determinados momentos, y luego esperar instrucciones (como comandos en IRC). Para obtener una lista de comandos, diga "! Ayuda" (comandos son mensajes prefijados con un signo de exclamación).
Puede detener el robot en cualquier momento con Control + C, mismo que se detiene un programa en Python normal, y va a tratar de salir con seguridad. También puede utilizar el comando "! Quit" en el IRC.
Personalizar
Directorio de trabajo del robot contiene un subdirectorio comandos y un subdirectorio tareas. Comandos de IRC personalizado se pueden colocar en el primero, mientras que las tareas de bots wiki personalizados entran en esta última. El desarrollo de módulos personalizados se explica a continuación, y con más detalle a través de la documentación del bot en PyPI (o en el docs / dir).
Tenga en cuenta que los comandos personalizados tienen prioridad sobre los comandos y tareas integradas con el mismo nombre.
Bot y BotConfig
earwigbot.bot.Bot es la clase principal del EarwigBot. Usted no tiene que crear una instancia de usted mismo, pero es bueno estar familiarizado con sus atributos y métodos, ya que es la principal forma de comunicarse con otras partes del bot. Un objeto Bot es accesible como un atributo de comandos y tareas (es decir, self.bot).
earwigbot.config.BotConfig almacena información de configuración para el bot. Su docstring explica lo que cada atributo se utiliza para, pero esencialmente cada "nodo" (uno de config.components, wiki, irc, comandos, las tareas, y los metadatos) se asigna a una sección del archivo config.yml del bot. Por ejemplo, si config.yml incluye algo como:
irc:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& nbsp; canales:
& Nbsp; - "## earwigbot"
& Nbsp; - "#canal"
& Nbsp; - "# otro canal"
... Entonces config.irc ["frontend"] ["nick"] será "MyAwesomeBot" y config.irc ["frontend"] ["canales"] será ["earwigbot ##", "#canal", "# otro canal"].
Comandos de IRC personalizada
Los comandos personalizados son subclases de earwigbot.commands.Command que anulan proceso de Comando () (y opcionalmente de verificación () o configuración) () métodos.
El robot cuenta con una amplia selección de comandos y plugins incorporados para actuar como código de muestra y / o dar ideas. Comience con la prueba y, a continuación, echa un vistazo a los operadores del canal y afc_status para algunos scripts más complicados.
Tareas bot personalizada
Las tareas personalizadas son subclases de earwigbot.tasks.Task que anulan la carrera de tareas () (y opcionalmente de configuración) () métodos.
Consulte la tarea wikiproject_tagger incorporado para una tarea relativamente sencilla, o los afc_statistics el plugin por uno más complicado.
El Wiki Toolset
La respuesta de EarwigBot al marco Pywikipedia es el conjunto de herramientas de Wiki (earwigbot.wiki), el cual se accede a través principalmente bot.wiki.
bot.wiki ofrece tres métodos para el manejo de los Sitios - get_site (), add_site (), y remove_site (). Los sitios son objetos que simplemente representan un sitio de MediaWiki. Se espera que una sola instancia de EarwigBot (es decir, un único directorio de trabajo) para referirse a un solo sitio o grupo de sitios que utilizan la misma información de inicio de sesión (como todos los wikis WMF con CentralAuth).
Cargue su sitio predeterminado (el que usted escogió durante la instalación) con sitio = bot.wiki.get_site ().
No todos los aspectos del conjunto de herramientas se describen en la documentación. Explore su código y docstrings para aprender a usarlo en una más manera práctica. Como referencia, bot.wiki es una instancia de earwigbot.wiki.SitesDB atado al archivo sites.db en directorio de trabajo del bot

Requisitos :.

• Python