EarwigBot

EarwigBot adalah robot Python yang mengedit Wikipedia dan berinteraksi dengan orang-orang di atas IRC & nbsp;. File ini memberikan gambaran dasar tentang bagaimana untuk menginstal dan setup bot; Informasi lebih rinci terletak di docs / direktori (tersedia online di PyPI).
Sejarah
Pembangunan dimulai, berdasarkan kerangka Pywikipedia, pada awal 2009. Persetujuan untuk tugas tinju, detektor pelanggaran hak cipta, dilakukan pada bulan Mei, dan bot telah berjalan secara konsisten sejak (dengan pengecualian Jan / Feb 2011). Saat ini menangani beberapa tugas yang sedang berlangsung mulai dari generasi statistik untuk kategori pembersihan, dan tugas on-demand seperti ProyekWiki Template tagging. Sejak mulai berlari, bot telah membuat lebih dari 50.000 suntingan.
Sebuah proyek untuk menulis ulang dari awal dimulai pada awal April 2011, sehingga bergerak menjauh dari kerangka Pywikipedia dan memungkinkan untuk kode kurang keseluruhan, integrasi yang lebih baik antara bagian bot, dan pemeliharaan lebih mudah.
Instalasi
Paket ini berisi earwigbot inti, cukup disarikan bahwa itu harus digunakan dan disesuaikan oleh siapa saja menjalankan bot di situs MediaWiki. Karena berbasis komponen, komponen IRC dapat dinonaktifkan jika diinginkan. Perintah IRC dan tugas bot khusus untuk contoh saya EarwigBot bahwa saya tidak merasa rata-rata pengguna perlu tersedia dari repositori earwigbot-plugin.
Ini dianjurkan untuk menjalankan tes unit bot sebelum menginstal. Menjalankan tes setup.py python dari direktori root proyek. Perhatikan bahwa beberapa tes membutuhkan koneksi internet, dan lain-lain dapat memakan waktu cukup lama untuk menjalankan. Cakupan saat ini agak tidak lengkap.
Pengaturan
Bot menyimpan datanya di "direktori kerja", termasuk berkas dan database konfigurasi nya. Ini juga merupakan lokasi di mana Anda akan menempatkan perintah IRC kustom dan tugas bot, yang akan dijelaskan nanti. Tidak peduli di mana direktori ini, selama bot dapat menulis untuk itu.
Mulai bot dengan path earwigbot / ke / kerja / dir, atau hanya earwigbot jika direktori kerja adalah direktori saat ini. Ini akan melihat bahwa tidak ada file config.yml ada dan membawa Anda melalui proses setup.
Saat ini tidak ada cara untuk mengedit file config.yml dari dalam bot setelah telah dibuat, tetapi YAML adalah format yang sangat mudah, sehingga Anda harus dapat membuat perubahan yang diperlukan sendiri. Lihat penjelasan YAML di Wikipedia bantuan.
Setelah setup, bot akan mulai. Ini berarti akan terhubung ke server IRC telah dikonfigurasi untuk, tugas jadwal bot untuk dijalankan pada waktu tertentu, dan kemudian menunggu instruksi (seperti perintah pada IRC). Untuk daftar perintah, mengatakan "! Help" (perintah adalah pesan diawali dengan tanda seru).
Anda dapat menghentikan bot setiap saat dengan Control + C, sama seperti Anda berhenti program Python normal, dan akan mencoba untuk keluar dengan aman. Anda juga dapat menggunakan "! Berhenti" perintah pada IRC.
Menyesuaikan
Direktori kerja bot mengandung subdirektori perintah dan subdirektori tugas. Perintah kustom IRC dapat ditempatkan di bekas, sedangkan tugas wiki bot kustom masuk ke kedua. Mengembangkan modul kustom dijelaskan di bawah, dan secara lebih rinci melalui dokumentasi bot di PyPI (atau dalam dokumen / dir).
Perhatikan bahwa perintah kustom akan menimpa built-in perintah dan tugas dengan nama yang sama.
Bot dan BotConfig
earwigbot.bot.Bot kelas utama EarwigBot itu. Anda tidak perlu instantiate ini sendiri, tapi itu baik untuk menjadi akrab dengan atribut dan metode, karena itu adalah cara utama untuk berkomunikasi dengan bagian lain dari bot. Sebuah objek Bot diakses sebagai atribut perintah dan tugas (yaitu, self.bot).
earwigbot.config.BotConfig menyimpan informasi konfigurasi untuk bot. Docstring yang menjelaskan apa setiap atribut yang digunakan untuk, tapi pada dasarnya masing-masing "node" (salah satu config.components, wiki, irc, perintah, tugas, dan metadata) peta ke bagian file config.yml bot. Sebagai contoh, jika config.yml termasuk sesuatu seperti:
irc:
& Nbsp; frontend:
& Nbsp; nick: MyAwesomeBot
& Nbsp; saluran:
& Nbsp; - "## earwigbot"
& Nbsp; - "#channel"
& Nbsp; - "# lain-channel"
... Kemudian config.irc ["frontend"] ["nick"] akan "MyAwesomeBot" dan config.irc ["frontend"] ["saluran"] akan menjadi ["## earwigbot", "#channel", "# lain-channel"].
Perintah kustom IRC
Perintah kustom adalah subclass dari earwigbot.commands.Command yang menimpa proses Komando () (dan cek opsional () atau setup ()) metode.
Bot ini memiliki berbagai pilihan built-in perintah dan plugin untuk bertindak sebagai kode sampel dan / atau untuk memberikan ide-ide. Mulailah dengan tes, dan kemudian memeriksa chanops dan afc_status untuk beberapa script lebih rumit.
Tugas kustom bot
Tugas kustom adalah subclass dari earwigbot.tasks.Task yang menimpa Tugas run () (dan tentukan ()) metode.
Lihat built-in tugas wikiproject_tagger untuk tugas yang relatif mudah, atau afc_statistics plugin untuk yang lebih rumit.
The Wiki toolset
Jawaban EarwigBot terhadap kerangka Pywikipedia adalah Wiki toolset (earwigbot.wiki), yang terutama Anda akan mengakses melalui bot.wiki.
bot.wiki menyediakan tiga metode untuk pengelolaan Situs - get_site (), add_site (), dan remove_site (). Situs adalah benda yang hanya mewakili situs MediaWiki. Sebuah contoh dari EarwigBot (yaitu direktori kerja tunggal) diharapkan untuk berhubungan dengan satu situs atau kelompok situs menggunakan sama info login (seperti semua wiki WMF dengan CentralAuth).
Memuat situs default (salah satu yang Anda memilih saat pemasangan) dengan situs = bot.wiki.get_site ().
Tidak semua aspek toolset dibahas dalam dokumen. Jelajahi kode dan docstrings untuk belajar bagaimana menggunakannya dengan cara yang lebih tangan-on fashion. Untuk referensi, bot.wiki adalah turunan dari earwigbot.wiki.SitesDB terikat ke file sites.db di direktori kerja bot

Persyaratan :.

• Python