fmartingr/butterrobot
1
0
Fork 0
Code Issues Pull requests Projects Releases 8 Packages 1 Wiki Activity Actions

Added admin interface to manage channels and enabled plugins (#9)

Browse source 
* Added base admin login/logout flows

* Ignore local database

* Channel model

* Admin interface for channels and plugins

* Added database tests along with workflows

* Added some docstrings

* Ignore .coverage file

* Creating plugins docs WIP

* Documentation

* Black everything

* Some documentation

* Coverage for the plugins package as well

* DB Fixes

* Absolute FROM in Dockerfile

* Database and logging fixes

* Slack: Support private channels

* Added pre-commit

* black'd

* Fixed UserQuery.create

* Fixed ChannelPluginQuery.create exists call

* Added ChannelPlugin menu for debugging

* Ignore sqlite databases

* Updated contributing docs
This commit is contained in:
Felipe M 2022-02-05 13:00:20 +01:00 • committed by GitHub
parent 456d144a7d
commit 57b413dd1b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
45 changed files with 2210 additions and 421 deletions
Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,7 +1,9 @@
# Butter Robot
![Build stable tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20stable%20tag%20docker%20image/badge.svg?branch=stable)
![Build latest tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20latest%20tag%20docker%20image/badge.svg?branch=master)
| Stable | Master |
| --- | --- |
| ![Build stable tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20stable%20tag%20docker%20image/badge.svg?branch=stable) | ![Build latest tag docker image](https://github.com/fmartingr/butterrobot/workflows/Build%20latest%20tag%20docker%20image/badge.svg?branch=master) |
| ![Pytest](https://github.com/fmartingr/butterrobot/workflows/Pytest/badge.svg?branch=stable) | ![Pytest](https://github.com/fmartingr/butterrobot/workflows/Pytest/badge.svg?branch=master) |
Python framework to create bots for several platforms.
@ -9,25 +11,9 @@ Python framework to create bots for several platforms.
> What is my purpose?
## Supported platforms
## Documentation
| 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.
[Go to documentation](./docs)
## Installation
@ -44,12 +30,11 @@ $ python -m butterrobot
### Containers
The `fmartingr/butterrobot/butterrobot` container image is published on Github packages to
use with your favourite tool:
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
podman run -d --name fmartingr/butterrobot/butterrobot -p 8080:8080
```
## Contributing
@ -62,8 +47,7 @@ cd butterrobot
poetry install
```
Create a `.env-local` file with the required environment variables,
you have [an example file](.env-example).
Create a `.env-local` file with the required environment variables, you have [an example file](.env-example).
```
SLACK_TOKEN=xxx