EarwigBot

EarwigBot είναι ένα ρομπότ Python που επεξεργάζεται η Wikipedia και αλληλεπιδρά με τους ανθρώπους στο IRC & nbsp?. Αυτό το αρχείο παρέχει μια επισκόπηση του πώς να εγκαταστήσετε και να ρυθμίσετε το bot? πιο λεπτομερείς πληροφορίες βρίσκεται στο docs / κατάλογο (διαθέσιμη στην ηλεκτρονική διεύθυνση PyPI).
Ιστορικό
Ανάπτυξη άρχισε, με βάση το πλαίσιο Pywikipedia, στις αρχές του 2009. Έγκριση γροθιά έργο του, έναν ανιχνευτή παραβίαση πνευματικών δικαιωμάτων, διεξήχθη το Μάιο, και το bot έχει τρέξει με συνέπεια από τότε (με την εξαίρεση του Ιαν / Φεβ 2011). Είναι διαχειρίζεται επί του παρόντος διάφορες εν εξελίξει εργασίες που κυμαίνονται από την παραγωγή στατιστικών για την κατηγορία καθαρισμού, και τα καθήκοντα on-demand, όπως WikiProject πρότυπο ετικετών. Δεδομένου ότι άρχισε να τρέχει, το bot έχει κάνει πάνω από 50.000 αλλαγές.
Ένα έργο για να το ξαναγράψουν από την αρχή ξεκίνησε στις αρχές Απριλίου του 2011, προχωρώντας έτσι μακριά από το πλαίσιο Pywikipedia και επιτρέποντας λιγότερο συνολικό κώδικα, καλύτερη ενσωμάτωση μεταξύ των μερών bot, και ευκολότερη συντήρηση.
installation
Αυτό το πακέτο περιέχει τον πυρήνα earwigbot, απέσπασε αρκετά ότι θα πρέπει να είναι εύχρηστο και προσαρμόσιμο από οποιονδήποτε τρέχει ένα bot σε μια τοποθεσία MediaWiki. Δεδομένου ότι είναι component-based, τα συστατικά του IRC μπορεί να απενεργοποιηθεί εάν είναι επιθυμητό. Οι εντολές του IRC και τα καθήκοντα bot ειδικά για παράδειγμα μου EarwigBot που δεν αισθάνομαι τον μέσο χρήστη και θα χρειαστείτε είναι διαθέσιμα από το αποθετήριο earwigbot-plugins.
Είναι συνιστάται να εκτελέσετε δοκιμές μονάδα του bot πριν από την εγκατάσταση. Εκτελέστε δοκιμή setup.py Python από τον κατάλογο ρίζας του έργου. Σημειώστε ότι κάποιες εξετάσεις απαιτούν σύνδεση στο Internet, και άλλοι μπορεί να χρειαστούν λίγο χρόνο για να τρέξει. Κάλυψη σήμερα είναι μάλλον ελλιπής.
Ρυθμίσεις
Το ρομπότ αποθηκεύει τα δεδομένα του σε ένα «κατάλογο εργασίας», συμπεριλαμβανομένου του αρχείου config της και τις βάσεις δεδομένων. Αυτή είναι επίσης η θέση όπου θα τοποθετήσετε τις εντολές έθιμο IRC bot και τα καθήκοντα, τα οποία θα εξηγηθεί αργότερα. Δεν έχει σημασία πού αυτός ο κατάλογος είναι, εφ 'όσον το bot μπορεί να γράψει σε αυτό.
Ξεκινήστε το bot με την πορεία earwigbot / να / εργασίας / dir, ή απλά earwigbot εάν ο κατάλογος εργασίας είναι ο τρέχων κατάλογος. Θα παρατηρήσετε ότι δεν υπάρχει αρχείο config.yml και σας μεταφέρει μέσα από τη διαδικασία εγκατάστασης.
Σήμερα δεν υπάρχει τρόπος να επεξεργαστείτε το αρχείο config.yml μέσα από το bot αφού έχει δημιουργηθεί, αλλά YAML είναι μια πολύ απλή μορφή, έτσι πρέπει να είστε σε θέση να κάνετε στον εαυτό σας τις απαραίτητες αλλαγές. Ελέγξτε την εξήγηση του YAML στη Wikipedia για βοήθεια.
Μετά την εγκατάσταση, το bot θα ξεκινήσει. Αυτό σημαίνει ότι θα συνδεθεί με τους διακομιστές IRC έχει διαμορφωθεί για, τα καθήκοντα το χρονοδιάγραμμα bot να τρέχει σε συγκεκριμένες χρονικές στιγμές, και στη συνέχεια, περιμένετε για οδηγίες (όπως εντολές στο IRC). Για μια λίστα με τις εντολές, πείτε "! Βοήθεια" (εντολές είναι μηνύματα πρόθεμα με θαυμαστικό).
Μπορείτε να σταματήσετε το bot ανά πάσα στιγμή, με Control + C, το ίδιο όπως σταματήσετε ένα κανονικό πρόγραμμα Python, και θα προσπαθήσει να βγείτε με ασφάλεια. Μπορείτε επίσης να χρησιμοποιήσετε το "! Κόψει" εντολή στο IRC.
Προσαρμογή
Κατάλογο εργασίας του bot περιέχει ένα υποκατάλογο εντολές και έναν υποκατάλογο καθήκοντα. Προσαρμοσμένες εντολές του IRC μπορούν να κατατάσσονται στην πρώτη, ενώ τα δικά σας καθήκοντα wiki bot πάει στην τελευταία. Η ανάπτυξη custom modules εξηγείται παρακάτω, και με περισσότερες λεπτομέρειες μέσω τεκμηρίωση του bot για PyPI (ή στο docs / dir).
Σημειώστε ότι προσαρμοσμένες εντολές θα υπερισχύσει του built-in εντολές και τα καθήκοντα με το ίδιο όνομα.
Bot και BotConfig
earwigbot.bot.Bot είναι η κύρια κατηγορία EarwigBot του. Δεν χρειάζεται να υπόσταση σε αυτό τον εαυτό σας, αλλά είναι καλό να είναι εξοικειωμένος με τα χαρακτηριστικά και τις μεθόδους του, επειδή είναι ο κύριος τρόπος για να επικοινωνούν με άλλα μέρη του bot. Ένα αντικείμενο Bot είναι προσβάσιμο ως ένα χαρακτηριστικό των εντολών και των καθηκόντων (δηλαδή, self.bot).
earwigbot.config.BotConfig αποθηκεύει τις πληροφορίες διαμόρφωσης για το bot. Docstring του εξηγεί τι κάθε χαρακτηριστικό γνώρισμα χρησιμοποιείται για, αλλά ουσιαστικά κάθε «κόμβο» (ένα από τα config.components, wiki, IRC, εντολές, τα καθήκοντα, και τα μεταδεδομένα) που χαρτογραφείται σε ένα τμήμα του αρχείου config.yml του bot. Για παράδειγμα, εάν config.yml περιλαμβάνει κάτι σαν:
IRC:
& Nbsp? Frontend:
& Nbsp? Nick: MyAwesomeBot
& Nbsp? Κανάλια:
& Nbsp? - "## Earwigbot"
& Nbsp? - "# Κανάλι"
& Nbsp? - "# Άλλα καναλιών"
... Τότε config.irc ["frontend"] ["nick"] θα είναι "MyAwesomeBot» και config.irc ["frontend"] ["κανάλια"] θα είναι ["## earwigbot", "# κανάλι», "# άλλα καναλιών"].
Προσαρμοσμένες εντολές του IRC
Ειδικές εντολές είναι υποκατηγορίες earwigbot.commands.Command που παρακάμπτουν τη διαδικασία εντολών του () (και προαιρετικά έλεγχος () ή () setup) μεθόδους.
Το ρομπότ διαθέτει μια μεγάλη ποικιλία από ενσωματωμένες εντολές και plugins για να ενεργεί ως δείγμα κώδικα ή / και να δώσει ιδέες. Ξεκινήστε με δοκιμή, και στη συνέχεια ελέγξτε chanops και afc_status για τα πιο πολύπλοκα σενάρια.
Προσαρμοσμένη καθήκοντα bot
Προσαρμοσμένες εργασίες είναι υποκατηγορίες earwigbot.tasks.Task που παρακάμπτουν εκτέλεση της εργασίας του () (και () προαιρετικά εγκατάσταση) μεθόδους.
Δείτε το ενσωματωμένο wikiproject_tagger έργο για μια σχετικά απλή εργασία, ή οι afc_statistics plugin για ένα πιο περίπλοκο.
Το Wiki εργαλείων
Απάντηση EarwigBot στην Pywikipedia πλαίσιο είναι το Wiki εργαλείων (earwigbot.wiki), τα οποία θα έχουν πρόσβαση κυρίως μέσω bot.wiki.
bot.wiki παρέχει τρεις μεθόδους για τη διαχείριση των περιοχών - get_site (), add_site (), και remove_site (). Ιστοσελίδες είναι αντικείμενα που αντιπροσωπεύουν απλώς ένα site MediaWiki. Ένα μόνο παράδειγμα της EarwigBot (δηλαδή ένας ενιαίος κατάλογος εργασίας) αναμένεται να αναφέρονται σε ένα ενιαίο χώρο ή ομάδα των τόπων που χρησιμοποιούν τις ίδιες πληροφορίες σύνδεσης (όπως και όλα τα wikis WMF με CentralAuth).
Τοποθετήστε προεπιλεγμένη τοποθεσία σας (αυτό που σας πήρε κατά τη διάρκεια της εγκατάστασης) με το site = bot.wiki.get_site ().
Δεν είναι όλες οι πτυχές του σετ εργαλείων που καλύπτουν οι docs. Εξερευνήστε τον κωδικό και docstrings του για να μάθετε πώς να το χρησιμοποιήσετε σε μια πιο hands-on της μόδας. Για αναφορά, bot.wiki είναι ένα παράδειγμα του earwigbot.wiki.SitesDB συνδέεται με το αρχείο sites.db στον κατάλογο εργασίας του bot

Απαιτήσεις :.

• Python