Errbot est un chatbot. Il vous permet de lancer des scripts de manière interactive depuis vos chatrooms pour n'importe quelle raison : humour aléatoire, chatops, démarrage d'un build, suivi des commits, déclenchement d'alertes...
Il est écrit et facilement extensible en Python.
Errbot est disponible en tant que logiciel open source et publié sous la licence GPL v3.
Intégré
Avec des modules complémentaires
Après l'installation initiale et la configuration de la sécurité, Errbot peut être administré en discutant simplement avec le bot (chatops).
self['foo'] = 'bar'
conserve la valeur.Si vous avez :
Vous pouvez également nous envoyer un ping sur Twitter avec le hashtag #errbot
.
Errbot fonctionne sous Python 3.6+ sous Linux, Windows et Mac. Pour certains systèmes de discussion, vous aurez besoin d'une clé ou d'un identifiant pour que votre bot puisse y accéder.
Nous vous recommandons de configurer un virtualenv.
$ pip install errbot
$ mkdir errbot ; cd errbot
$ errbot --init
$ errbot
Il vous montrera une invite >>> afin que vous puissiez parler directement à votre bot ! Essayez !help pour commencer.
Pour les intégrés, utilisez simplement une de ces options telegram, IRC, XMPP avec pip, vous pouvez toujours le faire après l'installation initiale pour ajouter le support manquant par exemple
$ pip installe "errbot[irc]"
Pour les externes (Slack, Discord, Gitter, Skype, etc...), veuillez suivre leurs pages github respectives pour les instructions.
Afin de configurer Errbot pour qu'il se connecte à l'un de ces systèmes de discussion, vous devrez modifier le fichier config.py généré par errbot --init.
Pour vous aider, nous avons un modèle documenté disponible ici : config-template.py.
Remarque : même si vous avez modifié le BACKEND depuis la configuration, vous pouvez toujours utiliser errbot -T pour tester votre instance localement en mode texte.
Si tout cela a fonctionné, vous pouvez maintenant utiliser le paramètre -d (ou --daemon) pour l'exécuter en mode détaché :
errbot --daemon
Après avoir démarré Errbot, vous devez ajouter le bot à votre liste d'amis si ce n'est pas déjà fait. Vous devrez également inviter explicitement le bot dans les salons de discussion sur certains systèmes de discussion. Vous pouvez désormais envoyer des commandes directement au bot !
Pour obtenir une liste de toutes les commandes disponibles, vous pouvez émettre :
! help
Si vous souhaitez simplement en savoir plus sur une commande spécifique, vous pouvez émettre :
! help command
Vous pouvez administrer le bot dans une discussion en tête-à-tête si votre identifiant figure dans la liste BOT_ADMINS dans config.py.
Par exemple, pour rechercher des mots clés dans les dépôts publics de plugins, vous pouvez émettre :
! repos search jira
Pour installer un plugin de cette liste, lancez :
! repos install < name of repo >
Par exemple !repos installe errbotio/err-imagebot.
Écrire vos propres plugins est extrêmement simple. errbot --init aura installé dans le sous-répertoire plugins un plugin appelé err-example que vous pourrez utiliser comme base.
À titre d'exemple, c'est tout ce qu'il faut pour créer un message « Hello, world ! » plugin pour 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!"
Ce plugin créera la commande "!hello" qui, une fois émise, renvoie "Hello, world!" pour vous. Pour plus d'informations sur tout ce que vous pouvez faire avec les plugins, consultez le guide de développement de plugins.
N'hésitez pas à forker et proposer des modifications sur github