errbot

Errbot

Errbot é um chatbot. Ele permite que você inicie scripts interativamente a partir de suas salas de chat por qualquer motivo: humor aleatório, chatops, início de uma compilação, monitoramento de commits, disparo de alertas...

Está escrito e facilmente extensível em Python.

Errbot está disponível como software de código aberto e lançado sob a licença GPL v3.

Características

Suporte a servidores de bate-papo

Integrado

• Suporte IRC
• Suporte de telegrama
• Suporte XMPP

Com complementos

• Suporte Slack (ver instruções)
• Discórdia (ver instruções)
• Suporte Gitter (veja as instruções)
• Webex (ver instruções)
• Mais importante (ver instruções)
• RocketChat (ver instruções)
• Skype (veja instruções)
• TOX (ver instruções)
• VK (ver instruções)
• Zulip (ver instruções)

Administração

Após a instalação inicial e configuração de segurança, o Errbot pode ser administrado apenas conversando com o bot (chatops).

• instalar/desinstalar/atualizar/ativar/desativar plug-ins privados ou públicos hospedados no git
• plugins podem ser configurados no chat
• direcione o bot para entrar/sair de salas de bate-papo multiusuário (MUC)
• Segurança: recurso de controle ACL (direitos de administrador/usuário por comando)
• backup: um comando integrado !backup cria uma exportação completa de dados persistentes.
• logs: podem ser inspecionados no chat ou transmitidos para o Sentry.

Recursos do desenvolvedor

• Muito fácil de estender em Python! (Veja abaixo)
• Armazenamento pré-configurado para cada plugin, ou seja, self['foo'] = 'bar' persiste o valor.
• Fluxos de conversa para rastrear estados de conversa dos usuários.
• Suporte para retornos de chamada de webhook
• suporta formatação de extras de markdown com tabelas, imagens incorporadas, links etc.
• auxiliar de configuração para permitir que seu plugin seja configurado por chat
• Consoles de desenvolvimento/depuração de texto
• Autodocumentação: seus documentos se tornam ajuda automaticamente
• subcomandos e várias opções de análise de argumentos estão disponíveis (re, tipo de linha de comando)
• suporte para votação: você pode configurar um plugin para fazer algo periodicamente
• back-end de teste de ponta a ponta
• renderização de cartão no Slack

Comunidade e suporte

Se você tiver:

• uma pergunta rápida, sinta-se à vontade para se juntar a nós no chat em errbotio/errbot no Gitter.
• uma questão de desenvolvimento de plugin, use Stackoverflow com as tags errbot e python.
• um bug para relatar ou uma solicitação de recurso, use nossa página do projeto GitHub.

Você também pode nos enviar um ping no Twitter com a hashtag #errbot .

Instalação

Pré-requisitos

Errbot é executado em Python 3.6+ em Linux, Windows e Mac. Para alguns sistemas de bate-papo, você precisará de uma chave ou login do seu bot para acessá-los.

Início rápido

Recomendamos configurar um virtualenv.

1. Instale o errbot do pip
2. Crie um diretório em algum lugar (aqui chamado errbot) para hospedar os arquivos de dados do Errbot
3. Inicialize o diretório
4. Experimente o Errbot em modo texto

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

Ele mostrará um prompt >>> para que você possa falar diretamente com seu bot! Experimente !help para começar.

Adicionando suporte para um sistema de chat

Para os integrados basta usar uma dessas opções telegrama, IRC, XMPP com pip, você ainda pode fazer isso após a instalação inicial para adicionar o suporte que falta por exemplo

 $ pip instalar "errbot[irc]"

Para os externos (Slack, Discord, Gitter, Skype, etc...), siga as respectivas páginas do github para obter instruções.

Configuração

Para configurar o Errbot para se conectar a um desses sistemas de chat, você precisará ajustar o arquivo config.py gerado por errbot --init.

Para ajudá-lo, temos um modelo documentado disponível aqui: config-template.py.

Nota: mesmo que você tenha alterado o BACKEND da configuração, você ainda pode usar errbot -T para testar sua instância localmente em modo texto.

Iniciando o Errbot como um daemon

Se tudo funcionou, agora você pode usar o parâmetro -d (ou --daemon) para executá-lo em modo desanexado:

errbot --daemon

Interagindo com o bot

Depois de iniciar o Errbot, você deve adicionar o bot à sua lista de amigos, caso ainda não o tenha feito. Você também precisará convidar o bot explicitamente para salas de chat em alguns sistemas de chat. Agora você pode enviar comandos diretamente para o bot!

Para obter uma lista de todos os comandos disponíveis, você pode emitir:

 ! help

Se você deseja apenas saber mais sobre um comando específico, você pode emitir:

 ! help command 

Gerenciando plug-ins

Você pode administrar o bot em um bate-papo individual se seu identificador estiver na lista BOT_ADMINS em config.py.

Por exemplo, para pesquisar palavras-chave nos repositórios públicos de plugins, você pode emitir:

 ! repos search jira

Para instalar um plugin desta lista, emita:

 ! repos install < name of repo >

Por exemplo !repos install errbotio/err-imagebot.

Escrevendo plug-ins

Escrever seus próprios plugins é extremamente simples. errbot --init terá instalado no subdiretório plugins um plugin chamado err-example que você pode usar como base.

Por exemplo, isso é tudo o que é necessário para criar um "Olá, mundo!" plugin para 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!"

Este plugin irá criar o comando "!hello" que, quando emitido, retorna "Hello, world!" para você. Para obter mais informações sobre tudo o que você pode fazer com plug-ins, consulte o guia de desenvolvimento de plug-ins.

Contribuição para o próprio Errbot

Sinta-se à vontade para fazer um fork e propor alterações no github