errbot

errbot

Errbot은 챗봇입니다. 임의의 유머, 채팅 탑, 빌드 시작, 커밋 모니터링, 경고 트리거 ...

파이썬으로 작성되고 쉽게 확장 가능합니다.

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

특징

채팅 서버 지원

내장

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

애드온과 함께

• 여유 지원 (지침 참조)
• 불화 (지침 참조)
• Gitter 지원 (지침 참조)
• webex (지침 참조)
• 가장 중요한 (지침 참조)
• Rocketchat (지침 참조)
• Skype (지침 참조)
• Tox (지침 참조)
• VK (지침 참조)
• Zulip (지침 참조)

관리

초기 설치 및 보안 설정 후 봇 (Chatops)과 채팅하면 Errbot을 관리 할 수 ​​있습니다.

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

개발자 기능

• 파이썬에서 확장하기가 매우 쉽습니다! (아래 참조)
• 모든 플러그인에 대한 사전 설정 저장소, 즉 self['foo'] = 'bar' 값을 지속합니다.
• 대화가 사용자로부터 대화 상태를 추적하는 데 흐릅니다.
• Webhook 콜백 지원
• 테이블, 임베디드 이미지, 링크 등으로 Markdown Extras 서식을 지원합니다.
• 플러그인을 채팅으로 구성 할 수 있도록 구성 헬퍼
• 텍스트 개발/디버그 콘솔
• 자체 문서 : Docstring은 자동으로 도움이됩니다
• 하위 명령 및 다양한 ARG 구문 분석 옵션을 사용할 수 있습니다 (Re, Command Line 유형)
• 폴링 지원 : 정기적으로 무언가를하기 위해 플러그인을 설정할 수 있습니다.
• 끝에서 종료 테스트 백엔드
• 슬랙 하에서 카드 렌더링

커뮤니티와 지원

당신이있는 경우 :

• 빠른 질문은 Gitter의 Errbotio/Errbot에서 채팅에 참여하십시오.
• 플러그인 개발 질문은 Tags errbot 및 Python과 함께 StackoverFlow를 사용하십시오.
• 보고하는 버그 또는 기능 요청은 GitHub 프로젝트 페이지를 사용하십시오.

해시 태그 #errbot 로 트위터에서 우리를 핑할 수도 있습니다.

설치

전제 조건

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

QuickStart

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

1. PIP에서 Errbot을 설치하십시오
2. Errbot의 데이터 파일을 호스팅하기 위해 어딘가 (여기에서 Errbot이라고 함) 디렉토리를 만듭니다.
3. 디렉토리를 초기화하십시오
4. 텍스트 모드에서 errbot을 사용해보십시오

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

봇과 직접 대화 할 수 있도록 프롬프트가 표시됩니다. 시도해보십시오! 시작하십시오.

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

내장 인 경우 PIP와 함께 해당 옵션 Telegram, IRC, XMPP 중 하나를 사용하면 초기 설치 후에도 누락 된 지원을 추가하여 여전히 수행 할 수 있습니다.

 $ pip 설치 "errbot [irc]

외부 (슬랙, 불화, Gitter, Skype 등)의 경우 각 GitHub 페이지를 따르십시오.

구성

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

도움을주기 위해 여기에는 문서화 된 템플릿이 있습니다 : config-template.py.

참고 : 구성에서 백엔드를 변경하더라도 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이라는 플러그인을 설치합니다.

예를 들어, 이것이 "안녕하세요, 세계"를 만드는 데 필요한 전부입니다. 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"명령을 만듭니다. 발행되면 "안녕하세요, 세계!" 당신에게. 플러그인으로 수행 할 수있는 모든 것에 대한 자세한 내용은 플러그인 개발 안내서를 참조하십시오.

Errbot 자체에 기여

Github의 변경 사항을 자유롭게 포크하고 제안하십시오