EarwigBot

EarwigBot è un robot Python che modifica Wikipedia e interagisce con le persone oltre IRC & nbsp;. Questo file fornisce una panoramica di base su come installare e configurare il bot; informazioni più dettagliate si trova nella directory docs / (disponibile online all'indirizzo PyPI).
Storia
Sviluppo iniziato, sulla base del quadro Pywikipedia, nei primi mesi del 2009. L'approvazione per il suo compito pugno, un rilevatore di violazione di copyright, è stata effettuata nel maggio, e il bot è stato eseguito costantemente da allora (con l'eccezione di gennaio / febbraio 2011). Attualmente gestisce diverse attività in corso che vanno dalle statistiche generazione alla categoria di pulizia e attività su richiesta, come WikiProject modello tagging. Da quando è cominciato a correre, il bot ha fatto oltre 50.000 modifiche.
Un progetto di riscrivere da zero è iniziata ai primi di aprile 2011, distaccandosi così dal quadro Pywikipedia e consentendo meno codice generale, una migliore integrazione tra le parti bot, e una più facile manutenzione.
Installazione
Questo pacchetto contiene il earwigbot nucleo, sottratto abbastanza che dovrebbe essere utilizzabile e personalizzabile da chiunque l'esecuzione di un bot su un sito MediaWiki. Poiché è basato su componenti, i componenti IRC possono essere disabilitati se lo si desidera. Comandi IRC e compiti bot specifici alla mia istanza di EarwigBot che non mi sento l'utente medio avrà bisogno sono disponibili nel repository earwigbot-plugins.
Si consiglia di eseguire unit test del bot prima di installare. Eseguire python setup.py prova dalla directory principale del progetto. Si noti che alcuni test richiedono una connessione ad internet, e altri possono prendere un po 'per l'esecuzione. La copertura è attualmente piuttosto incompleto.
Setup
Il bot memorizza i suoi dati in una "directory di lavoro", tra cui il suo file di configurazione e dei database. Questo è anche il luogo dove potrete inserire i comandi IRC attività personalizzate e bot, che verranno spiegate in seguito. Non importa se questa directory è, finché il bot può scrivere.
Avviare il bot con il percorso earwigbot / a / lavoro / dir, o semplicemente earwigbot se la directory di lavoro è la directory corrente. Si noterà che nessun file config.yml esiste e vi porterà attraverso il processo di installazione.
Non vi è attualmente alcun modo per modificare il file config.yml dall'interno bot dopo che è stato creato, ma YAML è un formato molto semplice, così si dovrebbe essere in grado di apportare le modifiche necessarie da soli. Scopri la spiegazione di YAML su Wikipedia per un aiuto.
Dopo l'installazione, il bot si avvierà. Ciò significa che si collegherà ai server IRC che sono stati configurati per, compiti programma bot per eseguire in momenti specifici, e quindi attendere le istruzioni (come comandi su IRC). Per un elenco dei comandi, dire "aiuto!" (I comandi sono messaggi iniziano con un punto esclamativo).
È possibile fermare il bot in qualsiasi momento con Control + C, stessa si arresta un normale programma Python, e cercherà di uscire in sicurezza. È inoltre possibile utilizzare il comando "! Quit" su IRC.
Personalizzazione
Directory di lavoro del bot contiene una sottodirectory comandi e una sottodirectory compiti. Comandi IRC personalizzati possono essere inseriti nel primo, mentre i compiti wiki bot personalizzati vanno in quest'ultima. Lo sviluppo di moduli personalizzati è spiegato qui di seguito, e più in dettaglio attraverso la documentazione del bot su PyPI (o nel docs / dir).
Si noti che i comandi personalizzati sostituiranno i comandi e le attività integrati con lo stesso nome.
Bot e BotConfig
earwigbot.bot.Bot è la classe principale di EarwigBot. Non è necessario creare un'istanza da soli, ma è bello avere familiarità con i suoi attributi e metodi, perché è il modo principale per comunicare con altre parti del bot. Un oggetto Bot è accessibile come un attributo di comandi e funzioni (ad esempio, self.bot).
earwigbot.config.BotConfig informazioni di configurazione memorizza per il bot. La sua docstring spiega cosa ogni attributo viene utilizzato per, ma essenzialmente ogni "nodo" (uno dei config.components, wiki, irc, comandi, funzioni, e metadati) associa a una sezione del file di config.yml del bot. Ad esempio, se config.yml comprende qualcosa come:
IRC:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& nbsp; canali:
& Nbsp; - "## earwigbot"
& Nbsp; - "#canale"
& Nbsp; - "# altri canali"
... Poi config.irc ["frontend"] ["nick"] sarà "MyAwesomeBot" e config.irc ["frontend"] ["canali"] sarà ["## earwigbot", "#canale", "# altri canali"].
Comandi IRC personalizzata
I comandi personalizzati sono sottoclassi earwigbot.commands.Command che sostituiscono processo di Comando () (e controllo opzionale () o configurazione) () metodi.
Il bot offre una vasta scelta di comandi e plugin incorporati di agire come codice di esempio e / o per dare idee. Iniziare con il test, e quindi controllare quelli che sono op e afc_status per alcuni script più complicati.
Compiti bot personalizzati
Attività personalizzate sono sottoclassi earwigbot.tasks.Task che sostituiscono run di Task () (e configurazione optional) () metodi.
Vedere il compito wikiproject_tagger incorporato per un'attività relativamente semplice, o le afc_statistics plugin for uno più complicato.
Il Wiki Toolset
La risposta di EarwigBot al quadro Pywikipedia è il Wiki Toolset (earwigbot.wiki), il quale si accede principalmente attraverso bot.wiki.
bot.wiki fornisce tre metodi per la gestione dei siti - get_site (), add_site (), e remove_site (). I siti sono oggetti che rappresentano semplicemente un sito MediaWiki. Una singola istanza di EarwigBot (vale a dire una sola directory di lavoro) dovrebbe riguardare un singolo sito o un gruppo di siti utilizzando le stesse informazioni di login (come tutti i wiki WMF con CentralAuth).
Caricare il sito predefinito (quella che hai scelto durante l'installazione) con il sito = bot.wiki.get_site ().
Non tutti gli aspetti del set di strumenti sono coperti nella documentazione. Esplora il suo codice e docstrings per imparare a usarlo in modo più hands-on di moda. Per riferimento, bot.wiki è un'istanza di earwigbot.wiki.SitesDB legato al file sites.db nella directory di lavoro del bot

Requisiti :.

• Python