blob: 4999174f43dd5fe27221934d1a962aa1cc2d6422 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
pysignald
=======
[](https://gitlab.com/stavros/pysignald/commits/master)
pysignald is a Python client for the excellent [signald](https://git.callpipe.com/finn/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:
```python
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:
```python
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:
```python
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:
```bash
$ socat -d -d TCP4-LISTEN:15432,fork UNIX-CONNECT:/var/run/signald/signald.sock
```
Then in pysignald:
```python
s = Signal("+1234567890", socket_path=("your.serveri.ip", 15432))
```
|
