Signal Bot Framework
Python package to build your own Signal bots.
[!IMPORTANT] Signalbot v2 is being developed at https://github.com/signalbot-org/signalbot/tree/v2.0. Feedback on the direction is welcomed in https://github.com/signalbot-org/signalbot/issues/234
Installation
See the getting started section in the documentation.
Minimal bot
This is what a minimal bot using signalbot looks like:
import os
import logging
from signalbot import SignalBot, Config, Command, Context, triggered, enable_console_logging
class PingCommand(Command):
@triggered("Ping")
async def handle(self, context: Context) -> None:
await context.send("Pong")
if __name__ == "__main__":
enable_console_logging(logging.INFO)
bot = SignalBot(
Config(
signal_service=os.environ["SIGNAL_SERVICE"],
phone_number=os.environ["PHONE_NUMBER"],
)
)
bot.register(PingCommand()) # Run the command for all contacts and groups
bot.start()
Help
See the documentation for more details.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file signalbot-1.2.3.tar.gz.
File metadata
- Download URL: signalbot-1.2.3.tar.gz
- Upload date:
- Size: 20.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa711182ddcdf12ae7c4030045d7342d759ced515f24c3e693f3ba8c4187588d
|
|
| MD5 |
d8b345630889c4f725696330299dfaee
|
|
| BLAKE2b-256 |
e0c432476bcfe5586a53f5c8b89b4855e07ab4a56bfcec792999be75bc0de105
|
File details
Details for the file signalbot-1.2.3-py3-none-any.whl.
File metadata
- Download URL: signalbot-1.2.3-py3-none-any.whl
- Upload date:
- Size: 25.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
99d54296de60ca9fbad519158b698d6f786e828f5960ac2c90e52a2241ab006d
|
|
| MD5 |
8767c162522486941670b196e090b201
|
|
| BLAKE2b-256 |
f81346d85bf12d6048069d2e400b4bc1e86263891f94b39d52f0da4322aa11c5
|
