errbot

Errbot

Errbot é um chatbot. Ele permite que você inicie os scripts interativamente de suas salas de bate -papo por qualquer motivo: humor aleatório, chatops, iniciando uma compilação, monitoramento, cometidos, acionando alertas ...

Está escrito e facilmente extensível em Python.

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

Características

Suporte aos servidores de bate -papo

Embutido

• Suporte do IRC
• Suporte de telegrama
• Suporte ao XMPP

Com complementos

• Suporte de folga (consulte as instruções)
• Discord (consulte as instruções)
• Suporte Gitter (consulte as instruções)
• WebEx (consulte as instruções)
• Matéria (veja instruções)
• Rocketchat (veja as instruções)
• Skype (consulte as instruções)
• Tox (consulte as instruções)
• VK (consulte as instruções)
• Zulip (consulte as instruções)

Administração

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

• Instalar/desinstalar/atualizar/enable/desativar plugins públicos ou públicos hospedados no git
• plugins podem ser configurados do chat
• Direcione o bot para ingressar/deixar salas de bate -papo com vários usuários (MUC)
• Segurança: Recurso de Controle ACL (Recurso do Admin/Usuário por Comando)
• Backup: um comando integrado! O backup cria uma exportação completa de dados persistentes.
• Logs: pode ser inspecionado no chat ou transmitido para sentinela.

Recursos do desenvolvedor

• Muito fácil de estender em Python! (Veja abaixo)
• O armazenamento predefinido para todos os plug -in, ou self['foo'] = 'bar' persiste o valor.
• Os fluxos de conversa para rastrear estados de conversa dos usuários.
• Suporte de retornos de chamada webhook
• Suporta formatação de extras de marcação com tabelas, imagens incorporadas, links etc.
• Helper de configuração para permitir que seu plug -in seja configurado por chat
• Consoles de desenvolvimento de texto/depuração
• Auto-documentação: seus documentos se tornam ajuda automaticamente
• Subcomando e várias opções de análise Arg estão disponíveis (RE, Tipo de linha de comando)
• Suporte de votação: você pode configurar um plug -in para fazer algo periodicamente
• Back -end de teste de ponta a ponta
• Renderização de cartões sob folga

Comunidade e apoio

Se você tem:

• Uma pergunta rápida, fique à vontade para se juntar a nós no bate -papo no Errbotio/Errbot no Gitter.
• Uma pergunta de desenvolvimento de plug -in, use o StackOverflow com as tags Errbot e Python.
• Um bug a serem relatados ou uma solicitação de recurso, use nossa página do projeto Github.

Você também pode nos pingar no Twitter com a hashtag #errbot .

Instalação

Pré -requisitos

O Errbot é executado no Python 3.6+ no Linux, Windows e Mac. Para alguns sistemas de bate -papo, você precisará de uma chave ou um login para o seu bot para acessá -lo.

Investir rápido

Recomendamos configurar um virtualenv.

1. Instale o errbot do PIP
2. Faça um diretório em algum lugar (aqui chamado Errbot) para hospedar arquivos de dados da Errbot
3. Inicialize o diretório
4. Experimente Errbot no modo de texto

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

Ele mostrará um rápido >>> para que você possa conversar diretamente com seu bot! Tente! Ajuda para começar.

Adicionando suporte para um sistema de bate -papo

Para os embutidos, basta usar uma dessas opções telegrama, IRC, XMPP com PIP, você ainda pode fazê-lo após a instalação inicial para adicionar o suporte ausente, por exemplo

 $ pip install "errbot [irc]"

Para os externos (folga, discórdia, gitter, skype, etc ...), siga as respectivas páginas do Github para obter instruções.

Configuração

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

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

Nota: Mesmo se você alterou o back -end da configuração, ainda poderá usar o errbot -t para testar sua instância localmente no modo de texto.

Iniciando Errbot como um daemon

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

errbot --daemon

Interagindo com o bot

Depois de iniciar o Errbot, você deve adicionar o bot à sua lista de amigos, se ainda não o fez. Você também precisará convidar o bot explicitamente para salas de bate -papo em alguns sistemas de bate -papo. 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 saber mais sobre um comando específico, pode emitir:

 ! help command 

Gerenciando plugins

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

Por exemplo, para pesquisa de palavras -chave nos repositórios públicos de plug -in que você pode emitir:

 ! repos search jira

Para instalar um plug -in desta lista, edição:

 ! repos install < name of repo >

Por exemplo! Repos, instale errbotio/err-imageBot.

Escrevendo plugins

Escrever seus próprios plugins é extremamente simples. Errbot-Init terá instalado no subdiretório dos plug-ins um plug-in chamado Err-Exemplo que você pode usar como base.

Como exemplo, isso é o suficiente 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 criará o comando "! Hello", que, quando emitido, retorna "Olá, mundo!" para você. Para obter mais informações sobre tudo o que você pode fazer com os plug -ins, consulte o Guia de Desenvolvimento de Plugin.

Contribuição para o próprio errbot

Sinta