Skip to main content

Signal Bot Framework

PyPI Downloads Version License CI codecov

Python package to build your own Signal bots.

Installation

See the getting started section in the documentation.

Minimal bot

This is what a minimal bot using signalbot looks like:

import logging
import os

from signalbot import (
    Config,
    DataMessageContext,
    DataMessageHandler,
    SendMessage,
    SignalBot,
    text_triggered,
)


class PingCommand(DataMessageHandler):
    @text_triggered("Ping")
    async def handle_data_message(self, context: DataMessageContext) -> None:
        await context.send(SendMessage(text="Pong"))


if __name__ == "__main__":
    bot = SignalBot(
        Config(
            phone_number=os.environ["PHONE_NUMBER"],
            logging_level=logging.INFO,
        )
    )
    bot.register(PingCommand())
    bot.start()

Help

See the documentation for more details.

Download files

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

Source Distribution

signalbot-2.0.0.tar.gz (61.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

signalbot-2.0.0-py3-none-any.whl (133.2 kB view details)

Uploaded Python 3

File details

Details for the file signalbot-2.0.0.tar.gz.

File metadata

  • Download URL: signalbot-2.0.0.tar.gz
  • Upload date:
  • Size: 61.9 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

Hashes for signalbot-2.0.0.tar.gz
Algorithm Hash digest
SHA256 b145dce8f660544ee014e291b031d0c759e58bf8b4576eba4496fbe431648d17
MD5 002d7d9df0fa88fa38232ba875966574
BLAKE2b-256 e34e5041f99f08405423ad491e0f63ac7935519d35b3d24b19733b85d494145d

See more details on using hashes here.

File details

Details for the file signalbot-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: signalbot-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 133.2 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

Hashes for signalbot-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f136633513882cf05c98a443ce6b55aee9a7f9fc80dab7bfdd681bc977a6f8
MD5 520aeed6dba23d0c4af5f6c6f3a4a247
BLAKE2b-256 672ff976374cd935cedd2da11e567212fd69084d17ebdb07ae0c52e82afe1e79

See more details on using hashes here.

Supported by

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