Skip to main content

SimpleBot: Extensible bot for Delta Chat

Project description

⚠️ IMPORTANT: This project is no longer actively maintained you should use instead: https://github.com/deltachat-bot/deltabot-cli-py

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

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

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

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 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-4.2.0.tar.gz (181.9 kB view details)

Uploaded Source

Built Distribution

simplebot-4.2.0-py3-none-any.whl (141.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simplebot-4.2.0.tar.gz
  • Upload date:
  • Size: 181.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for simplebot-4.2.0.tar.gz
Algorithm Hash digest
SHA256 f690113d1c7b21d92b509eeb46451cb8be903b5fb9d2874897d13e647ae6494c
MD5 793bd2919fb8068c0b6b34e121293f3e
BLAKE2b-256 a78d650e06acd416d113e62f906e70a1ec42ca9c602e70d454b3334e07054ff2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simplebot-4.2.0-py3-none-any.whl
  • Upload date:
  • Size: 141.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for simplebot-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 da0e5bd20a4873f347623e650829b49043036ad85d998e8a5269d9315ff21f26
MD5 2e1fe2d37dc4bd03627f9d0ae1e61e95
BLAKE2b-256 ff51a09a8f34753d757355b7a2ebf116adaa013c0f315ad4248356ce6f043085

See more details on using hashes here.

Supported by

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