mmpy_bot

문서 읽기에서 문서를 확인할 수 있습니다.

설명

Mattermost를 위한 Python 기반 채팅 봇 프레임워크입니다. 이 봇 프레임워크의 코드는 v2.0.0에서 대폭 리팩터링되었으며 Python 3.8 이상에서만 작동합니다. Python 2 및 Python3 < 3.8을 지원하려면 v1.3.9 이하 버전을 사용하세요.

특징

• Mattermost WebSocket API(V4.0.0) 기반
• 간단한 플러그인 메커니즘
• 동시 메시지 처리
• 첨부파일 지원
• 연결이 끊긴 후 Mattermost에 자동으로 다시 연결

v2.x에 추가된 추가 기능:

• 멀티스레딩 및 비동기 실행
• 통합 웹훅 서버
• 클릭 기능 지원
• 작업 예약

호환성

가장 중요한	mmpy_bot
>= 4.0	> 1.2.0
< 4.0	지원되지 않는

설치

️ 경고: Python 버전이 3.8 미만인 경우 pip는 v1.x를 사용합니다!

v2.x(최신)

 pip install mmpy-bot

v1.3.9(강제 레거시)

 pip install mmpy-bot==1.3.9

사용법(v2.x)

등록

먼저 Mattermost 서버에 봇 계정을 만들어야 합니다. 참고: 시스템 콘솔에서 봇 계정 생성 활성화를 활성화해야 합니다.

1. 관리자 권한이 있는 사용자로 Mattermost 서버에 로그인하세요.
2. 통합 -> 봇 계정 -> 봇 계정 추가로 이동하세요.
3. 구성 옵션을 입력하고 생성 시 액세스 토큰을 기록해 두십시오.

임시 메시지 응답과 같은 일부 API 기능을 사용하려면 봇이 시스템 관리자 그룹의 일부여야 하지만 대부분의 API 기능은 일반 회원 계정 역할로 작동합니다. 일부 API 기능이 작동하지 않는 경우 적절한 권한이 부족하기 때문일 수 있습니다.

봇 구성 및 실행

Mattermost 서버 및 봇 계정 설정을 정의하고 원하는 모듈을 가져오는 진입점 파일을 생성하거나 제공된 파일을 복사하세요.

예 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 )에서 실행 가능 비트를 설정하고 명령 프롬프트에서 봇을 시작합니다. 이제 Mattermost 클라이언트에서 봇과 대화할 수 있습니다!

봇을 최대한 활용하려면 자신만의 플러그인을 작성해야 합니다. 시작하려면 플러그인 문서를 참조하세요.

우리에게 이야기하세요

커뮤니케이션을 위한 기본 채널은 이슈 또는 풀 요청을 통한 GitHub이지만 실시간 상호 작용을 위해 Discord에서 우리 중 일부를 찾을 수도 있습니다.