fmartingr
/
butterrobot
mirror of https://github.com/fmartingr/butterrobot.git
1
0
Fork 0
Code Issues Releases Wiki Activity
3 Commits 12 Branches 0 Tags 736 KiB
Python 65.4%
Jinja 32.5%
Makefile 1.1%
Dockerfile 0.9%
Shell 0.1%
Go to file
Felipe M 825c57e8a9
Dev Dockerfile + Makefile 		2020-07-03 17:35:31 +02:00
assets What is my purpose? 2020-04-23 11:00:19 +02:00
butterrobot Typos 2020-07-03 17:34:49 +02:00
butterrobot_plugins_contrib What is my purpose? 2020-04-23 11:00:19 +02:00
docker What is my purpose? 2020-04-23 11:00:19 +02:00
.env-example What is my purpose? 2020-04-23 11:00:19 +02:00
.gitignore What is my purpose? 2020-04-23 11:00:19 +02:00
Dockerfile.dev Dev Dockerfile + Makefile 2020-07-03 17:35:31 +02:00
Makefile Dev Dockerfile + Makefile 2020-07-03 17:35:31 +02:00
README.md What is my purpose? 2020-04-23 11:00:19 +02:00
poetry.lock What is my purpose? 2020-04-23 11:00:19 +02:00
pyproject.toml What is my purpose? 2020-04-23 11:00:19 +02:00
setup.cfg What is my purpose? 2020-04-23 11:00:19 +02:00

README.md

Butter Robot

Docker Repository on Quay

Python framework to create bots for several platforms.

Butter Robot

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

  1. Slack webhooks only supports answering to incoming event, not sending messages on demand. ↩︎