errbot

errbot

Errbot เป็น chatbot ช่วยให้คุณเริ่มสคริปต์แบบโต้ตอบจากห้องแชทของคุณด้วยเหตุผลใด ๆ : อารมณ์ขันแบบสุ่ม, Chatops, เริ่มต้นสร้าง, ตรวจสอบการกระทำ, การแจ้งเตือน ...

มันเขียนและขยายได้ง่ายใน Python

ERRBOT มีให้บริการเป็นซอฟต์แวร์โอเพ่นซอร์สและเปิดตัวภายใต้ใบอนุญาต GPL V3

คุณสมบัติ

สนับสนุนเซิร์ฟเวอร์แชท

ในตัว

• สนับสนุน IRC
• การสนับสนุนโทรเลข
• การสนับสนุน XMPP

ด้วย add-on

• การสนับสนุนหย่อน (ดูคำแนะนำ)
• Discord (ดูคำแนะนำ)
• สนับสนุน Gitter (ดูคำแนะนำ)
• WebEx (ดูคำแนะนำ)
• สำคัญที่สุด (ดูคำแนะนำ)
• Rocketchat (ดูคำแนะนำ)
• Skype (ดูคำแนะนำ)
• TOX (ดูคำแนะนำ)
• VK (ดูคำแนะนำ)
• Zulip (ดูคำแนะนำ)

การบริหาร

หลังจากการติดตั้งครั้งแรกและการตั้งค่าความปลอดภัย Errbot สามารถจัดการได้โดยเพียงแค่สนทนากับบอท (Chatops)

• ติดตั้ง/ถอนการติดตั้ง/อัปเดต/เปิดใช้งาน/ปิดการใช้งานปลั๊กอินส่วนตัวหรือสาธารณะที่โฮสต์บน Git
• ปลั๊กอินสามารถกำหนดค่าได้จากการแชท
• กำกับบอทเพื่อเข้าร่วม/ปล่อยห้องแชทผู้ใช้หลายตัว (MUC)
• ความปลอดภัย: คุณสมบัติการควบคุม ACL (ผู้ดูแลระบบ/สิทธิ์ผู้ใช้ต่อคำสั่ง)
• การสำรองข้อมูล: คำสั่งแบบบูรณาการ! การสำรองข้อมูลสร้างการส่งออกข้อมูลที่คงอยู่เต็มรูปแบบ
• บันทึก: สามารถตรวจสอบได้จากการแชทหรือสตรีมไปยัง Sentry

คุณสมบัติของนักพัฒนา

• ง่ายมากที่จะขยายใน Python! (ดูด้านล่าง)
• ที่เก็บข้อมูลที่ตั้งไว้ล่วงหน้าสำหรับปลั๊กอินทุกตัวคือ self['foo'] = 'bar' ยังคงมีค่าอยู่
• การสนทนาไหลเพื่อติดตามสถานะการสนทนาจากผู้ใช้
• การสนับสนุนการโทรแบบ Webhook
• รองรับการจัดรูปแบบการจัดรูปแบบ markdown ด้วยตารางภาพฝังลิงค์ ฯลฯ
• ตัวช่วยการกำหนดค่าเพื่อให้ปลั๊กอินของคุณกำหนดค่าโดยการแชท
• การพัฒนาข้อความ/คอนโซลดีบั๊ก
• เอกสารด้วยตนเอง: เอกสารของคุณกลายเป็นความช่วยเหลือโดยอัตโนมัติ
• คำสั่งย่อยและตัวเลือกการแยกวิเคราะห์ ARG ต่าง ๆ มีอยู่ (RE, ประเภทบรรทัดคำสั่ง)
• การสนับสนุนการสำรวจ: คุณสามารถตั้งค่าปลั๊กอินเพื่อทำอะไรเป็นระยะ ๆ
• จบการทดสอบแบ็กเอนด์
• การแสดงผลบัตรภายใต้ Slack

ชุมชนและการสนับสนุน

ถ้าคุณมี:

• คำถามด่วนอย่าลังเลที่จะเข้าร่วมกับเราในการแชทที่ Errbotio/Errbot บน Gitter
• คำถามการพัฒนาปลั๊กอินโปรดใช้ stackoverflow กับแท็ก Errbot และ Python
• ข้อผิดพลาดในการรายงานหรือคำขอคุณสมบัติโปรดใช้หน้าโครงการ GitHub ของเรา

นอกจากนี้คุณยังสามารถ ping เราบน Twitter ด้วยแฮชแท็ก #errbot

การติดตั้ง

ข้อกำหนดเบื้องต้น

