No description
| assets | ||
| butterrobot | ||
| butterrobot_plugins_contrib | ||
| docker | ||
| .env-example | ||
| .gitignore | ||
| Dockerfile.dev | ||
| Makefile | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| setup.cfg | ||
Butter Robot
Python framework to create bots for several platforms.
What is my purpose?
Supported platforms
| Name | Receive messages | Send messages |
|---|---|---|
| Slack (app) | Yes | Yes |
| Slack (webhook) | Planned | No1 |
| Telegram | Yes | Yes |
Provided plugins
Butter robot
- Help
- Usage
- Changelog
Development
- Ping
Fun and entertainment
- Dice roll
- Loquito
Installation
PyPi
You can run it directly by installing the package and calling it
with python though this is not recommended and only intended for
development purposes.
$ pip install --user butterrobot
$ python -m butterrobot
Containers
The fmartingr/butterrobot container image is published on quay.io to
use with your favourite tool:
podman run -d --name butterrobot -p 8080:8080 quay.io/fmartingr/butterrobot
Contributing
To run the project locally you will need poetry.
git clone git@github.com:fmartingr/butterrobot.git
cd butterrobot
poetry install
Create a .env-local file with the required environment variables,
you have an example file.
SLACK_TOKEN=xxx
TELEGRAM_TOKEN=xxx
...
And then you can run it directly with poetry
TODO: Autoload .env-local
docker run -it --rm --env-file .env-local -p 5000:5000 -v $PWD/butterrobot:/etc/app/butterrobot local/butterrobot python -m butterrobot
-
Slack webhooks only supports answering to incoming event, not sending messages on demand. ↩︎