You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Felipe M 456d144a7d Ignore tls-verification for internal registry 11 months ago
.github/workflows release 0.0.2a2 (#1) 1 year ago
assets What is my purpose? 1 year ago
butterrobot Removed async code 11 months ago
butterrobot_plugins_contrib contrib.fun.coin 11 months ago
docker Using waitress to serve wsgi 11 months ago
.env-example What is my purpose? 1 year ago
.gitignore Ignore codespaces python env 1 year ago
Dockerfile.dev release 0.0.2a2 (#1) 1 year ago
Makefile Ignore tls-verification for internal registry 11 months ago
README.md Added !dice command 1 year ago
poetry.lock Using waitress to serve wsgi 11 months ago
pyproject.toml contrib.fun.coin 11 months ago
setup.cfg What is my purpose? 1 year ago

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