fmartingr
/
butterrobot
mirror of https://github.com/fmartingr/butterrobot.git
1
0
Fork 0
Code Issues Releases Wiki Activity
29 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 Martin Garcia 62fb0ec8d4 Ignore codespaces python env 2020-09-25 21:37:56 +00:00
.github/workflows release 0.0.2a2 (#1) 2020-07-21 17:17:01 +02:00
assets What is my purpose? 2020-04-23 11:00:19 +02:00
butterrobot Typo 2020-09-17 20:16:29 +02:00
butterrobot_plugins_contrib Added !dice command 2020-09-17 20:16:42 +02:00
docker Bugfixes 2020-08-11 12:57:56 +02:00
.env-example What is my purpose? 2020-04-23 11:00:19 +02:00
.gitignore Ignore codespaces python env 2020-09-25 21:37:56 +00:00
Dockerfile.dev release 0.0.2a2 (#1) 2020-07-21 17:17:01 +02:00
Makefile Typo 2020-09-17 20:16:21 +02:00
README.md Added !dice command 2020-09-17 20:16:42 +02:00
poetry.lock Added !dice command 2020-09-17 20:16:42 +02:00
pyproject.toml Added !dice command 2020-09-17 20:16:42 +02:00
setup.cfg What is my purpose? 2020-04-23 11:00:19 +02:00

README.md

Butter Robot

Build stable tag docker image Build latest tag docker image

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
Telegram Yes Yes

Provided plugins

Development

  • !ping: Say !ping to get response with time elapsed.

Fun and entertainment

  • Lo quito: What happens when you say "lo quito"...? (Spanish pun)
  • Dice: Put !dice and wathever roll you want to perform.

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/butterrobot container image is published on Github packages to use with your favourite tool:

docker pull docker.pkg.github.com/fmartingr/butterrobot/butterrobot:latest
podman run -d --name fmartingr/butterrobot/butterrobot -p 8080:8080

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

docker run -it --rm --env-file .env-local -p 5000:5000 -v $PWD/butterrobot:/etc/app/butterrobot local/butterrobot python -m butterrobot