Package to build Signal bots
Project description
Signal Bot Framework
Todo
Todos
- Create dummy project
- Add real code
- Think about the license again
- Github actions to test and publish on release
- Example bot & commands
- PR to API project
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
- Follow the instructions in
bot.py
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
- Create a new file in the
commands
folder - Inherit from
Command
and implementhandle
to react on incomming messages - Optionally, overwrite
init
to schedule tasks or to perform tasks before listening for messages
Project details
Release history Release notifications | RSS feed
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.2.tar.gz
(19.8 kB
view hashes)
Built Distribution
signalbot-0.0.2-py3-none-any.whl
(21.2 kB
view hashes)
Close
Hashes for signalbot-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60cc46ba95834a6f0b0b7f9f047720b25279f02835a111f898e2bafa70d4be11 |
|
MD5 | de8a1991861b50dffd0830715fb365b8 |
|
BLAKE2b-256 | 4ffe9a4dd5637aa48ad33f1a482eb74e65107eadb6b9c80a6ca3a8e3735c8511 |