Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/simplebot-org/simplebot
Extensible Delta Chat bot written in Python3
https://github.com/simplebot-org/simplebot
bot chatbot deltachat email
Last synced: 3 months ago
JSON representation
Extensible Delta Chat bot written in Python3
- Host: GitHub
- URL: https://github.com/simplebot-org/simplebot
- Owner: simplebot-org
- License: mpl-2.0
- Fork: true (deltachat-bot/deltabot)
- Created: 2019-02-20T17:44:30.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T21:32:13.000Z (9 months ago)
- Last Synced: 2024-05-20T03:18:06.944Z (8 months ago)
- Topics: bot, chatbot, deltachat, email
- Language: Python
- Homepage:
- Size: 1.88 MB
- Stars: 35
- Watchers: 5
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- cuban-opensource - simplebot
README
> **⚠️ IMPORTANT:** This project is no longer heavily maintained you should use instead: https://github.com/deltachat-bot/deltabot-cli-py
SimpleBot
[](https://pypi.org/project/simplebot)
[](https://pypi.org/project/simplebot)
[](https://pepy.tech/project/simplebot)
[](https://pypi.org/project/simplebot)
[](https://github.com/simplebot-org/simplebot/actions/workflows/python-ci.yml)
[](https://github.com/psf/black)
[](https://github.com/simplebot-org/simplebot/graphs/contributors)
> An extensible Delta Chat bot.
## Install
To install the latest stable version of SimpleBot run the following command (preferably in a [virtual environment](https://packaging.python.org/tutorials/installing-packages/#creating-and-using-virtual-environments)):
```sh
pip install simplebot
```
To test unreleased version:
```sh
pip install git+https://github.com/simplebot-org/simplebot
```
> **⚠️ NOTE:** If Delta Chat Python bindings package is not available for your platform you will need to compile and install the bindings manually, check [deltachat documentation](https://github.com/deltachat/deltachat-core-rust/blob/master/python/README.rst) for more info.
### Build with docker
```bash
# building image
docker build -t simplebot .
# running container with simplebot
# "/home/bot_volume" absolute path for storing bot data on host system
docker run -it -v /home/bot_volume:/root/.simplebot simplebot bash
```
In container bash you can do same bot running as in [quick start section](#quick-start-running-a-botplugins)
## Quick Start: Running a bot+plugins
(Replace variables `$ADDR` and `$PASSWORD` with the email and password for the account the bot will use)
1. Add an account to the bot:
```sh
simplebot init "$ADDR" "$PASSWORD"
```
2. Install some plugins:
```sh
pip install simplebot-echo
```
3. Start the bot:
```sh
simplebot serve
```
## Plugins
SimpleBot is a base bot that relies on plugins to add functionality.
Everyone can publish their own plugins, search in PyPI to discover cool [SimpleBot plugins](https://pypi.org/search/?q=simplebot&o=&c=Environment+%3A%3A+Plugins)
> **⚠️ NOTE:** Plugins installed as Python packages (for example with `pip`) are global to all accounts you register in the bot, to separate plugins per account you need to run each account in its own virtual environment.
## Creating per account plugins
If you know how to code in Python, you can quickly create plugins and install them to tweak your bot.
Lets create an "echo bot", create a file named `echo.py` and write inside:
```python
import simplebot
@simplebot.filter
def echo(message, replies):
"""Echoes back received message."""
replies.add(text=message.text)
```
That is it! you have created a plugin that will transform simplebot in an "echo bot" that will echo back any text message you send to it. Now tell simplebot to register your plugin:
```sh
simplebot plugin --add ./echo.py
```
Now you can start the bot and write to it from Delta Chat app to see your new bot in action.
Check the `examples` folder to see some examples about how to create plugins.
## Note for users
SimpleBot uses [Autocrypt](https://autocrypt.org/) end-to-end encryption
but note that the operator of the bot service can look into
messages that are sent to it.
## Credits
SimpleBot logo was created by Cuban designer "Dann".