mmpy_bot

Dokumentasi tersedia di Read the Docs.

Keterangan

Kerangka kerja bot obrolan berbasis Python untuk Mattermost. Kode untuk kerangka bot ini telah banyak diperhitungkan ulang di v2.0.0 dan hanya akan berfungsi dengan Python 3.8 atau lebih tinggi. Untuk dukungan Python 2 dan Python3 <3.8, silakan gunakan versi v1.3.9 atau lebih rendah.

Fitur

• Berdasarkan API WebSocket Paling Penting (V4.0.0)
• Mekanisme plugin sederhana
• Penanganan pesan secara bersamaan
• Dukungan lampiran
• Sambungkan kembali secara otomatis ke Mattermost setelah koneksi terputus

Fitur tambahan ditambahkan di v2.x:

• Eksekusi multi-threading dan asyncio
• Server webhook terintegrasi
• Dukungan untuk fungsi klik
• Penjadwalan pekerjaan

Kesesuaian

Yang paling penting	mmpy_bot
>= 4.0	> 1.2.0
< 4.0	tidak didukung

Instalasi

️ Peringatan: pip akan mengambil v1.x jika versi Python Anda kurang dari 3.8!

v2.x (terbaru)

 pip install mmpy-bot

v1.3.9 (warisan paksa)

 pip install mmpy-bot==1.3.9

Penggunaan (v2.x)

Pendaftaran

Pertama, Anda perlu membuat akun bot di server Mattermost Anda. Catatan: Aktifkan Pembuatan Akun Bot harus diaktifkan di Konsol Sistem

1. Masuk ke server Paling Penting Anda sebagai pengguna dengan hak administratif.
2. Navigasi ke Integrasi -> Akun Bot -> Tambahkan Akun Bot
3. Isi opsi konfigurasi dan setelah pembuatan catat Token Akses

Perhatikan bahwa beberapa fungsi API, seperti balasan pesan singkat, akan memerlukan bot untuk menjadi bagian dari grup Admin Sistem , namun sebagian besar fungsi API akan bekerja dengan peran akun Anggota biasa. Perlu diketahui bahwa jika beberapa fungsi API tidak berfungsi, hal ini mungkin disebabkan oleh kurangnya izin yang sesuai.

Konfigurasikan dan jalankan bot

Buat file titik masuk (atau salin yang disediakan), yang menentukan pengaturan server dan akun bot Mattermost Anda dan mengimpor modul yang diinginkan.

Contoh my_bot.py :

 #!/usr/bin/env python

from mmpy_bot import Bot , Settings
from my_plugin import MyPlugin

bot = Bot (
    settings = Settings (
        MATTERMOST_URL = "http://chat.example.com" ,
        MATTERMOST_PORT = 443 ,
        BOT_TOKEN = "a69155mvlsobcnqpfdceqihaa" ,
        BOT_TEAM = "test" ,
        SSL_VERIFY = True ,
    ),  # Either specify your settings here or as environment variables.
    plugins = [ MyPlugin ()],  # Add your own plugins here.
)
bot . run ()

Atur bit yang dapat dieksekusi pada file titik masuk (yaitu chmod +x my_bot.py ) dan mulai bot Anda dari command prompt. Sekarang Anda dapat berbicara dengan bot Anda di klien Mattermost Anda!

Untuk mendapatkan hasil maksimal dari bot Anda, Anda perlu menulis plugin Anda sendiri. Lihat Dokumentasi Plugin untuk memulai.

Bicaralah dengan kami

Saluran utama untuk komunikasi adalah GitHub melalui Masalah atau permintaan Tarik, tetapi Anda juga dapat menemukan beberapa dari kami di Discord untuk interaksi waktu nyata.