hangoutsbot

Introducción

Hangupsbot es un bot de chat diseñado para trabajar con Google Hangouts.

Por favor vea:

• Instrucciones para instalar
• Seguimiento de problemas para errores, problemas y solicitudes de funciones
• Wiki para todo lo demás

Enlaces al repositorio

• Organización GitHub
• Proyecto de traducción
• Biblioteca de problemas de referencia

Características

• Menciones : si alguien te menciona en una sala, recibe un Hangout privado del bot con detalles sobre la mención, incluido el contexto, la sala y la persona que te mencionó.
• Sincronizaciones : una sincronización son dos chats grupales de Hangouts en los que sus mensajes se reenvían entre sí, lo que permite una interacción perfecta entre las dos salas. Se utiliza principalmente para superar el límite de chat de 150 miembros, pero también se puede utilizar para conectar equipos temporalmente para interactuar.
• Sincronizaciones de chat cruzado : ¿La mitad de tu equipo está en Slack? ¡Ningún problema! Puedes conectarlos a la misma habitación para comunicarse. Próximamente soporte para otros clientes de chat.
• Integración de Hubot : Hangupsbot le permite conectarse a Hubot, brindándole acceso instantáneamente a cientos de complementos y herramientas de chat desarrollados.
• Complementos y receptores : el bot tiene instrucciones para desarrollar sus propios complementos y receptores, lo que le permite interactuar con servicios externos como el sitio web de su empresa, scripts de Google y mucho más.
• Manía de complementos : juegos, compatibilidad con apodos, palabras clave suscritas, API personalizable: ¡la lista continúa !

Ejecutando el robot

Nota: ¿Primera ejecución? Ver las instrucciones de instalación.

Para ejecutar: python3 hangupsbot.py

 usage: hangupsbot [-h] [-d] [--log LOG] [--cookies COOKIES] [--memory MEMORY] [--config CONFIG] [--version]

optional arguments:
-h, --help         show this help message and exit
-d, --debug        log detailed debugging messages (default: False)
--log LOG          log file path (default:
                   ~/.local/share/hangupsbot/hangupsbot.log)
--cookies COOKIES  cookie storage path (default:
                   ~/.local/share/hangupsbot/cookies.json)
--memory MEMORY    memory storage path (default:
                   ~/.local/share/hangupsbot/memory.json)
--config CONFIG    config storage path (default:
                   ~/.local/share/hangupsbot/config.json)
--version          show program's version number and exit

Configuración de bot para administradores

Las directivas de configuración se pueden especificar en config.json .

Tenga en cuenta que el archivo config.json suministrado con el repositorio no debe editarse ni modificarse. Es el archivo de referencia utilizado por el bot para crear el archivo de configuración real ubicado en otra parte del sistema. Para saber dónde está el archivo real, consulte la sección Configuración adicional en las instrucciones de instalación.

La mayoría de las directivas de configuración se especifican globalmente.

• Las directivas globales siempre se especifican en la "raíz" de config.json .
• Para especificar una directiva por conversación, se debe definir la misma opción de configuración como config.conversations[<conversation-id>].<configuration option> .
• Las directivas por conversación anulan la configuración global, si ambas están configuradas.
• Las directivas por conversación configuradas manualmente están DESPRECADAS.

Complementos

La clave plugins en config.json le permite especificar opcionalmente una lista de complementos que el bot cargará al inicio. Si esta opción se deja como null , se cargarán todos los complementos disponibles.

Para especificar los complementos que se cargarán, primero asegúrese de que los archivos .py correctos estén dentro de su directorio hangupsbot/plugin/ , luego modifique la clave plugins en config.json para reflejar qué complementos/archivos desea cargar, por ejemplo, plugins: ["mentions", "default", "chance", "syncrooms"]

Algunos complementos pueden requerir una configuración adicional. config.json es el proveedor de configuración para el bot y sus complementos.

Algunos complementos interesantes:

• menciona el complemento
  • alertar a los usuarios cuando se mencionan sus nombres en un chat
• complemento de suscripción
  • alertar a los usuarios cuando las palabras clave a las que están suscritos se dicen en un chat
• Complementos de sincronización/sincronización
  • retransmitir mensajes de chat entre diferentes conversaciones de grupos de Hangouts (sincronizaciones)
  • configurar mediante comandos de bot (syncrooms_config)
  • traducción automática a través de Google Translate de mensajes retransmitidos (syncrooms_autotranslate)

La wiki tiene una lista más completa de complementos ...

Interactuando con el robot

Hay dos tipos generales de interacciones con el bot:

• Los comandos /bot comienzan con /bot por ejemplo, /bot dosomething
  • algunos comandos de bot son solo para administradores
• interacciones personalizadas (el uso y la accesibilidad varían según el complemento)

El bot base admite algunos comandos básicos incluso sin ningún complemento cargado. Aquí hay una lista parcial:

/bot help

• Bot enumera todos los comandos admitidos en un mensaje privado con el usuario

/bot ping

• Bot responde con un pong .

/bot version

• Bot responde con el número de versión del framework.

Una lista completa de los comandos admitidos por el marco base está disponible en la página wiki de Core Commands .

La wiki también tiene una lista de complementos que detallan los complementos disponibles con listas de comandos y su uso.

Actualizando

• Navegue hasta el directorio del bot (por ejemplo, cd ~/hangupsbot )
• Cambie a la última rama estable usando git checkout master
• git pull para obtener la última versión de hangupsbot
• pip3 install -r requirements.txt --upgrade
• Reinicia el bot

Depuración

• Ejecute el bot con el parámetro -d , por ejemplo, python3 hangupsbot.py -d ; esto reduce el nivel de registro a INFO para obtener un archivo de registro más detallado e informativo.
• tail el archivo de registro, que probablemente esté ubicado en /<user>/.local/share/hangupsbot/hangupsbot.log ; ¡la ubicación varía según la distribución!
• La salida de la consola (STDOUT) es bastante limitada independientemente del nivel de registro, así que confíe en la salida del archivo de registro.

Consejos para solucionar problemas

El programa no se está ejecutando:

• Actualizar hangupsbot y hangups
• Ejecute hangups para comprobar si la biblioteca de cuelgues original está funcionando
  • Si hay errores, elimine la cookie en ``~/.local/share/hangupsbot/cookies.json` y vuelva a intentarlo
  • Inicie sesión en su cuenta de Google desde la dirección del servidor.

El bot no responde a los mensajes:

• Comprueba que los chats no vayan a la sección "Invitaciones" de Hangouts.

Extensión

Consulte https://github.com/hangoutsbot/hangoutsbot/wiki/Authoring-Bot-Extensions

Créditos / Historia

Hangoutsbot se deriva del bot mogunsamang, que a su vez es una bifurcación del robot hangups de xmikos.

El 20 de junio de 2015, esta bifurcación se separó y se volvió independiente en GitHub.

El 3 de julio de 2015, la bifurcación se convirtió en una organización Github.