Errbot ทำงานภายใต้ Python 3.6+ บน Linux, Windows และ Mac สำหรับระบบการแชทบางอย่างคุณจะต้องมีคีย์หรือเข้าสู่ระบบเพื่อให้บอทของคุณเข้าถึงได้

เร็ว

เราแนะนำให้ตั้งค่า Virtualenv

1. ติดตั้ง errbot จาก pip
2. สร้างไดเรกทอรีที่ไหนสักแห่ง (ที่นี่เรียกว่า errbot) เพื่อโฮสต์ไฟล์ข้อมูลของ Errbot
3. เริ่มต้นไดเร็กทอรี
4. ลองใช้ errbot ในโหมดข้อความ

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

มันจะแสดงให้คุณทราบ >>> เพื่อให้คุณสามารถคุยกับบอทของคุณได้โดยตรง! ลอง! ช่วยในการเริ่มต้น

การเพิ่มการสนับสนุนสำหรับระบบแชท

สำหรับตัวในตัวเพียงใช้หนึ่งในตัวเลือกเหล่านั้น Telegram, IRC, XMPP กับ PIP คุณยังสามารถทำได้หลังจากการติดตั้งครั้งแรกเพื่อเพิ่มการสนับสนุนที่ขาดหายไปเช่น

 $ PIP ติดตั้ง "errbot [irc]"

สำหรับคนภายนอก (หย่อน, discord, gitter, skype, ฯลฯ ... ) โปรดปฏิบัติตามหน้า github ของพวกเขาสำหรับคำแนะนำ

การกำหนดค่า

ในการกำหนดค่า ERRBOT เพื่อเชื่อมต่อกับหนึ่งในระบบแชทเหล่านั้นคุณจะต้องปรับแต่งไฟล์ config.py ที่สร้างขึ้นโดย Errbot -Init

เพื่อช่วยคุณเรามีเทมเพลตเอกสารที่มีอยู่ที่นี่: config-template.py

หมายเหตุ: แม้ว่าคุณจะเปลี่ยนแบ็กเอนด์จากการกำหนดค่าคุณยังสามารถใช้ errbot -t เพื่อทดสอบอินสแตนซ์ของคุณในโหมดข้อความ

เริ่มต้น errbot เป็น daemon

หากทั้งหมดที่ใช้งานได้ตอนนี้คุณสามารถใช้พารามิเตอร์ -D (หรือ -Daemon) เพื่อเรียกใช้ในโหมดเดี่ยว:

errbot --daemon

การโต้ตอบกับบอท

หลังจากเริ่มต้น Errbot คุณควรเพิ่มบอทลงในรายชื่อเพื่อนของคุณหากคุณยังไม่ได้ทำ คุณจะต้องเชิญบอทไปที่ห้องแชทอย่างชัดเจนในบางระบบแชทด้วย ตอนนี้คุณสามารถส่งคำสั่งโดยตรงไปยังบอท!

หากต้องการรับรายการคำสั่งที่มีอยู่ทั้งหมดคุณสามารถออก:

 ! help

หากคุณเพียงแค่ต้องการทราบข้อมูลเพิ่มเติมเกี่ยวกับคำสั่งเฉพาะคุณสามารถออกได้:

 ! help command 

การจัดการปลั๊กอิน

คุณสามารถจัดการบอทได้ในการแชทแบบตัวต่อตัวหากด้ามจับของคุณอยู่ในรายการ bot_admins ใน config.py

ตัวอย่างเช่นการค้นหาคำหลักใน repos ปลั๊กอินสาธารณะคุณสามารถออก:

 ! repos search jira

ในการติดตั้งปลั๊กอินจากรายการนี้ปัญหา:

 ! repos install < name of repo >

ตัวอย่างเช่น repos ติดตั้ง errbotio/err-imageBot

การเขียนปลั๊กอิน

การเขียนปลั๊กอินของคุณเองนั้นง่ายมาก ERRBOT-InIT จะติดตั้งในไดเรกทอรีย่อยปลั๊กอินปลั๊กอินที่เรียกว่า Err-Example ที่คุณสามารถใช้เป็นฐาน

ตัวอย่างนี่คือทั้งหมดที่ใช้ในการสร้าง "สวัสดีโลก!" ปลั๊กอินสำหรับ 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!"

ปลั๊กอินนี้จะสร้างคำสั่ง "! สวัสดี" ซึ่งเมื่อออกให้ส่งคืน "สวัสดีโลก!" ถึงคุณ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับทุกสิ่งที่คุณสามารถทำได้กับปลั๊กอินดูคู่มือการพัฒนาปลั๊กอิน

มีส่วนร่วมในการทำผิดพลาด

อย่าลังเลที่จะแยกและเสนอการเปลี่ยนแปลง GitHub