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 --pre -U -i https://m.devpi.net/dc/master deltachat
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 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.1.1.tar.gz (179.5 kB view details)

Uploaded Source

Built Distribution

simplebot-2.1.1-py3-none-any.whl (140.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simplebot-2.1.1.tar.gz
  • Upload date:
  • Size: 179.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for simplebot-2.1.1.tar.gz
Algorithm Hash digest
SHA256 4b07a00534fe7c99769bda56df92a8f6011eee45d5c168d91cb517dcae20edde
MD5 921af40273ec5335d74a203f6bb2187b
BLAKE2b-256 c7d802112df931ce70a02360d351a523613ac2ee7c68e8f03ff9f08b4845ec57

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: simplebot-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 140.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.9.6

File hashes

Hashes for simplebot-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65e66d5b12bd8e697336783db534adeb862d29d907e654acfff8776acb0102b1
MD5 fa2c71e98b2450c72688d1c06d9eb29f
BLAKE2b-256 f2029da4ce0e46659facf2d6a008a1287c845986bedcc69e20be36419b635808

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