errbot

Errbot

Errbot adalah chatbot. Ini memungkinkan Anda untuk memulai skrip secara interaktif dari ruang obrolan Anda dengan alasan apa pun: humor acak, chatops, memulai build, pemantauan komit, memicu peringatan ...

Itu ditulis dan mudah diperluas dalam Python.

ERRBOT tersedia sebagai perangkat lunak open-source dan dirilis di bawah lisensi GPL V3.

Fitur

Dukungan server obrolan

Bawaan

• Dukungan IRC
• Dukungan Telegram
• Dukungan XMPP

Dengan add-on

• Dukungan kendur (lihat instruksi)
• Perselisihan (lihat instruksi)
• Dukungan gitter (lihat instruksi)
• WebEx (lihat instruksi)
• Paling penting (lihat instruksi)
• Rocketchat (lihat instruksi)
• Skype (lihat instruksi)
• TOX (lihat instruksi)
• VK (lihat instruksi)
• Zulip (lihat instruksi)

Administrasi

Setelah pemasangan awal dan pengaturan keamanan, Errbot dapat dikelola dengan hanya mengobrol ke bot (chatops).

• Instal/Uninstall/Update/Enable/Nonaktif
• Plugin dapat dikonfigurasi dari obrolan
• Langsung bot untuk bergabung/meninggalkan Multi Chatroom (MUC)
• Keamanan: Fitur Kontrol ACL (Hak Admin/Pengguna per perintah)
• Cadangan: Perintah Terpadu! Cadangan membuat ekspor penuh data yang ada.
• Log: Dapat diperiksa dari obrolan atau dialirkan ke Sentry.

Fitur Pengembang

• Sangat mudah diperpanjang di Python! (Lihat di bawah)
• Penyimpanan presetup untuk setiap plugin yaitu self['foo'] = 'bar' tetap ada nilainya.
• Percakapan mengalir untuk melacak status percakapan dari pengguna.
• Dukungan WebHook Callbacks
• Mendukung format ekstra markdown dengan tabel, gambar tertanam, tautan dll.
• Helper Konfigurasi untuk memungkinkan plugin Anda dikonfigurasi dengan obrolan
• Konsol Pengembangan Teks/Debug
• Dokumen Diri: Docstrings Anda menjadi bantuan secara otomatis
• Sub -perintah dan berbagai opsi parsing arg tersedia (RE, tipe baris perintah)
• Dukungan Polling: Anda dapat mengatur plugin untuk melakukan sesuatu secara berkala
• Backend tes ujung ke ujung
• rendering kartu di bawah kendur

Komunitas dan dukungan

Kalau sudah:

• Pertanyaan singkat, jangan ragu untuk bergabung dengan kami saat mengobrol di Errbotio/Errbot di Gitter.
• Pertanyaan Pengembangan Plugin Harap gunakan StackOverflow dengan tag errbot dan python.
• Bug untuk melaporkan atau permintaan fitur, silakan gunakan halaman Proyek GitHub kami.

Anda juga dapat melakukan ping kami di Twitter dengan tagar #errbot .

Instalasi

Prasyarat

ERRBOT berjalan di bawah Python 3.6+ di Linux, Windows dan Mac. Untuk beberapa sistem obrolan, Anda akan memerlukan kunci atau login untuk bot Anda untuk mengaksesnya.

QuickStart

Kami merekomendasikan untuk mengatur virtualEnv.

1. Instal errbot dari PIP
2. Buat direktori di suatu tempat (di sini disebut errbot) untuk meng -host file data errbot
3. Inisialisasi direktori
4. Cobalah errbot dalam mode teks

$ pip install errbot
$ mkdir errbot ; cd errbot
$ errbot --init
$ errbot

Ini akan menunjukkan kepada Anda prompt >>> sehingga Anda dapat berbicara dengan bot Anda secara langsung! Coba! Bantu untuk memulai.

Menambahkan dukungan untuk sistem obrolan

Untuk built-in, cukup gunakan salah satu opsi Telegram, IRC, XMPP dengan PIP, Anda masih dapat melakukannya setelah instalasi awal untuk menambahkan dukungan yang hilang misalnya

 $ Pip menginstal "errbot [IRC]"

Untuk yang eksternal (slack, perselisihan, gitter, skype, dll ...), silakan ikuti halaman github masing -masing untuk instruksi.

Konfigurasi

Untuk mengonfigurasi errbot untuk terhubung ke salah satu sistem obrolan yang Anda perlukan untuk mengubah file config.py yang dihasilkan oleh errbot --inin.

Untuk membantu Anda, kami memiliki template terdokumentasi yang tersedia di sini: config-template.py.

Catatan: Bahkan jika Anda mengubah backend dari konfigurasi, Anda masih dapat menggunakan errbot -t untuk menguji instance Anda secara lokal dalam mode teks.

Memulai errbot sebagai daemon

Jika semua itu berhasil, Anda sekarang dapat menggunakan parameter -d (atau --kaemon) untuk menjalankannya dalam mode terpisah:

errbot --daemon

Berinteraksi dengan bot

Setelah memulai errbot, Anda harus menambahkan bot ke daftar teman Anda jika Anda belum melakukannya. Anda harus mengundang bot secara eksplisit ke ruang obrolan di beberapa sistem obrolan juga. Anda sekarang dapat mengirim perintah langsung ke bot!

Untuk mendapatkan daftar semua perintah yang tersedia, Anda dapat mengeluarkan:

 ! help

Jika Anda hanya ingin tahu lebih banyak tentang perintah tertentu yang dapat Anda keluarkan:

 ! help command 

Mengelola plugin

Anda dapat mengelola bot dalam obrolan satu-satu jika pegangan Anda ada di daftar Bot_Admins di config.py.

Misalnya pencarian kata kunci di repo plugin publik yang dapat Anda keluarkan:

 ! repos search jira

Untuk menginstal plugin dari daftar ini, masalah:

 ! repos install < name of repo >

Misalnya! Repo Instal errbotio/err-imageBot.

Plugin menulis

Menulis plugin Anda sendiri sangat sederhana. errbot --inin akan diinstal di subdirektori plugin plugin yang disebut err-contoh yang dapat Anda gunakan sebagai basis.

Sebagai contoh, hanya ini yang diperlukan untuk menciptakan "halo, dunia!" Plugin untuk errbot:

 from errbot import BotPlugin , botcmd

class Hello ( BotPlugin ):
    """Example 'Hello, world!' plugin for Errbot"""

    @ botcmd
    def hello ( self , msg , args ):
        """Return the phrase "Hello, world!" to you"""
        return "Hello, world!"

Plugin ini akan membuat perintah "! Halo" yang, ketika dikeluarkan, mengembalikan "Halo, dunia!" untukmu. Untuk info lebih lanjut tentang semua yang dapat Anda lakukan dengan plugin, lihat Panduan Pengembangan Plugin.

Kontribusi untuk Errbot itu sendiri

Jangan ragu untuk membayar dan mengusulkan perubahan pada GitHub