เอกสารมีอยู่ที่ Read the Docs
กรอบงานแชทบอทที่ใช้ Python สำหรับ Mattermost โค้ดสำหรับเฟรมเวิร์กบอทนี้ได้รับการปรับโครงสร้างใหม่อย่างหนักในเวอร์ชัน 2.0.0 และจะใช้งานได้กับ Python 3.8 หรือสูงกว่าเท่านั้น สำหรับการรองรับ Python 2 และ Python3 < 3.8 โปรดใช้เวอร์ชัน v1.3.9 หรือต่ำกว่า
สิ่งที่สำคัญที่สุด | mmpy_bot |
---|---|
>=4.0 | > 1.2.0 |
<4.0 | ไม่รองรับ |
pip install mmpy-bot
pip install mmpy-bot==1.3.9
ก่อนอื่นคุณต้องสร้างบัญชีบอทบนเซิร์ฟเวอร์ที่สำคัญที่สุดของคุณ หมายเหตุ: ต้องเปิดใช้งานการ เปิดใช้งานการสร้างบัญชี Bot ภายใต้คอนโซลระบบ
โปรดทราบว่าฟังก์ชัน API บางอย่าง เช่น การตอบกลับข้อความชั่วคราว จะกำหนดให้บอทเป็นส่วนหนึ่งของกลุ่ม ผู้ดูแลระบบ อย่างไรก็ตาม ฟังก์ชัน API ส่วนใหญ่จะทำงานร่วมกับบทบาทบัญชี สมาชิก ปกติ โปรดทราบว่าหากฟังก์ชัน API บางอย่างไม่ทำงาน อาจเกิดจากการขาดสิทธิ์ที่เหมาะสม
สร้างไฟล์จุดเข้าใช้งาน (หรือคัดลอกไฟล์ที่ให้มา) ที่กำหนดการตั้งค่าบัญชีเซิร์ฟเวอร์และบอทที่สำคัญที่สุดของคุณ และนำเข้าโมดูลที่ต้องการ
ตัวอย่าง 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 ()
ตั้งค่าบิตปฏิบัติการบนไฟล์จุดเข้าใช้งาน (เช่น chmod +x my_bot.py
) และเริ่มบอทของคุณจากพรอมต์คำสั่ง ตอนนี้คุณสามารถพูดคุยกับบอทของคุณในไคลเอนต์ที่สำคัญที่สุดของคุณได้แล้ว!
เพื่อที่จะได้รับประโยชน์สูงสุดจากบอทของคุณ คุณจะต้องเขียนปลั๊กอินของคุณเอง โปรดดูเอกสารประกอบปลั๊กอินเพื่อเริ่มต้น
ช่องทางหลักในการสื่อสารคือ GitHub ผ่านปัญหาหรือคำขอดึง แต่คุณอาจพบพวกเราบางคนใน Discord เพื่อการโต้ตอบแบบเรียลไทม์