A library that allows communication via the Signal IM service using the signald daemon.
Project description
pysignald
pysignald is a Python client for the excellent signald project, which in turn is a command-line client for the Signal messaging service.
pysignald allows you to programmatically send and receive messages to Signal.
Installation
You can install pysignald with pip:
$ pip install pysignald
Running
Just make sure you have signald installed. Here's an example of how to use pysignald:
from signald import Signal
s = Signal("+1234567890")
# If you haven't registered/verified signald, do that first:
s.register(voice=False)
s.verify("sms code")
s.send_message("+1098765432", "Hello there!")
for message in s.receive_messages():
print(message)
You can also use the chat decorator interface:
from signald import Signal
s = Signal("+1234567890")
@s.chat_handler("hello") # This is case-insensitive.
def hello(message, match):
return "Hello there!"
@s.chat_handler(re.compile("my name is (.*)")) # This is case-sensitive.
def name(message, match):
return "Hello %s." % match.group(1)
s.run_chat()
Various
pysignald also supports different socket paths:
s = Signal("+1234567890", socket_path="/var/some/other/socket.sock")
It supports TCP sockets too, if you run a proxy. For example, you can proxy signald's UNIX socket over TCP with socat:
$ socat -d -d TCP4-LISTEN:15432,fork UNIX-CONNECT:/var/run/signald/signald.sock
Then in pysignald:
s = Signal("+1234567890", socket_path=("your.serveri.ip", 15432))
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
Built Distribution
Hashes for pysignald-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aeaead36a9b971e021a31a5960d8d54989f77e9ab989d58d4775e6543e6cf5a6 |
|
MD5 | 916564ffe6bd03353334bc4ba31072b4 |
|
BLAKE2b-256 | b4fda6104a0b02a8423e737ff527b19843ee9a0583e902f412e9f3a1d1f08385 |