errbot

Errbot

Errbot은 챗봇입니다. 무작위 유머, 채팅, 빌드 시작, 커밋 모니터링, 경고 트리거 등 어떤 이유로든 채팅방에서 대화형으로 스크립트를 시작할 수 있습니다.

Python으로 작성되었으며 쉽게 확장 가능합니다.

Errbot은 오픈 소스 소프트웨어로 제공되며 GPL v3 라이센스에 따라 출시됩니다.

특징

채팅 서버 지원

내장

• IRC 지원
• 전보 지원
• XMPP 지원

추가 기능 포함

• Slack 지원(지침 참조)
• 불일치(지침 참조)
• Gitter 지원(지침 참조)
• Webex(지침 참조)
• 중요(지침 참조)
• RocketChat(지침 참조)
• 스카이프(지침 참조)
• TOX(지침 참조)
• VK(지침 참조)
• Zulip (지침 참조)

관리

초기 설치 및 보안 설정 후 Errbot은 봇(chatops)과 채팅만으로 관리할 수 있습니다.

• Git에 호스팅된 비공개 또는 공개 플러그인 설치/제거/업데이트/활성화/비활성화
• 플러그인은 채팅에서 구성할 수 있습니다
• 봇이 다중 사용자 채팅방(MUC)에 참여/나가도록 지시합니다.
• 보안: ACL 제어 기능(명령별 관리자/사용자 권한)
• 백업: 통합 명령 !backup은 지속된 데이터의 전체 내보내기를 생성합니다.
• 로그: 채팅에서 검사하거나 Sentry로 스트리밍할 수 있습니다.

개발자 기능

• Python에서는 확장이 매우 쉽습니다! (아래 참조)
• 모든 플러그인에 대한 사전 설정 저장소, 즉 self['foo'] = 'bar' 값을 유지합니다.
• 사용자의 대화 상태를 추적하는 대화 흐름입니다.
• 웹훅 콜백 지원
• 테이블, 삽입된 이미지, 링크 등을 포함한 마크다운 추가 형식을 지원합니다.
• 채팅을 통해 플러그인을 구성할 수 있도록 하는 구성 도우미
• 텍스트 개발/디버그 콘솔
• 자체 문서화: 독스트링이 자동으로 도움말이 됩니다.
• 하위 명령 및 다양한 인수 구문 분석 옵션을 사용할 수 있습니다. (re, 명령줄 유형)
• 폴링 지원: 주기적으로 작업을 수행하도록 플러그인을 설정할 수 있습니다.
• 엔드투엔드 테스트 백엔드
• Slack에서의 카드 렌더링

커뮤니티 및 지원

다음과 같은 경우:

• 빠른 질문이 있으시면 언제든지 Gitter의 errbotio/errbot 채팅에 참여해 주세요.
• 플러그인 개발 질문이 있으시면 errbot 및 python 태그와 함께 Stackoverflow를 사용하세요.
• 보고할 버그나 기능 요청은 GitHub 프로젝트 페이지를 이용해 주세요.

해시태그 #errbot 사용하여 Twitter에서 우리를 핑할 수도 있습니다.

설치

전제 조건

Errbot은 Linux, Windows 및 Mac의 Python 3.6+에서 실행됩니다. 일부 채팅 시스템의 경우 봇이 액세스하려면 키나 로그인이 필요합니다.

빠른 시작

virtualenv를 설정하는 것이 좋습니다.

1. pip에서 errbot 설치
2. Errbot의 데이터 파일을 호스팅할 디렉터리(여기에서는 errbot이라고 함)를 만듭니다.
3. 디렉토리 초기화
4. 텍스트 모드에서 Errbot을 사용해 보세요

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

프롬프트 >>>가 표시되므로 봇과 직접 대화할 수 있습니다! 시작하려면 !help를 사용해 보세요.

채팅 시스템에 대한 지원 추가

내장된 기능의 경우 pip와 함께 telegram, IRC, XMPP 옵션 중 하나를 사용하면 됩니다. 예를 들어 누락된 지원을 추가하기 위해 초기 설치 후에도 계속 수행할 수 있습니다.

 $ pip install "errbot[irc]"

외부 항목(Slack, Discord, Gitter, Skype 등)의 경우 해당 github 페이지의 지침을 따르세요.

구성

이러한 채팅 시스템 중 하나에 연결하도록 Errbot을 구성하려면 errbot --init에 의해 생성된 config.py 파일을 조정해야 합니다.

도움을 드리기 위해 문서화된 템플릿(config-template.py)을 제공합니다.

참고: 구성에서 BACKEND를 변경한 경우에도 errbot -T를 사용하여 텍스트 모드에서 로컬로 인스턴스를 테스트할 수 있습니다.

Errbot을 데몬으로 시작하기

모두 작동했다면 이제 -d(또는 --daemon) 매개변수를 사용하여 분리 모드에서 실행할 수 있습니다.

errbot --daemon

봇과 상호작용

Errbot을 시작한 후 아직 봇을 친구 목록에 추가하지 않았다면 추가해야 합니다. 일부 채팅 시스템의 채팅방에도 봇을 명시적으로 초대해야 합니다. 이제 봇에 직접 명령을 보낼 수 있습니다!

사용 가능한 모든 명령 목록을 얻으려면 다음을 실행할 수 있습니다.

 ! help

특정 명령에 대해 더 자세히 알고 싶다면 다음을 실행할 수 있습니다.

 ! help command 

플러그인 관리

핸들이 config.py의 BOT_ADMINS 목록에 있으면 일대일 채팅으로 봇을 관리할 수 있습니다.

예를 들어 공개 플러그인 저장소에서 키워드 검색을 수행하려면 다음을 실행할 수 있습니다.

 ! repos search jira

이 목록에서 플러그인을 설치하려면 다음을 실행하세요.

 ! repos install < name of repo >

예를 들어 !repos는 errbotio/err-imagebot을 설치합니다.

플러그인 작성

자신만의 플러그인을 작성하는 것은 매우 간단합니다. errbot --init는 기본으로 사용할 수 있는 err-example이라는 플러그인을 플러그인 하위 디렉터리에 설치합니다.

예를 들어, 이것이 "Hello, world!"를 생성하는 데 필요한 전부입니다. 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!"

이 플러그인은 실행 시 "Hello, world!"를 반환하는 "!hello" 명령을 생성합니다. 당신에게. 플러그인으로 할 수 있는 모든 것에 대한 자세한 내용은 플러그인 개발 가이드를 참조하세요.

Errbot 자체에 대한 기여

github에서 자유롭게 포크하고 변경 사항을 제안하세요.