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 Martin Garcia 57b413dd1b
Added admin interface to manage channels and enabled plugins (#9)
5 months ago
.github/workflows Added admin interface to manage channels and enabled plugins (#9) 5 months ago
assets What is my purpose? 2 years ago
butterrobot Added admin interface to manage channels and enabled plugins (#9) 5 months ago
butterrobot_plugins_contrib Added admin interface to manage channels and enabled plugins (#9) 5 months ago
docker Added admin interface to manage channels and enabled plugins (#9) 5 months ago
docs Added admin interface to manage channels and enabled plugins (#9) 5 months ago
tests Added admin interface to manage channels and enabled plugins (#9) 5 months ago
.env-example Added admin interface to manage channels and enabled plugins (#9) 5 months ago
.gitignore Added admin interface to manage channels and enabled plugins (#9) 5 months ago
.pre-commit-config.yaml Added admin interface to manage channels and enabled plugins (#9) 5 months ago
Dockerfile.dev Added admin interface to manage channels and enabled plugins (#9) 5 months ago
Makefile Added admin interface to manage channels and enabled plugins (#9) 5 months ago
README.md Added admin interface to manage channels and enabled plugins (#9) 5 months ago
poetry.lock Added admin interface to manage channels and enabled plugins (#9) 5 months ago
pyproject.toml Added admin interface to manage channels and enabled plugins (#9) 5 months ago
setup.cfg Added admin interface to manage channels and enabled plugins (#9) 5 months ago

README.md

Butter Robot

Stable Master
Build stable tag docker image Build latest tag docker image
Pytest Pytest

Python framework to create bots for several platforms.

Butter Robot

What is my purpose?

Documentation

Go to documentation

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