summaryrefslogtreecommitdiff
path: root/python-smsgateway.spec
blob: 47f4a325ddbefd467cab6e93230a15ea748c82fc (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
%global _empty_manifest_terminate_build 0
Name:		python-SMSGateway
Version:	0.7.1.5
Release:	1
Summary:	Forwards messages via SMS from and to instant messengers
License:	Creative Commons Attribution-Noncommercial-Share Alike license
URL:		https://github.com/Craeckie/SMSGateway
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/bb/f9/f5564616d11f607e21cf88cf998d891de919d25ad9eb636f6c898bde22af/SMSGateway-0.7.1.5.tar.gz
BuildArch:	noarch

Requires:	python3-appdirs
Requires:	python3-arrow
Requires:	python3-asyncio
Requires:	python3-bs4
Requires:	python3-cryptography
Requires:	python3-fbchat
Requires:	python3-imapclient
Requires:	python3-matrix-nio[e2e]
Requires:	python3-slackclient
Requires:	python3-telethon

%description
# SMSGateway

This project is in Beta stage, so documentation is quite limited. Pull requests welcome!

The following instructions apply to a Raspberry PI running Ubuntu, but it should work similarly on other Linux distributions and platforms.
Some commands might require to be invoked with `sudo`.

See [SMSGateway-Android](https://github.com/Craeckie/SMSGateway-Android) for an Android client.

## SMS Tools
Install [smstools](smstools3.kekekasvi.com):
```bash
apt install smstools
```
Edit `/etc/smsd.conf`, see `Confiuration/smsd.conf` for an example configuration.
It uses to user `smsd` for the sms spooler at `/var/spool/sm`s.

## Configuration
```bash
pip install smsgateway
```
Copy `smsgateway/config.example.py` to `/home/smsd/.config/smsgateway/config.py` and adapt it.

## Handle incoming SMS
To handling incoming sms `Scripts/smshandler` needs to be copied to the `eventhandler` specified in `smsd.conf`. In the example it points to `/usr/local/bin/smshandler`.

Make sure to make it executable (`chmod +x`).

### Logging
`mkdir /var/log/smsgateway/ && chown -R smsd:smsd /var/log/smsgateway/`

### Permission to control systemctl, shutdown, etc.
Copy `Configuration/010_smsd-nopasswd` to `/etc/sudoers.d/`

Make sure that the file is correct, otherwise you might **lock yourself out**! If you're unsure, run
`visudo -f /etc/sudoers.d/010_smsd-nopasswd`, enter the contents in the editor and save it.

## Messengers

### Telegram
Uses [Telethon](https://github.com/LonamiWebs/Telethon).

Run `python3 -m smsgateway.sources.telegram` to authorize for receiving messages, similarly run `python3 -m smsgateway.sources.commands.send_telegram` to authorize for sending messages.

### Facebook
Uses [fbchat](https://github.com/carpedm20/fbchat), see [documentation](https://fbchat.readthedocs.io/)
```bash
apt install python3-dev libxml2-dev libxslt-dev
pip install fbchat
```

### Signal
Uses [signal-cli](https://github.com/AsamK/signal-cli)
```bash
SGVER="0.6.2"
apt install openjdk-8-jre-headless
wget "https://github.com/AsamK/signal-cli/releases/download/v$SGVER/signal-cli-$SGVER.tar.gz"
tar xvf "signal-cli-$SGVER.tar.gz" -C /opt
ln -svf "/opt/signal-cli-${SGVER}/bin/signal-cli" /usr/local/bin/
signal-cli link
# You can remove old versions at /opt/signal-cli-<version>
```

### Slack
Go to https://api.slack.com/custom-integrations/legacy-tokens
Sign in, create a token and store it in your configuration at `SL_TOKEN`

### WhatsApp
Uses [Yowsup](https://github.com/tgalal/yowsup)
```bash
pip install yowsup
# TODO
```

## Tweaks and optimizations

### Ramdisk for SMS
When lots of SMS are processed it can wear out SD cards (I destroyed one after several months).
A workaround is to store the SMS messages in a ramdisk. The following is an entry in the fstab:
```
tmpfs   /var/spool/sms  tmpfs         nodev,nosuid,size=64M     0       0
```
To mount it simply call `mount /var/spool/sms`.

The downside is, that when the device restarts/crashed, currently processed SMS messages are lost.
To work around that there are two scripts for saving&restoring the messages in `Scripts/` and a oneshot-service, which can be enabled to restore the message when the device is starting.




%package -n python3-SMSGateway
Summary:	Forwards messages via SMS from and to instant messengers
Provides:	python-SMSGateway
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-SMSGateway
# SMSGateway

This project is in Beta stage, so documentation is quite limited. Pull requests welcome!

The following instructions apply to a Raspberry PI running Ubuntu, but it should work similarly on other Linux distributions and platforms.
Some commands might require to be invoked with `sudo`.

See [SMSGateway-Android](https://github.com/Craeckie/SMSGateway-Android) for an Android client.

## SMS Tools
Install [smstools](smstools3.kekekasvi.com):
```bash
apt install smstools
```
Edit `/etc/smsd.conf`, see `Confiuration/smsd.conf` for an example configuration.
It uses to user `smsd` for the sms spooler at `/var/spool/sm`s.

## Configuration
```bash
pip install smsgateway
```
Copy `smsgateway/config.example.py` to `/home/smsd/.config/smsgateway/config.py` and adapt it.

## Handle incoming SMS
To handling incoming sms `Scripts/smshandler` needs to be copied to the `eventhandler` specified in `smsd.conf`. In the example it points to `/usr/local/bin/smshandler`.

Make sure to make it executable (`chmod +x`).

### Logging
`mkdir /var/log/smsgateway/ && chown -R smsd:smsd /var/log/smsgateway/`

### Permission to control systemctl, shutdown, etc.
Copy `Configuration/010_smsd-nopasswd` to `/etc/sudoers.d/`

Make sure that the file is correct, otherwise you might **lock yourself out**! If you're unsure, run
`visudo -f /etc/sudoers.d/010_smsd-nopasswd`, enter the contents in the editor and save it.

## Messengers

### Telegram
Uses [Telethon](https://github.com/LonamiWebs/Telethon).

Run `python3 -m smsgateway.sources.telegram` to authorize for receiving messages, similarly run `python3 -m smsgateway.sources.commands.send_telegram` to authorize for sending messages.

### Facebook
Uses [fbchat](https://github.com/carpedm20/fbchat), see [documentation](https://fbchat.readthedocs.io/)
```bash
apt install python3-dev libxml2-dev libxslt-dev
pip install fbchat
```

### Signal
Uses [signal-cli](https://github.com/AsamK/signal-cli)
```bash
SGVER="0.6.2"
apt install openjdk-8-jre-headless
wget "https://github.com/AsamK/signal-cli/releases/download/v$SGVER/signal-cli-$SGVER.tar.gz"
tar xvf "signal-cli-$SGVER.tar.gz" -C /opt
ln -svf "/opt/signal-cli-${SGVER}/bin/signal-cli" /usr/local/bin/
signal-cli link
# You can remove old versions at /opt/signal-cli-<version>
```

### Slack
Go to https://api.slack.com/custom-integrations/legacy-tokens
Sign in, create a token and store it in your configuration at `SL_TOKEN`

### WhatsApp
Uses [Yowsup](https://github.com/tgalal/yowsup)
```bash
pip install yowsup
# TODO
```

## Tweaks and optimizations

### Ramdisk for SMS
When lots of SMS are processed it can wear out SD cards (I destroyed one after several months).
A workaround is to store the SMS messages in a ramdisk. The following is an entry in the fstab:
```
tmpfs   /var/spool/sms  tmpfs         nodev,nosuid,size=64M     0       0
```
To mount it simply call `mount /var/spool/sms`.

The downside is, that when the device restarts/crashed, currently processed SMS messages are lost.
To work around that there are two scripts for saving&restoring the messages in `Scripts/` and a oneshot-service, which can be enabled to restore the message when the device is starting.




%package help
Summary:	Development documents and examples for SMSGateway
Provides:	python3-SMSGateway-doc
%description help
# SMSGateway

This project is in Beta stage, so documentation is quite limited. Pull requests welcome!

The following instructions apply to a Raspberry PI running Ubuntu, but it should work similarly on other Linux distributions and platforms.
Some commands might require to be invoked with `sudo`.

See [SMSGateway-Android](https://github.com/Craeckie/SMSGateway-Android) for an Android client.

## SMS Tools
Install [smstools](smstools3.kekekasvi.com):
```bash
apt install smstools
```
Edit `/etc/smsd.conf`, see `Confiuration/smsd.conf` for an example configuration.
It uses to user `smsd` for the sms spooler at `/var/spool/sm`s.

## Configuration
```bash
pip install smsgateway
```
Copy `smsgateway/config.example.py` to `/home/smsd/.config/smsgateway/config.py` and adapt it.

## Handle incoming SMS
To handling incoming sms `Scripts/smshandler` needs to be copied to the `eventhandler` specified in `smsd.conf`. In the example it points to `/usr/local/bin/smshandler`.

Make sure to make it executable (`chmod +x`).

### Logging
`mkdir /var/log/smsgateway/ && chown -R smsd:smsd /var/log/smsgateway/`

### Permission to control systemctl, shutdown, etc.
Copy `Configuration/010_smsd-nopasswd` to `/etc/sudoers.d/`

Make sure that the file is correct, otherwise you might **lock yourself out**! If you're unsure, run
`visudo -f /etc/sudoers.d/010_smsd-nopasswd`, enter the contents in the editor and save it.

## Messengers

### Telegram
Uses [Telethon](https://github.com/LonamiWebs/Telethon).

Run `python3 -m smsgateway.sources.telegram` to authorize for receiving messages, similarly run `python3 -m smsgateway.sources.commands.send_telegram` to authorize for sending messages.

### Facebook
Uses [fbchat](https://github.com/carpedm20/fbchat), see [documentation](https://fbchat.readthedocs.io/)
```bash
apt install python3-dev libxml2-dev libxslt-dev
pip install fbchat
```

### Signal
Uses [signal-cli](https://github.com/AsamK/signal-cli)
```bash
SGVER="0.6.2"
apt install openjdk-8-jre-headless
wget "https://github.com/AsamK/signal-cli/releases/download/v$SGVER/signal-cli-$SGVER.tar.gz"
tar xvf "signal-cli-$SGVER.tar.gz" -C /opt
ln -svf "/opt/signal-cli-${SGVER}/bin/signal-cli" /usr/local/bin/
signal-cli link
# You can remove old versions at /opt/signal-cli-<version>
```

### Slack
Go to https://api.slack.com/custom-integrations/legacy-tokens
Sign in, create a token and store it in your configuration at `SL_TOKEN`

### WhatsApp
Uses [Yowsup](https://github.com/tgalal/yowsup)
```bash
pip install yowsup
# TODO
```

## Tweaks and optimizations

### Ramdisk for SMS
When lots of SMS are processed it can wear out SD cards (I destroyed one after several months).
A workaround is to store the SMS messages in a ramdisk. The following is an entry in the fstab:
```
tmpfs   /var/spool/sms  tmpfs         nodev,nosuid,size=64M     0       0
```
To mount it simply call `mount /var/spool/sms`.

The downside is, that when the device restarts/crashed, currently processed SMS messages are lost.
To work around that there are two scripts for saving&restoring the messages in `Scripts/` and a oneshot-service, which can be enabled to restore the message when the device is starting.




%prep
%autosetup -n SMSGateway-0.7.1.5

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-SMSGateway -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.1.5-1
- Package Spec generated