EarwigBot

.

EarwigBot Vikipedi'yi düzenlemeleri ve IRC üzerinden insanlarla etkileşime & nbsp bir Python robot, Bu dosya bot yüklemek ve kurulumu nasıl temel bir bakış sağlar; Daha detaylı bilgi docs / dizininde (PyPI mevcut online) yer almaktadır.
Tarih
Kalkınma onun yumruk görev, bir telif hakkı ihlali dedektörü erken 2009 Approval, pywikipedia çerçeveye dayalı başladı, Mayıs ayında gerçekleştirildi ve bot (Ocak / Şubat 2011 hariç) beri sürekli şimdiye yürütüyor. Şu anda böyle WikiProject şablon etiketleme gibi çeşitli devam eden istatistik nesil kategori temizleme değişen görevleri, ve on-demand görevleri yönetir. Çalışıyorsa başladığından beri, bot 50.000 düzenlemeler üzerinde yaptı.
Sıfırdan yeniden yazmak için bir proje dolayısıyla uzak pywikipedia çerçevesinde hareket ve daha az genel kod, bot parçaları arasında daha iyi entegrasyon ve kolay bakım için izin, erken Nisan 2011'de başladı.
Kurulum
Bu paket, bir MediaWiki sitesinde bir bot çalışan herkes tarafından kullanılabilir ve özelleştirilebilir olması gerektiğini yeterince abstracted çekirdek earwigbot içerir. Bu bileşen tabanlı olduğundan istenirse, IRC bileşenleri devre dışı bırakılabilir. Ben ihtiyacım olacak ortalama kullanıcı hissetmiyorum EarwigBot benim örneğine özgü IRC komutları ve bot görevleri depo earwigbot-eklentileri mevcuttur.
Bu yüklemeden önce bot birim testler önerilir. Projenin kök dizininde Python setup.py testini çalıştırın. Bazı testler internet bağlantısı gerektirir, ve diğerleri çalıştırmak için biraz zaman alabilir unutmayın. Kapsama şu anda oldukça eksik.
Ayarlar
Bot kendi config dosyasında ve veritabanları dahil bir "çalışma dizini" kendi verilerini, depolar. Bu aynı zamanda, özel IRC komutları ve daha sonra açıklanacaktır bot görevleri, yerleştirecektir yerdir. Bu dizin sürece bot ona yazabilirsiniz gibi, nerede olduğu önemli değil.
Earwigbot yolu ile bot başlayın / / çalışma / dizini veya çalışma dizini geçerli dizini ise sadece earwigbot için. Hiçbir config.yml dosyanın var olduğunu fark ve kurulum sürecinde götürecektir.
Orada oluşturulduktan sonra bot içinde config.yml dosyasını düzenlemek için hiçbir şekilde şu anda, ama gerekli değişiklikleri kendiniz yapmak gerekir, böylece YAML, bir çok basit biçimidir. Yardım için Wikipedia'da YAML açıklamasını göz atın.
Kurulum sonrasında, bot başlayacak. Bu (IRC komutları gibi) belirli zamanlarda çalıştırmak için zamanlama bot görevler için yapılandırılmış IRC sunucularına bağlanmak ve sonra talimatları bekleyin anlamına gelir. Komutların bir listesi için, "! Yardım" (komutlar ünlem işareti ile öneki mesajlardır) söylüyorlar.
Eğer normal bir Python programı durdurmak gibi aynı Control + C ile herhangi bir zamanda bot durdurabilirsiniz ve güvenli bir şekilde çıkmak için çalışacağız. Ayrıca IRC "! Çıkın" komutunu kullanabilirsiniz.
Özelleştirme
Botun çalışma dizini bir komut alt dizin ve görevleri alt içeriyor. Özel wiki bot görevleri ikincisi gitmek ise Özel IRC komutları, eski yerleştirilebilir. PyPI üzerinde bot belgelerine yoluyla aşağıda açıklanmıştır, ve daha detaylı özel modülleri gelişmekte (veya belgeler / dir).
Özel komutlar aynı ada sahip dahili komutları ve görevleri geçersiz olacağını unutmayın.
Bot ve BotConfig
earwigbot.bot.Bot EarwigBot ana sınıftır. Bu Kendinizi örneğini zorunda değilsiniz, ama bot diğer bölümleriyle iletişim kurmak için ana yolu olduğu için, onun nitelikleri ve yöntemlere aşina olmak iyidir. Bir Bot nesne komutları ve görevleri (yani, self.bot) bir nitelik olarak erişilebilir.
bot için earwigbot.config.BotConfig depolar yapılandırma bilgileri. Onun docstring'ini her nitelik için kullanılan, ama aslında her "düğüm" (config.components, wiki, irc, komutları, görevlerden biri, ve metadata) bot config.yml dosyasının bir bölümü eşler açıklar. Örneğin, eğer config.yml gibi bir şey içerir:
irc:
& Nbsp; önyüz:
& Nbsp; nick: MyAwesomeBot
& Nbsp; kanallar:
& Nbsp; - "## earwigbot"
& Nbsp; - "#kanal"
& Nbsp; - "# Diğer kanal"
... Sonra config.irc ["önyüz"] ["nick"] "MyAwesomeBot" ve config.irc ["önyüz"] ["kanal"] olacak olması ["## earwigbot", "#kanal" olacak, "# Diğer kanal"].
Özel IRC komutları
Özel komutlar Komutanlığı işlemi () (ve isteğe bağlı olarak kontrol () veya kurulum ()) yöntemlerini geçersiz earwigbot.commands.Command alt sınıflarıdır.
bot örnek kod olarak hareket etmek ve / veya fikir vermek için yerleşik komutlar ve eklentileri geniş bir yelpazesi vardır. Testi ile başlayın, ve sonra biraz daha karmaşık komut için chanops ve afc_status check out.
Özel bot görevleri
Özel görevler görevi en koşmak () (ve isteğe bağlı kurulum ()) yöntemlerini geçersiz earwigbot.tasks.Task alt sınıflarıdır.
Nispeten basit bir görev için yerleşik wikiproject_tagger görevi görmek, veya afc_statistics daha karmaşık bir biri için eklentisi.
Wiki Toolset
Pywikipedia çerçeve EarwigBot cevabı esas olarak bot.wiki aracılığıyla erişecek Wiki Toolset (earwigbot.wiki), olduğunu.
bot.wiki üç Siteleri yönetimi için yöntemler sağlar - get_site (), add_site (), ve remove_site (). Yer basitçe MediaWiki sitesi temsil nesnelerdir. EarwigBot tek bir örneği (yani tek bir çalışma dizini) tek bir site ya da (CentralAuth tüm WMF vikilerde gibi) aynı oturum açma bilgilerini kullanarak sitelerin grubuna ilişkilendirmek bekleniyor.
Varsayılan sitenizi sitesi = bot.wiki.get_site ile (Eğer kurulum sırasında aldı bir) yükleyin ().
Araç setinin tüm yönleriyle dokümanlar kaplıdır değil. Daha eller moda nasıl kullanılacağını öğrenmek için kodunu ve doc dizgilerini keşfedin. Başvuru için, bot.wiki bot çalışma dizininde sites.db dosyasına bağlı earwigbot.wiki.SitesDB bir örneğidir