errbot

kesalahan bot

Errbot adalah bot obrolan. Ini memungkinkan Anda untuk memulai skrip secara interaktif dari ruang obrolan Anda untuk alasan apa pun: humor acak, obrolan, memulai pembangunan, memantau komitmen, memicu peringatan...

Itu ditulis dan mudah dikembangkan dengan Python.

Errbot tersedia sebagai perangkat lunak sumber terbuka dan dirilis di bawah lisensi GPL v3.

Fitur

Dukungan server obrolan

Bawaan

• dukungan IRC
• Dukungan Telegram
• dukungan XMPP

Dengan tambahan

• Dukungan Slack (Lihat instruksi)
• Perselisihan (Lihat instruksi)
• Dukungan Gitter (Lihat instruksi)
• Webex (Lihat instruksi)
• Yang paling penting (Lihat instruksi)
• RocketChat (Lihat instruksi)
• Skype (Lihat instruksi)
• TOX (Lihat instruksi)
• VK (Lihat instruksi)
• Zulip (Lihat instruksi)

Administrasi

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

• instal/uninstall/perbarui/aktifkan/nonaktifkan plugin pribadi atau publik yang dihosting di git
• plugin dapat dikonfigurasi dari obrolan
• mengarahkan bot untuk bergabung/keluar dari Multi User Chatroom (MUC)
• Keamanan: Fitur kontrol ACL (admin/hak pengguna per perintah)
• cadangan: perintah terintegrasi !backup membuat ekspor penuh data yang disimpan.
• log: dapat diperiksa dari obrolan atau dialirkan ke Sentry.

Fitur pengembang

• Sangat mudah untuk diperluas dengan Python! (lihat di bawah)
• Penyimpanan preset untuk setiap plugin yaitu self['foo'] = 'bar' tetap mempertahankan nilainya.
• Alur percakapan untuk melacak status percakapan dari pengguna.
• Dukungan panggilan balik webhook
• mendukung pemformatan tambahan penurunan harga dengan tabel, gambar tersemat, tautan, dll.
• pembantu konfigurasi untuk memungkinkan plugin Anda dikonfigurasi melalui obrolan
• Konsol pengembangan/debug teks
• Mendokumentasikan diri sendiri: dokumen Anda menjadi bantuan secara otomatis
• subperintah dan berbagai opsi penguraian arg tersedia (re, tipe baris perintah)
• dukungan polling: Anda dapat mengatur plugin untuk melakukan sesuatu secara berkala
• backend pengujian ujung ke ujung
• rendering kartu di bawah Slack

Komunitas dan dukungan

Kalau sudah:

• pertanyaan singkat jangan ragu untuk bergabung dengan kami dalam obrolan di errbotio/errbot di Gitter.
• pertanyaan pengembangan plugin silakan gunakan Stackoverflow dengan tag errbot dan python.
• bug untuk dilaporkan atau permintaan fitur, silakan gunakan halaman proyek GitHub kami.

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

Instalasi

Prasyarat

Errbot berjalan di bawah Python 3.6+ di Linux, Windows dan Mac. Untuk beberapa sistem obrolan, Anda memerlukan kunci atau login agar bot Anda dapat mengaksesnya.

Mulai cepat

Kami merekomendasikan untuk menyiapkan virtualenv.

1. Instal errbot dari pip
2. Buatlah direktori di suatu tempat (di sini disebut errbot) untuk menampung file data Errbot
3. Inisialisasi direktori
4. Cobalah Errbot dalam mode teks

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

Ini akan menampilkan prompt >>> sehingga Anda dapat berbicara dengan bot Anda secara langsung! Coba !help untuk memulai.

Menambahkan dukungan untuk sistem obrolan

Untuk bawaan cukup gunakan salah satu opsi telegram, IRC, XMPP dengan pip, Anda masih dapat melakukannya setelah instalasi awal untuk menambahkan dukungan yang hilang misalnya

 $ pip instal "errbot[irc]"

Untuk yang eksternal (Slack, Discord, Gitter, Skype, dll...), silahkan ikuti halaman github masing-masing untuk petunjuknya.

Konfigurasi

Untuk mengonfigurasi Errbot agar terhubung ke salah satu sistem obrolan tersebut, Anda perlu mengubah file config.py yang dihasilkan oleh errbot --init.

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

Catatan: meskipun 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 semuanya berhasil, kini Anda dapat menggunakan parameter -d (atau --daemon) untuk menjalankannya dalam mode terpisah:

errbot --daemon

Berinteraksi dengan Bot

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

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

 ! help

Jika Anda hanya ingin mengetahui lebih banyak tentang perintah tertentu, Anda dapat mengeluarkan:

 ! help command 

Mengelola plugin

Anda dapat mengelola bot dalam obrolan satu lawan satu jika nama pengguna Anda ada di daftar BOT_ADMINS di config.py.

Misalnya untuk pencarian kata kunci di repo plugin publik Anda dapat mengeluarkan:

 ! repos search jira

Untuk menginstal plugin dari daftar ini, jalankan:

 ! repos install < name of repo >

Misalnya !repos instal errbotio/err-imagebot.

Menulis plugin

Menulis plugin Anda sendiri sangatlah sederhana. errbot --init akan menginstal di subdirektori plugin sebuah plugin bernama err-example yang dapat Anda gunakan sebagai basis.

Sebagai contoh, hanya ini yang diperlukan untuk membuat pesan "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 "!hello" yang ketika dikeluarkan akan mengembalikan "Hello, world!" untukmu. Untuk informasi lebih lanjut tentang segala hal yang dapat Anda lakukan dengan plugin, lihat panduan pengembangan plugin.

Kontribusi untuk Errbot itu sendiri

Jangan ragu untuk melakukan fork dan mengusulkan perubahan di github