Felipe Martin Garcia
57b413dd1b
* 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
62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
# Butter Robot
|
|
|
|
| Stable | Master |
|
|
| --- | --- |
|
|
|  |  |
|
|
|  |  |
|
|
|
|
Python framework to create bots for several platforms.
|
|
|
|
|
|
|
|
> What is my purpose?
|
|
|
|
## Documentation
|
|
|
|
[Go to documentation](./docs)
|
|
|
|
## 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](https://python-poetry.org/).
|
|
|
|
```
|
|
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](.env-example).
|
|
|
|
```
|
|
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
|
|
```
|