Skip to main content

Package to build Signal bots

Project description

Signal Bot Framework

Todo

Deprecated

Micro framework to create your own signal bots. Just fork this repository and extend it with your commands. The API builds on top of https://github.com/bbernhard/signal-cli-rest-api which provides a Websocket/REST API for https://github.com/AsamK/signal-cli.

How to run the bot

  1. Follow the instructions in bot.py
  2. docker-compose up

Currently, the bot can only listen in groups and not direct messages. You can create a group with yourself and use the bot there.

How to implement a new command

  1. Create a new file in the commands folder
  2. Inherit from Command and implement handle to react on incomming messages
  3. Optionally, overwrite init to schedule tasks or to perform tasks before listening for messages

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

signalbot-0.0.1.tar.gz (1.9 kB view hashes)

Uploaded Source

Built Distribution

signalbot-0.0.1-py3-none-any.whl (2.2 kB view hashes)

Uploaded Python 3

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