Skip to main content

SimpleBot: Extensible bot for Delta Chat

Project description

SimpleBot

Latest Release Supported Versions Downloads License CI Code style: black Contributors

An extensible Delta Chat bot.

Install

To install the latest stable version of SimpleBot run the following command (preferably in a virtual environment):

pip install simplebot

To test unreleased version:

pip install git+https://github.com/simplebot-org/simplebot

Build with docker

# 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

⚠️ 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 for more info.

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:

    simplebot init "$ADDR" "$PASSWORD"
    
  2. Install some plugins:

    pip install simplebot-echo
    
  3. Start the bot:

    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

⚠️ 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:

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:

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 end-to-end encryption but note that the operator of the bot service can look into messages that are sent to it.

Credits

SimpleBot is based on deltabot

SimpleBot logo was created by Cuban designer "Dann".

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simplebot-2.4.0.tar.gz (181.3 kB view details)

Uploaded Source

Built Distribution

simplebot-2.4.0-py3-none-any.whl (142.0 kB view details)

Uploaded Python 3

File details

Details for the file simplebot-2.4.0.tar.gz.

File metadata

  • Download URL: simplebot-2.4.0.tar.gz
  • Upload date:
  • Size: 181.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for simplebot-2.4.0.tar.gz
Algorithm Hash digest
SHA256 126765fdb5aad8be603954f1aff4b3ea660c54f02333913560f281dada90be58
MD5 9554e1b0fcec142e8043c8267d9e6888
BLAKE2b-256 6e0e83376ef58a59c0469eeb0dad2faf487c45a705003eee5c0ccd7e456a8313

See more details on using hashes here.

Provenance

File details

Details for the file simplebot-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: simplebot-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 142.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for simplebot-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6af6557e15b6ae47692be79a44571bb8862e9f102b5a85cbc12ef2cf9a989ed
MD5 59d86a9a83729bf1fe5d5fceb31858a8
BLAKE2b-256 41f128c2e1886f6aa80a4f627fa8cdbefa2ffa52260f932a5b1090a16809afbe

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page