{"id":13410356,"url":"https://github.com/simplebot-org/simplebot","last_synced_at":"2025-03-14T15:32:31.303Z","repository":{"id":38019735,"uuid":"171721039","full_name":"simplebot-org/simplebot","owner":"simplebot-org","description":"Extensible Delta Chat bot written in Python3","archived":false,"fork":true,"pushed_at":"2024-05-06T21:32:13.000Z","size":1973,"stargazers_count":35,"open_issues_count":5,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-05-20T03:18:06.944Z","etag":null,"topics":["bot","chatbot","deltachat","email"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"deltachat-bot/deltabot","license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/simplebot-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-20T17:44:30.000Z","updated_at":"2024-03-01T07:46:25.000Z","dependencies_parsed_at":"2023-02-17T06:15:43.421Z","dependency_job_id":null,"html_url":"https://github.com/simplebot-org/simplebot","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplebot-org%2Fsimplebot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplebot-org%2Fsimplebot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplebot-org%2Fsimplebot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplebot-org%2Fsimplebot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplebot-org","download_url":"https://codeload.github.com/simplebot-org/simplebot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221482000,"owners_count":16829979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","chatbot","deltachat","email"],"created_at":"2024-07-30T20:01:06.417Z","updated_at":"2025-03-14T15:32:31.292Z","avatar_url":"https://github.com/simplebot-org.png","language":"Python","readme":"\u003e **⚠️ IMPORTANT:** This project is no longer actively maintained you should use instead: https://github.com/deltachat-bot/deltabot-cli-py\n\n\u003cp align=\"center\"\u003e\u003cimg height=\"150\" width=\"150\" src=\"https://github.com/simplebot-org/simplebot/raw/master/artwork/Bot.svg\"\u003e\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eSimpleBot\u003c/h1\u003e\n\n[![Latest Release](https://img.shields.io/pypi/v/simplebot.svg)](https://pypi.org/project/simplebot)\n[![Supported Versions](https://img.shields.io/pypi/pyversions/simplebot.svg)](https://pypi.org/project/simplebot)\n[![Downloads](https://pepy.tech/badge/simplebot)](https://pepy.tech/project/simplebot)\n[![License](https://img.shields.io/pypi/l/simplebot.svg)](https://pypi.org/project/simplebot)\n[![CI](https://github.com/simplebot-org/simplebot/actions/workflows/python-ci.yml/badge.svg)](https://github.com/simplebot-org/simplebot/actions/workflows/python-ci.yml)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![Contributors](https://img.shields.io/github/contributors/simplebot-org/simplebot.svg)](https://github.com/simplebot-org/simplebot/graphs/contributors)\n\n\u003e An extensible Delta Chat bot.\n\n## Install\n\nTo 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)):\n\n```sh\npip install simplebot\n```\n\nTo test unreleased version:\n\n```sh\npip install git+https://github.com/simplebot-org/simplebot\n```\n\n\u003e **⚠️ 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.\n\n### Build with docker\n```bash\n# building image\ndocker build -t simplebot .\n# running container with simplebot\n# \"/home/bot_volume\" absolute path for storing bot data on host system\ndocker run -it -v /home/bot_volume:/root/.simplebot simplebot bash\n```\nIn container bash you can do same bot running as in [quick start section](#quick-start-running-a-botplugins)\n\n## Quick Start: Running a bot+plugins\n\n(Replace variables `$ADDR` and `$PASSWORD` with the email and password for the account the bot will use)\n\n1. Add an account to the bot:\n\n\t```sh\n\tsimplebot init \"$ADDR\" \"$PASSWORD\"\n\t```\n\n2. Install some plugins:\n\n\t```sh\n\tpip install simplebot-echo\n\t```\n\n3. Start the bot:\n\n\t```sh\n\tsimplebot serve\n\t```\n\n## Plugins\n\nSimpleBot is a base bot that relies on plugins to add functionality.\n\nEveryone can publish their own plugins, search in PyPI to discover cool [SimpleBot plugins](https://pypi.org/search/?q=simplebot\u0026o=\u0026c=Environment+%3A%3A+Plugins)\n\n\u003e **⚠️ 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.\n\n## Creating per account plugins\n\nIf you know how to code in Python, you can quickly create plugins and install them to tweak your bot.\n\nLets create an \"echo bot\", create a file named `echo.py` and write inside:\n\n```python\nimport simplebot\n\n@simplebot.filter\ndef echo(message, replies):\n    \"\"\"Echoes back received message.\"\"\"\n    replies.add(text=message.text)\n```\n\nThat 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:\n\n```sh\nsimplebot plugin --add ./echo.py\n```\n\nNow you can start the bot and write to it from Delta Chat app to see your new bot in action.\n\nCheck the `examples` folder to see some examples about how to create plugins.\n\n## Note for users\n\nSimpleBot uses [Autocrypt](https://autocrypt.org/) end-to-end encryption\nbut note that the operator of the bot service can look into\nmessages that are sent to it.\n\n\n## Credits\n\nSimpleBot logo was created by Cuban designer \"Dann\".\n","funding_links":[],"categories":["Bots"],"sub_categories":["Deltachat"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplebot-org%2Fsimplebot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplebot-org%2Fsimplebot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplebot-org%2Fsimplebot/lists"}