Bot for Google Hangouts
- Python >= 3.3
- hangups (https://github.com/tdryer/hangups)
- appdirs (https://github.com/ActiveState/appdirs)
- asyncio (https://pypi.python.org/pypi/asyncio) for Python < 3.4
hangupsbot --help to see all available options.
Start HangupsBot by running
You can configure basic settings in
config.json file. This file will be
copied to user data directory (e.g.
~/.local/share/hangupsbot/ on Linux)
after first start of HangupsBot.
The first time you start HangupsBot, you will be prompted to open a link in your web browser where you log into your Google account. After logging in and clicking on "SIGN IN", you should see authorization code. Copy this code to clipboard and paste it into HangupsBot to complete the process. Your credentials will only be sent to Google, and only OAuth 2 refresh token will be stored locally.
usage: hangupsbot [-h] [-d] [--log LOG] [--token TOKEN] [--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) --token TOKEN OAuth refresh token storage path (default: ~/.local/share/hangupsbot/refresh_token.txt) --config CONFIG config storage path (default: ~/.local/share/hangupsbot/config.json) --version show program's version number and exit
Features (event handlers)
- autoreplies - automatically reply to specified keywords in messages
- commands - run
/bot helpfor list of available commands)
- forwarding - forward messages from one conversation to another
- membership - watch conversations for added/removed users
- rename - watch for renamed conversations (only example plugin for now)
You can extend HangupsBot in two ways - by writing
Every Python file (which doesn't start with _) in
is loaded automatically.
Functions in plugins can be registered as event handlers by decorating them with
@handler.register(priority=10, event=None) decorator.
If event parameter is
None (default), all event types are forwarded to handler.
If you want to handle only some specific type of event, you can set event
You can change priority of handler by specifying priority parameter (default is 10).
A lower number means higher priority. If you raise
StopEventHandling exception in
your handler, current event will not be handled by any other handler.
Functions in plugins can be registered as
/bot commands by decorating them with
If admin parameter is
False (default), anyone can run the command.
If admin is
True, only admins (as set in
config.json) can run it.
See existing commands for examples.