aprsd 3.4.4__py3-none-any.whl → 4.0.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. aprsd/cli_helper.py +12 -5
  2. aprsd/client/aprsis.py +31 -9
  3. aprsd/client/base.py +13 -2
  4. aprsd/client/drivers/aprsis.py +6 -3
  5. aprsd/client/drivers/fake.py +15 -20
  6. aprsd/client/factory.py +0 -2
  7. aprsd/client/fake.py +0 -2
  8. aprsd/client/kiss.py +17 -2
  9. aprsd/client/stats.py +1 -3
  10. aprsd/cmds/completion.py +7 -4
  11. aprsd/cmds/dev.py +38 -42
  12. aprsd/cmds/fetch_stats.py +140 -143
  13. aprsd/cmds/healthcheck.py +5 -3
  14. aprsd/cmds/list_plugins.py +140 -134
  15. aprsd/cmds/listen.py +13 -9
  16. aprsd/cmds/server.py +53 -27
  17. aprsd/conf/__init__.py +1 -2
  18. aprsd/conf/client.py +3 -4
  19. aprsd/conf/common.py +19 -93
  20. aprsd/conf/log.py +2 -4
  21. aprsd/conf/opts.py +5 -4
  22. aprsd/conf/plugin_common.py +11 -121
  23. aprsd/exception.py +2 -0
  24. aprsd/log/log.py +7 -46
  25. aprsd/main.py +10 -4
  26. aprsd/packets/__init__.py +14 -4
  27. aprsd/packets/core.py +57 -67
  28. aprsd/packets/log.py +8 -8
  29. aprsd/packets/packet_list.py +9 -6
  30. aprsd/plugin.py +22 -11
  31. aprsd/plugins/notify.py +1 -4
  32. aprsd/plugins/weather.py +10 -8
  33. aprsd/stats/collector.py +5 -2
  34. aprsd/threads/__init__.py +3 -2
  35. aprsd/threads/aprsd.py +12 -7
  36. aprsd/threads/{keep_alive.py → keepalive.py} +14 -45
  37. aprsd/threads/registry.py +3 -3
  38. aprsd/threads/rx.py +9 -6
  39. aprsd/threads/stats.py +2 -2
  40. aprsd/threads/tx.py +3 -4
  41. aprsd/utils/__init__.py +42 -10
  42. aprsd/utils/json.py +9 -4
  43. aprsd/utils/keepalive_collector.py +55 -0
  44. aprsd/utils/trace.py +0 -2
  45. aprsd-4.0.0.dist-info/AUTHORS +1 -0
  46. aprsd-4.0.0.dist-info/METADATA +293 -0
  47. aprsd-4.0.0.dist-info/RECORD +74 -0
  48. {aprsd-3.4.4.dist-info → aprsd-4.0.0.dist-info}/WHEEL +1 -1
  49. aprsd/cmds/admin.py +0 -57
  50. aprsd/cmds/webchat.py +0 -662
  51. aprsd/conf/plugin_email.py +0 -105
  52. aprsd/plugins/email.py +0 -715
  53. aprsd/plugins/location.py +0 -181
  54. aprsd/threads/log_monitor.py +0 -121
  55. aprsd/web/__init__.py +0 -0
  56. aprsd/web/admin/__init__.py +0 -0
  57. aprsd/web/admin/static/css/index.css +0 -84
  58. aprsd/web/admin/static/css/prism.css +0 -4
  59. aprsd/web/admin/static/css/tabs.css +0 -35
  60. aprsd/web/admin/static/images/Untitled.png +0 -0
  61. aprsd/web/admin/static/images/aprs-symbols-16-0.png +0 -0
  62. aprsd/web/admin/static/images/aprs-symbols-16-1.png +0 -0
  63. aprsd/web/admin/static/images/aprs-symbols-64-0.png +0 -0
  64. aprsd/web/admin/static/images/aprs-symbols-64-1.png +0 -0
  65. aprsd/web/admin/static/images/aprs-symbols-64-2.png +0 -0
  66. aprsd/web/admin/static/js/charts.js +0 -235
  67. aprsd/web/admin/static/js/echarts.js +0 -465
  68. aprsd/web/admin/static/js/logs.js +0 -26
  69. aprsd/web/admin/static/js/main.js +0 -231
  70. aprsd/web/admin/static/js/prism.js +0 -12
  71. aprsd/web/admin/static/js/send-message.js +0 -114
  72. aprsd/web/admin/static/js/tabs.js +0 -28
  73. aprsd/web/admin/templates/index.html +0 -196
  74. aprsd/web/chat/static/css/chat.css +0 -115
  75. aprsd/web/chat/static/css/index.css +0 -66
  76. aprsd/web/chat/static/css/style.css.map +0 -1
  77. aprsd/web/chat/static/css/tabs.css +0 -41
  78. aprsd/web/chat/static/css/upstream/bootstrap.min.css +0 -6
  79. aprsd/web/chat/static/css/upstream/font.woff2 +0 -0
  80. aprsd/web/chat/static/css/upstream/google-fonts.css +0 -23
  81. aprsd/web/chat/static/css/upstream/jquery-ui.css +0 -1311
  82. aprsd/web/chat/static/css/upstream/jquery.toast.css +0 -28
  83. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/LatoLatin-Bold.woff +0 -0
  84. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/LatoLatin-Bold.woff2 +0 -0
  85. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/LatoLatin-Regular.woff +0 -0
  86. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/LatoLatin-Regular.woff2 +0 -0
  87. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/icons.woff +0 -0
  88. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/icons.woff2 +0 -0
  89. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/outline-icons.woff +0 -0
  90. aprsd/web/chat/static/css/upstream/themes/default/assets/fonts/outline-icons.woff2 +0 -0
  91. aprsd/web/chat/static/images/Untitled.png +0 -0
  92. aprsd/web/chat/static/images/aprs-symbols-16-0.png +0 -0
  93. aprsd/web/chat/static/images/aprs-symbols-16-1.png +0 -0
  94. aprsd/web/chat/static/images/aprs-symbols-64-0.png +0 -0
  95. aprsd/web/chat/static/images/aprs-symbols-64-1.png +0 -0
  96. aprsd/web/chat/static/images/aprs-symbols-64-2.png +0 -0
  97. aprsd/web/chat/static/images/globe.svg +0 -3
  98. aprsd/web/chat/static/js/gps.js +0 -84
  99. aprsd/web/chat/static/js/main.js +0 -45
  100. aprsd/web/chat/static/js/send-message.js +0 -612
  101. aprsd/web/chat/static/js/tabs.js +0 -28
  102. aprsd/web/chat/static/js/upstream/bootstrap.bundle.min.js +0 -7
  103. aprsd/web/chat/static/js/upstream/jquery-3.7.1.min.js +0 -2
  104. aprsd/web/chat/static/js/upstream/jquery-ui.min.js +0 -13
  105. aprsd/web/chat/static/js/upstream/jquery.toast.js +0 -374
  106. aprsd/web/chat/static/js/upstream/semantic.min.js +0 -11
  107. aprsd/web/chat/static/js/upstream/socket.io.min.js +0 -7
  108. aprsd/web/chat/templates/index.html +0 -139
  109. aprsd/wsgi.py +0 -322
  110. aprsd-3.4.4.dist-info/AUTHORS +0 -13
  111. aprsd-3.4.4.dist-info/METADATA +0 -849
  112. aprsd-3.4.4.dist-info/RECORD +0 -134
  113. {aprsd-3.4.4.dist-info → aprsd-4.0.0.dist-info}/LICENSE +0 -0
  114. {aprsd-3.4.4.dist-info → aprsd-4.0.0.dist-info}/entry_points.txt +0 -0
  115. {aprsd-3.4.4.dist-info → aprsd-4.0.0.dist-info}/top_level.txt +0 -0
@@ -1,849 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: aprsd
3
- Version: 3.4.4
4
- Summary: APRSd is a APRS-IS server that can be used to connect to APRS-IS and send and receive APRS packets.
5
- Author-email: Craig Lamparter <craig@craiger.org>, "Walter A. Boring IV" <waboring@hemna.com>, Emre Saglam <emresaglam@gmail.com>, Jason Martin <jhmartin@toger.us>, John <johng42@users.noreply.github.com>, Martiros Shakhzadyan <vrzh@vrzh.net>, Zoe Moore <zoenb@mailbox.org>, ranguli <hello@joshmurphy.ca>
6
- Maintainer-email: Craig Lamparter <craig@craiger.org>, "Walter A. Boring IV" <waboring@hemna.com>
7
- License:
8
- Apache License
9
- Version 2.0, January 2004
10
- http://www.apache.org/licenses/
11
-
12
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
-
14
- 1. Definitions.
15
-
16
- "License" shall mean the terms and conditions for use, reproduction,
17
- and distribution as defined by Sections 1 through 9 of this document.
18
-
19
- "Licensor" shall mean the copyright owner or entity authorized by
20
- the copyright owner that is granting the License.
21
-
22
- "Legal Entity" shall mean the union of the acting entity and all
23
- other entities that control, are controlled by, or are under common
24
- control with that entity. For the purposes of this definition,
25
- "control" means (i) the power, direct or indirect, to cause the
26
- direction or management of such entity, whether by contract or
27
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
- outstanding shares, or (iii) beneficial ownership of such entity.
29
-
30
- "You" (or "Your") shall mean an individual or Legal Entity
31
- exercising permissions granted by this License.
32
-
33
- "Source" form shall mean the preferred form for making modifications,
34
- including but not limited to software source code, documentation
35
- source, and configuration files.
36
-
37
- "Object" form shall mean any form resulting from mechanical
38
- transformation or translation of a Source form, including but
39
- not limited to compiled object code, generated documentation,
40
- and conversions to other media types.
41
-
42
- "Work" shall mean the work of authorship, whether in Source or
43
- Object form, made available under the License, as indicated by a
44
- copyright notice that is included in or attached to the work
45
- (an example is provided in the Appendix below).
46
-
47
- "Derivative Works" shall mean any work, whether in Source or Object
48
- form, that is based on (or derived from) the Work and for which the
49
- editorial revisions, annotations, elaborations, or other modifications
50
- represent, as a whole, an original work of authorship. For the purposes
51
- of this License, Derivative Works shall not include works that remain
52
- separable from, or merely link (or bind by name) to the interfaces of,
53
- the Work and Derivative Works thereof.
54
-
55
- "Contribution" shall mean any work of authorship, including
56
- the original version of the Work and any modifications or additions
57
- to that Work or Derivative Works thereof, that is intentionally
58
- submitted to Licensor for inclusion in the Work by the copyright owner
59
- or by an individual or Legal Entity authorized to submit on behalf of
60
- the copyright owner. For the purposes of this definition, "submitted"
61
- means any form of electronic, verbal, or written communication sent
62
- to the Licensor or its representatives, including but not limited to
63
- communication on electronic mailing lists, source code control systems,
64
- and issue tracking systems that are managed by, or on behalf of, the
65
- Licensor for the purpose of discussing and improving the Work, but
66
- excluding communication that is conspicuously marked or otherwise
67
- designated in writing by the copyright owner as "Not a Contribution."
68
-
69
- "Contributor" shall mean Licensor and any individual or Legal Entity
70
- on behalf of whom a Contribution has been received by Licensor and
71
- subsequently incorporated within the Work.
72
-
73
- 2. Grant of Copyright License. Subject to the terms and conditions of
74
- this License, each Contributor hereby grants to You a perpetual,
75
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
- copyright license to reproduce, prepare Derivative Works of,
77
- publicly display, publicly perform, sublicense, and distribute the
78
- Work and such Derivative Works in Source or Object form.
79
-
80
- 3. Grant of Patent License. Subject to the terms and conditions of
81
- this License, each Contributor hereby grants to You a perpetual,
82
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
- (except as stated in this section) patent license to make, have made,
84
- use, offer to sell, sell, import, and otherwise transfer the Work,
85
- where such license applies only to those patent claims licensable
86
- by such Contributor that are necessarily infringed by their
87
- Contribution(s) alone or by combination of their Contribution(s)
88
- with the Work to which such Contribution(s) was submitted. If You
89
- institute patent litigation against any entity (including a
90
- cross-claim or counterclaim in a lawsuit) alleging that the Work
91
- or a Contribution incorporated within the Work constitutes direct
92
- or contributory patent infringement, then any patent licenses
93
- granted to You under this License for that Work shall terminate
94
- as of the date such litigation is filed.
95
-
96
- 4. Redistribution. You may reproduce and distribute copies of the
97
- Work or Derivative Works thereof in any medium, with or without
98
- modifications, and in Source or Object form, provided that You
99
- meet the following conditions:
100
-
101
- (a) You must give any other recipients of the Work or
102
- Derivative Works a copy of this License; and
103
-
104
- (b) You must cause any modified files to carry prominent notices
105
- stating that You changed the files; and
106
-
107
- (c) You must retain, in the Source form of any Derivative Works
108
- that You distribute, all copyright, patent, trademark, and
109
- attribution notices from the Source form of the Work,
110
- excluding those notices that do not pertain to any part of
111
- the Derivative Works; and
112
-
113
- (d) If the Work includes a "NOTICE" text file as part of its
114
- distribution, then any Derivative Works that You distribute must
115
- include a readable copy of the attribution notices contained
116
- within such NOTICE file, excluding those notices that do not
117
- pertain to any part of the Derivative Works, in at least one
118
- of the following places: within a NOTICE text file distributed
119
- as part of the Derivative Works; within the Source form or
120
- documentation, if provided along with the Derivative Works; or,
121
- within a display generated by the Derivative Works, if and
122
- wherever such third-party notices normally appear. The contents
123
- of the NOTICE file are for informational purposes only and
124
- do not modify the License. You may add Your own attribution
125
- notices within Derivative Works that You distribute, alongside
126
- or as an addendum to the NOTICE text from the Work, provided
127
- that such additional attribution notices cannot be construed
128
- as modifying the License.
129
-
130
- You may add Your own copyright statement to Your modifications and
131
- may provide additional or different license terms and conditions
132
- for use, reproduction, or distribution of Your modifications, or
133
- for any such Derivative Works as a whole, provided Your use,
134
- reproduction, and distribution of the Work otherwise complies with
135
- the conditions stated in this License.
136
-
137
- 5. Submission of Contributions. Unless You explicitly state otherwise,
138
- any Contribution intentionally submitted for inclusion in the Work
139
- by You to the Licensor shall be under the terms and conditions of
140
- this License, without any additional terms or conditions.
141
- Notwithstanding the above, nothing herein shall supersede or modify
142
- the terms of any separate license agreement you may have executed
143
- with Licensor regarding such Contributions.
144
-
145
- 6. Trademarks. This License does not grant permission to use the trade
146
- names, trademarks, service marks, or product names of the Licensor,
147
- except as required for reasonable and customary use in describing the
148
- origin of the Work and reproducing the content of the NOTICE file.
149
-
150
- 7. Disclaimer of Warranty. Unless required by applicable law or
151
- agreed to in writing, Licensor provides the Work (and each
152
- Contributor provides its Contributions) on an "AS IS" BASIS,
153
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
- implied, including, without limitation, any warranties or conditions
155
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
- PARTICULAR PURPOSE. You are solely responsible for determining the
157
- appropriateness of using or redistributing the Work and assume any
158
- risks associated with Your exercise of permissions under this License.
159
-
160
- 8. Limitation of Liability. In no event and under no legal theory,
161
- whether in tort (including negligence), contract, or otherwise,
162
- unless required by applicable law (such as deliberate and grossly
163
- negligent acts) or agreed to in writing, shall any Contributor be
164
- liable to You for damages, including any direct, indirect, special,
165
- incidental, or consequential damages of any character arising as a
166
- result of this License or out of the use or inability to use the
167
- Work (including but not limited to damages for loss of goodwill,
168
- work stoppage, computer failure or malfunction, or any and all
169
- other commercial damages or losses), even if such Contributor
170
- has been advised of the possibility of such damages.
171
-
172
- 9. Accepting Warranty or Additional Liability. While redistributing
173
- the Work or Derivative Works thereof, You may choose to offer,
174
- and charge a fee for, acceptance of support, warranty, indemnity,
175
- or other liability obligations and/or rights consistent with this
176
- License. However, in accepting such obligations, You may act only
177
- on Your own behalf and on Your sole responsibility, not on behalf
178
- of any other Contributor, and only if You agree to indemnify,
179
- defend, and hold each Contributor harmless for any liability
180
- incurred by, or claims asserted against, such Contributor by reason
181
- of your accepting any such warranty or additional liability.
182
-
183
- Project-URL: Homepage, https://github.com/craigerl/aprsd
184
- Project-URL: Bug Reports, https://github.com/craigerl/aprsd/issues
185
- Project-URL: Source, https://github.com/craigerl/aprsd
186
- Keywords: aprs,aprs-is,aprsd,aprsd-server,aprsd-client,aprsd-socket,aprsd-socket-server,aprsd-socket-client
187
- Classifier: Development Status :: 5 - Production/Stable
188
- Classifier: Environment :: Console
189
- Classifier: Intended Audience :: Developers
190
- Classifier: Intended Audience :: End Users/Desktop
191
- Classifier: Intended Audience :: Information Technology
192
- Classifier: Topic :: Communications :: Ham Radio
193
- Classifier: Topic :: Internet
194
- Classifier: Programming Language :: Python :: 3 :: Only
195
- Classifier: Programming Language :: Python :: 3
196
- Classifier: Programming Language :: Python :: 3.8
197
- Classifier: Programming Language :: Python :: 3.9
198
- Classifier: Programming Language :: Python :: 3.10
199
- Classifier: Programming Language :: Python :: 3.11
200
- Requires-Python: >=3.8
201
- Description-Content-Type: text/x-rst
202
- License-File: LICENSE
203
- License-File: AUTHORS
204
- Requires-Dist: aprslib==0.7.2
205
- Requires-Dist: attrs==24.2.0
206
- Requires-Dist: ax253==0.1.5.post1
207
- Requires-Dist: beautifulsoup4==4.12.3
208
- Requires-Dist: bidict==0.23.1
209
- Requires-Dist: bitarray==3.0.0
210
- Requires-Dist: blinker==1.9.0
211
- Requires-Dist: certifi==2024.8.30
212
- Requires-Dist: charset-normalizer==3.4.0
213
- Requires-Dist: click==8.1.7
214
- Requires-Dist: click-params==0.5.0
215
- Requires-Dist: commonmark==0.9.1
216
- Requires-Dist: dataclasses-json==0.6.7
217
- Requires-Dist: debtcollector==3.0.0
218
- Requires-Dist: deprecated==1.2.15
219
- Requires-Dist: flask==3.1.0
220
- Requires-Dist: flask-httpauth==4.8.0
221
- Requires-Dist: flask-socketio==5.4.1
222
- Requires-Dist: geographiclib==2.0
223
- Requires-Dist: geopy==2.4.1
224
- Requires-Dist: h11==0.14.0
225
- Requires-Dist: idna==3.10
226
- Requires-Dist: imapclient==3.0.1
227
- Requires-Dist: importlib-metadata==8.5.0
228
- Requires-Dist: itsdangerous==2.2.0
229
- Requires-Dist: jinja2==3.1.4
230
- Requires-Dist: kiss3==8.0.0
231
- Requires-Dist: loguru==0.7.2
232
- Requires-Dist: markupsafe==3.0.2
233
- Requires-Dist: marshmallow==3.23.1
234
- Requires-Dist: mypy-extensions==1.0.0
235
- Requires-Dist: netaddr==1.3.0
236
- Requires-Dist: oslo-config==9.7.0
237
- Requires-Dist: oslo-i18n==6.5.0
238
- Requires-Dist: packaging==24.2
239
- Requires-Dist: pbr==6.1.0
240
- Requires-Dist: pluggy==1.5.0
241
- Requires-Dist: pygments==2.18.0
242
- Requires-Dist: pyserial==3.5
243
- Requires-Dist: pyserial-asyncio==0.6
244
- Requires-Dist: python-engineio==4.10.1
245
- Requires-Dist: python-socketio==5.11.4
246
- Requires-Dist: pytz==2024.2
247
- Requires-Dist: pyyaml==6.0.2
248
- Requires-Dist: requests==2.32.3
249
- Requires-Dist: rfc3986==2.0.0
250
- Requires-Dist: rich==12.6.0
251
- Requires-Dist: rush==2021.4.0
252
- Requires-Dist: shellingham==1.5.4
253
- Requires-Dist: simple-websocket==1.1.0
254
- Requires-Dist: six==1.16.0
255
- Requires-Dist: soupsieve==2.6
256
- Requires-Dist: stevedore==5.4.0
257
- Requires-Dist: tabulate==0.9.0
258
- Requires-Dist: thesmuggler==1.0.1
259
- Requires-Dist: timeago==1.0.16
260
- Requires-Dist: typing-extensions==4.12.2
261
- Requires-Dist: typing-inspect==0.9.0
262
- Requires-Dist: tzlocal==5.2
263
- Requires-Dist: update-checker==0.18.0
264
- Requires-Dist: urllib3==2.2.3
265
- Requires-Dist: validators==0.22.0
266
- Requires-Dist: werkzeug==3.1.3
267
- Requires-Dist: wrapt==1.17.0
268
- Requires-Dist: wsproto==1.2.0
269
- Requires-Dist: zipp==3.21.0
270
- Provides-Extra: dev
271
- Requires-Dist: add-trailing-comma==3.1.0; extra == "dev"
272
- Requires-Dist: alabaster==1.0.0; extra == "dev"
273
- Requires-Dist: autoflake==1.5.3; extra == "dev"
274
- Requires-Dist: babel==2.16.0; extra == "dev"
275
- Requires-Dist: black==24.10.0; extra == "dev"
276
- Requires-Dist: build==1.2.2.post1; extra == "dev"
277
- Requires-Dist: cachetools==5.5.0; extra == "dev"
278
- Requires-Dist: certifi==2024.8.30; extra == "dev"
279
- Requires-Dist: cfgv==3.4.0; extra == "dev"
280
- Requires-Dist: chardet==5.2.0; extra == "dev"
281
- Requires-Dist: charset-normalizer==3.4.0; extra == "dev"
282
- Requires-Dist: check-manifest==0.50; extra == "dev"
283
- Requires-Dist: click==8.1.7; extra == "dev"
284
- Requires-Dist: colorama==0.4.6; extra == "dev"
285
- Requires-Dist: commonmark==0.9.1; extra == "dev"
286
- Requires-Dist: configargparse==1.7; extra == "dev"
287
- Requires-Dist: coverage[toml]==7.6.8; extra == "dev"
288
- Requires-Dist: distlib==0.3.9; extra == "dev"
289
- Requires-Dist: docutils==0.21.2; extra == "dev"
290
- Requires-Dist: exceptiongroup==1.2.2; extra == "dev"
291
- Requires-Dist: filelock==3.16.1; extra == "dev"
292
- Requires-Dist: fixit==2.1.0; extra == "dev"
293
- Requires-Dist: flake8==7.1.1; extra == "dev"
294
- Requires-Dist: gray==0.15.0; extra == "dev"
295
- Requires-Dist: identify==2.6.3; extra == "dev"
296
- Requires-Dist: idna==3.10; extra == "dev"
297
- Requires-Dist: imagesize==1.4.1; extra == "dev"
298
- Requires-Dist: iniconfig==2.0.0; extra == "dev"
299
- Requires-Dist: isort==5.13.2; extra == "dev"
300
- Requires-Dist: jinja2==3.1.4; extra == "dev"
301
- Requires-Dist: libcst==1.5.1; extra == "dev"
302
- Requires-Dist: m2r==0.3.1; extra == "dev"
303
- Requires-Dist: markupsafe==3.0.2; extra == "dev"
304
- Requires-Dist: mccabe==0.7.0; extra == "dev"
305
- Requires-Dist: mistune==0.8.4; extra == "dev"
306
- Requires-Dist: moreorless==0.4.0; extra == "dev"
307
- Requires-Dist: mypy==1.13.0; extra == "dev"
308
- Requires-Dist: mypy-extensions==1.0.0; extra == "dev"
309
- Requires-Dist: nodeenv==1.9.1; extra == "dev"
310
- Requires-Dist: packaging==24.2; extra == "dev"
311
- Requires-Dist: pathspec==0.12.1; extra == "dev"
312
- Requires-Dist: pep8-naming==0.14.1; extra == "dev"
313
- Requires-Dist: pip-tools==7.4.1; extra == "dev"
314
- Requires-Dist: platformdirs==4.3.6; extra == "dev"
315
- Requires-Dist: pluggy==1.5.0; extra == "dev"
316
- Requires-Dist: pre-commit==4.0.1; extra == "dev"
317
- Requires-Dist: pycodestyle==2.12.1; extra == "dev"
318
- Requires-Dist: pyflakes==3.2.0; extra == "dev"
319
- Requires-Dist: pygments==2.18.0; extra == "dev"
320
- Requires-Dist: pyproject-api==1.8.0; extra == "dev"
321
- Requires-Dist: pyproject-hooks==1.2.0; extra == "dev"
322
- Requires-Dist: pytest==8.3.4; extra == "dev"
323
- Requires-Dist: pytest-cov==6.0.0; extra == "dev"
324
- Requires-Dist: pyupgrade==3.19.0; extra == "dev"
325
- Requires-Dist: pyyaml==6.0.2; extra == "dev"
326
- Requires-Dist: requests==2.32.3; extra == "dev"
327
- Requires-Dist: rich==12.6.0; extra == "dev"
328
- Requires-Dist: snowballstemmer==2.2.0; extra == "dev"
329
- Requires-Dist: sphinx==8.1.3; extra == "dev"
330
- Requires-Dist: sphinxcontrib-applehelp==2.0.0; extra == "dev"
331
- Requires-Dist: sphinxcontrib-devhelp==2.0.0; extra == "dev"
332
- Requires-Dist: sphinxcontrib-htmlhelp==2.1.0; extra == "dev"
333
- Requires-Dist: sphinxcontrib-jsmath==1.0.1; extra == "dev"
334
- Requires-Dist: sphinxcontrib-qthelp==2.0.0; extra == "dev"
335
- Requires-Dist: sphinxcontrib-serializinghtml==2.0.0; extra == "dev"
336
- Requires-Dist: tokenize-rt==6.1.0; extra == "dev"
337
- Requires-Dist: toml==0.10.2; extra == "dev"
338
- Requires-Dist: tomli==2.2.1; extra == "dev"
339
- Requires-Dist: tox==4.23.2; extra == "dev"
340
- Requires-Dist: trailrunner==1.4.0; extra == "dev"
341
- Requires-Dist: typing-extensions==4.12.2; extra == "dev"
342
- Requires-Dist: unify==0.5; extra == "dev"
343
- Requires-Dist: untokenize==0.1.1; extra == "dev"
344
- Requires-Dist: urllib3==2.2.3; extra == "dev"
345
- Requires-Dist: virtualenv==20.28.0; extra == "dev"
346
- Requires-Dist: wheel==0.45.1; extra == "dev"
347
-
348
- ===============================================
349
- APRSD - Ham radio APRS-IS Message plugin server
350
- ===============================================
351
-
352
- KM6LYW and WB4BOR
353
- ____________________
354
-
355
- |pypi| |pytest| |versions| |slack| |issues| |commit| |imports| |down|
356
-
357
-
358
- `APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.
359
-
360
-
361
- Table of Contents
362
- =================
363
-
364
- 1. `What is APRSD <#what-is-aprsd>`_
365
- 2. `APRSD Overview Diagram <#aprsd-overview-diagram>`_
366
- 3. `Typical Use Case <#typical-use-case>`_
367
- 4. `Installation <#installation>`_
368
- 5. `Example Usage <#example-usage>`_
369
- 6. `Help <#help>`_
370
- 7. `Commands <#commands>`_
371
- - `Configuration <#configuration>`_
372
- - `Server <#server>`_
373
- - `Current List of Built-in Plugins <#current-list-of-built-in-plugins>`_
374
- - `Pypi.org APRSD Installable Plugin Packages <#pypiorg-aprsd-installable-plugin-packages>`_
375
- - `🐍 APRSD Installed 3rd Party Plugins <#aprsd-installed-3rd-party-plugins>`_
376
- - `Send Message <#send-message>`_
377
- - `Send Email (Radio to SMTP Server) <#send-email-radio-to-smtp-server>`_
378
- - `Receive Email (IMAP Server to Radio) <#receive-email-imap-server-to-radio>`_
379
- - `Location <#location>`_
380
- - `Web Admin Interface <#web-admin-interface>`_
381
- 8. `Development <#development>`_
382
- - `Building Your Own APRSD Plugins <#building-your-own-aprsd-plugins>`_
383
- 9. `Workflow <#workflow>`_
384
- 10. `Release <#release>`_
385
- 11. `Docker Container <#docker-container>`_
386
- - `Building <#building-1>`_
387
- - `Official Build <#official-build>`_
388
- - `Development Build <#development-build>`_
389
- - `Running the Container <#running-the-container>`_
390
-
391
-
392
- What is APRSD
393
- =============
394
- APRSD is a python application for interacting with the APRS network and providing
395
- APRS services for HAM radio operators.
396
-
397
- APRSD currently has 4 main commands to use.
398
- * server - Connect to APRS and listen/respond to APRS messages
399
- * webchat - web based chat program over APRS
400
- * send-message - Send a message to a callsign via APRS_IS.
401
- * listen - Listen to packets on the APRS-IS Network based on FILTER.
402
-
403
- Each of those commands can connect to the APRS-IS network if internet connectivity
404
- is available. If internet is not available, then APRS can be configured to talk
405
- to a TCP KISS TNC for radio connectivity.
406
-
407
- Please `read the docs`_ to learn more!
408
-
409
- APRSD Overview Diagram
410
- ======================
411
-
412
- .. image:: https://raw.githubusercontent.com/craigerl/aprsd/master/docs/_static/aprsd_overview.svg?sanitize=true
413
-
414
- Typical use case
415
- ================
416
-
417
- APRSD's typical use case is that of providing an APRS wide service to all HAM
418
- radio operators. For example the callsign 'REPEAT' on the APRS network is actually
419
- an instance of APRSD that can provide a list of HAM repeaters in the area of the
420
- callsign that sent the message.
421
-
422
-
423
- Ham radio operator using an APRS enabled HAM radio sends a message to check
424
- the weather. An APRS message is sent, and then picked up by APRSD. The
425
- APRS packet is decoded, and the message is sent through the list of plugins
426
- for processing. For example, the WeatherPlugin picks up the message, fetches the weather
427
- for the area around the user who sent the request, and then responds with
428
- the weather conditions in that area. Also includes a watch list of HAM
429
- callsigns to look out for. The watch list can notify you when a HAM callsign
430
- in the list is seen and now available to message on the APRS network.
431
-
432
-
433
-
434
- Installation
435
- =============
436
-
437
- To install ``aprsd``, use Pip:
438
-
439
- ``pip install aprsd``
440
-
441
- Example usage
442
- ==============
443
-
444
- ``aprsd -h``
445
-
446
- Help
447
- ====
448
- ::
449
-
450
-
451
- └─> aprsd -h
452
- Usage: aprsd [OPTIONS] COMMAND [ARGS]...
453
-
454
- Options:
455
- --version Show the version and exit.
456
- -h, --help Show this message and exit.
457
-
458
- Commands:
459
- check-version Check this version against the latest in pypi.org.
460
- completion Show the shell completion code
461
- dev Development type subcommands
462
- fetch-stats Fetch stats from a APRSD admin web interface.
463
- healthcheck Check the health of the running aprsd server.
464
- list-extensions List the built in plugins available to APRSD.
465
- list-plugins List the built in plugins available to APRSD.
466
- listen Listen to packets on the APRS-IS Network based on FILTER.
467
- sample-config Generate a sample Config file from aprsd and all...
468
- send-message Send a message to a callsign via APRS_IS.
469
- server Start the aprsd server gateway process.
470
- version Show the APRSD version.
471
- webchat Web based HAM Radio chat program!
472
-
473
-
474
- Commands
475
- ========
476
-
477
- Configuration
478
- =============
479
- This command outputs a sample config yml formatted block that you can edit
480
- and use to pass in to ``aprsd`` with ``-c``. By default aprsd looks in ``~/.config/aprsd/aprsd.yml``
481
-
482
- ``aprsd sample-config``
483
-
484
- ::
485
-
486
- └─> aprsd sample-config
487
- ...
488
-
489
- server
490
- ======
491
-
492
- This is the main server command that will listen to APRS-IS servers and
493
- look for incomming commands to the callsign configured in the config file
494
-
495
- ::
496
-
497
- └─[$] > aprsd server --help
498
- Usage: aprsd server [OPTIONS]
499
-
500
- Start the aprsd server gateway process.
501
-
502
- Options:
503
- --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
504
- The log level to use for aprsd.log
505
- [default: INFO]
506
- -c, --config TEXT The aprsd config file to use for options.
507
- [default:
508
- /Users/i530566/.config/aprsd/aprsd.yml]
509
- --quiet Don't log to stdout
510
- -f, --flush Flush out all old aged messages on disk.
511
- [default: False]
512
- -h, --help Show this message and exit.
513
-
514
- └─> aprsd server
515
- Load config
516
- 12/07/2021 03:16:17 PM MainThread INFO APRSD is up to date server.py:51
517
- 12/07/2021 03:16:17 PM MainThread INFO APRSD Started version: 2.5.6 server.py:52
518
- 12/07/2021 03:16:17 PM MainThread INFO Using CONFIG values: server.py:55
519
- 12/07/2021 03:16:17 PM MainThread INFO ham.callsign = WB4BOR server.py:60
520
- 12/07/2021 03:16:17 PM MainThread INFO aprs.login = WB4BOR-12 server.py:60
521
- 12/07/2021 03:16:17 PM MainThread INFO aprs.password = XXXXXXXXXXXXXXXXXXX server.py:58
522
- 12/07/2021 03:16:17 PM MainThread INFO aprs.host = noam.aprs2.net server.py:60
523
- 12/07/2021 03:16:17 PM MainThread INFO aprs.port = 14580 server.py:60
524
- 12/07/2021 03:16:17 PM MainThread INFO aprs.logfile = /tmp/aprsd.log server.py:60
525
-
526
-
527
- Current list of built-in plugins
528
- --------------------------------
529
- ::
530
-
531
- └─> aprsd list-plugins
532
- 🐍 APRSD Built-in Plugins 🐍
533
- ┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
534
- ┃ Plugin Name ┃ Info ┃ Type ┃ Plugin Path ┃
535
- ┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
536
- │ AVWXWeatherPlugin │ AVWX weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.AVWXWeatherPlugin │
537
- │ EmailPlugin │ Send and Receive email │ RegexCommand │ aprsd.plugins.email.EmailPlugin │
538
- │ FortunePlugin │ Give me a fortune │ RegexCommand │ aprsd.plugins.fortune.FortunePlugin │
539
- │ LocationPlugin │ Where in the world is a CALLSIGN's last GPS beacon? │ RegexCommand │ aprsd.plugins.location.LocationPlugin │
540
- │ NotifySeenPlugin │ Notify me when a CALLSIGN is recently seen on APRS-IS │ WatchList │ aprsd.plugins.notify.NotifySeenPlugin │
541
- │ OWMWeatherPlugin │ OpenWeatherMap weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.OWMWeatherPlugin │
542
- │ PingPlugin │ reply with a Pong! │ RegexCommand │ aprsd.plugins.ping.PingPlugin │
543
- │ QueryPlugin │ APRSD Owner command to query messages in the MsgTrack │ RegexCommand │ aprsd.plugins.query.QueryPlugin │
544
- │ TimeOWMPlugin │ Current time of GPS beacon's timezone. Uses OpenWeatherMap │ RegexCommand │ aprsd.plugins.time.TimeOWMPlugin │
545
- │ TimePlugin │ What is the current local time. │ RegexCommand │ aprsd.plugins.time.TimePlugin │
546
- │ USMetarPlugin │ USA only METAR of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.USMetarPlugin │
547
- │ USWeatherPlugin │ Provide USA only weather of GPS Beacon location │ RegexCommand │ aprsd.plugins.weather.USWeatherPlugin │
548
- │ VersionPlugin │ What is the APRSD Version │ RegexCommand │ aprsd.plugins.version.VersionPlugin │
549
- └───────────────────┴────────────────────────────────────────────────────────────┴──────────────┴─────────────────────────────────────────┘
550
-
551
-
552
- Pypi.org APRSD Installable Plugin Packages
553
-
554
- Install any of the following plugins with 'pip install <Plugin Package Name>'
555
- ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
556
- ┃ Plugin Package Name ┃ Description ┃ Version ┃ Released ┃ Installed? ┃
557
- ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
558
- │ 📂 aprsd-stock-plugin │ Ham Radio APRSD Plugin for fetching stock quotes │ 0.1.3 │ Dec 2, 2022 │ No │
559
- │ 📂 aprsd-sentry-plugin │ Ham radio APRSD plugin that does.... │ 0.1.2 │ Dec 2, 2022 │ No │
560
- │ 📂 aprsd-timeopencage-plugin │ APRSD plugin for fetching time based on GPS location │ 0.1.0 │ Dec 2, 2022 │ No │
561
- │ 📂 aprsd-weewx-plugin │ HAM Radio APRSD that reports weather from a weewx weather station. │ 0.1.4 │ Dec 7, 2021 │ Yes │
562
- │ 📂 aprsd-repeat-plugins │ APRSD Plugins for the REPEAT service │ 1.0.12 │ Dec 2, 2022 │ No │
563
- │ 📂 aprsd-telegram-plugin │ Ham Radio APRS APRSD plugin for Telegram IM service │ 0.1.3 │ Dec 2, 2022 │ No │
564
- │ 📂 aprsd-twitter-plugin │ Python APRSD plugin to send tweets │ 0.3.0 │ Dec 7, 2021 │ No │
565
- │ 📂 aprsd-slack-plugin │ Amateur radio APRS daemon which listens for messages and responds │ 1.0.5 │ Dec 18, 2022 │ No │
566
- └──────────────────────────────┴────────────────────────────────────────────────────────────────────┴─────────┴──────────────┴────────────┘
567
-
568
-
569
- 🐍 APRSD Installed 3rd party Plugins 🐍
570
- ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
571
- ┃ Package Name ┃ Plugin Name ┃ Version ┃ Type ┃ Plugin Path ┃
572
- ┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
573
- │ aprsd-weewx-plugin │ WeewxMQTTPlugin │ 1.0 │ RegexCommand │ aprsd_weewx_plugin.weewx.WeewxMQTTPlugin │
574
- └────────────────────┴─────────────────┴─────────┴──────────────┴──────────────────────────────────────────┘
575
-
576
-
577
-
578
- send-message
579
- ============
580
-
581
- This command is typically used for development to send another aprsd instance
582
- test messages
583
-
584
- ::
585
-
586
- └─[$] > aprsd send-message -h
587
- Usage: aprsd send-message [OPTIONS] TOCALLSIGN COMMAND...
588
-
589
- Send a message to a callsign via APRS_IS.
590
-
591
- Options:
592
- --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
593
- The log level to use for aprsd.log
594
- [default: INFO]
595
- -c, --config TEXT The aprsd config file to use for options.
596
- [default:
597
- /Users/i530566/.config/aprsd/aprsd.yml]
598
- --quiet Don't log to stdout
599
- --aprs-login TEXT What callsign to send the message from.
600
- [env var: APRS_LOGIN]
601
- --aprs-password TEXT the APRS-IS password for APRS_LOGIN [env
602
- var: APRS_PASSWORD]
603
- -n, --no-ack Don't wait for an ack, just sent it to APRS-
604
- IS and bail. [default: False]
605
- -w, --wait-response Wait for a response to the message?
606
- [default: False]
607
- --raw TEXT Send a raw message. Implies --no-ack
608
- -h, --help Show this message and exit.
609
-
610
-
611
- SEND EMAIL (radio to smtp server)
612
- =================================
613
-
614
- ::
615
-
616
- Received message______________
617
- Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :-user@host.com test new shortcuts global, radio to pc{29
618
- From : KM6XXX
619
- Message : -user@host.com test new shortcuts global, radio to pc
620
- Msg number : 29
621
-
622
- Sending Email_________________
623
- To : user@host.com
624
- Subject : KM6XXX
625
- Body : test new shortcuts global, radio to pc
626
-
627
- Sending ack __________________ Tx(3)
628
- Raw : KM6XXX-9>APRS::KM6XXX :ack29
629
- To : KM6XXX
630
- Ack number : 29
631
-
632
-
633
- RECEIVE EMAIL (imap server to radio)
634
- ====================================
635
-
636
- ::
637
-
638
- Sending message_______________ 6(Tx3)
639
- Raw : KM6XXX-9>APRS::KM6XXX :-somebody@gmail.com email from internet to radio{6
640
- To : KM6XXX
641
- Message : -somebody@gmail.com email from internet to radio
642
-
643
- Received message______________
644
- Raw : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6
645
- From : KM6XXX
646
- Message : ack6
647
- Msg number : 0
648
-
649
-
650
- LOCATION
651
- ========
652
-
653
- ::
654
-
655
- Received Message _______________
656
- Raw : KM6XXX-6>APRS,TCPIP*,qAC,T2CAEAST::KM6XXX-14:location{2
657
- From : KM6XXX-6
658
- Message : location
659
- Msg number : 2
660
- Received Message _______________ Complete
661
-
662
- Sending Message _______________
663
- Raw : KM6XXX-14>APRS::KM6XXX-6 :KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago{2
664
- To : KM6XXX-6
665
- Message : KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago
666
- Msg number : 2
667
- Sending Message _______________ Complete
668
-
669
- Sending ack _______________
670
- Raw : KM6XXX-14>APRS::KM6XXX-6 :ack2
671
- To : KM6XXX-6
672
- Ack : 2
673
- Sending ack _______________ Complete
674
-
675
- AND... ping, fortune, time.....
676
-
677
-
678
- Web Admin Interface
679
- ===================
680
- APRSD has a web admin interface that allows you to view the status of the running APRSD server instance.
681
- The web admin interface shows graphs of packet counts, packet types, number of threads running, the latest
682
- packets sent and received, and the status of each of the plugins that are loaded. You can also view the logfile
683
- and view the raw APRSD configuration file.
684
-
685
- To start the web admin interface, You have to install gunicorn in your virtualenv that already has aprsd installed.
686
-
687
- ::
688
-
689
- source <path to APRSD's virtualenv>/bin/activate
690
- aprsd admin --loglevel INFO
691
-
692
- The web admin interface will be running on port 8080 on the local machine. http://localhost:8080
693
-
694
-
695
- Development
696
- ===========
697
-
698
- * ``git clone git@github.com:craigerl/aprsd.git``
699
- * ``cd aprsd``
700
- * ``make``
701
-
702
- Workflow
703
- --------
704
-
705
- While working aprsd, The workflow is as follows:
706
-
707
- * Checkout a new branch to work on by running
708
-
709
- ``git checkout -b mybranch``
710
-
711
- * Make your changes to the code
712
- * Run Tox with the following options:
713
-
714
- - ``tox -epep8``
715
- - ``tox -efmt``
716
- - ``tox -p``
717
-
718
- * Commit your changes. This will run the pre-commit hooks which does checks too
719
-
720
- ``git commit``
721
-
722
- * Once you are done with all of your commits, then push up the branch to
723
- github with:
724
-
725
- ``git push -u origin mybranch``
726
-
727
- * Create a pull request from your branch so github tests can run and we can do
728
- a code review.
729
-
730
-
731
- Release
732
- -------
733
-
734
- To do release to pypi:
735
-
736
- * Tag release with:
737
-
738
- ``git tag -v1.XX -m "New release"``
739
-
740
- * Push release tag:
741
-
742
- ``git push origin master --tags``
743
-
744
- * Do a test build and verify build is valid by running:
745
-
746
- ``make build``
747
-
748
- * Once twine is happy, upload release to pypi:
749
-
750
- ``make upload``
751
-
752
-
753
- Building your own APRSD plugins
754
- -------------------------------
755
-
756
- APRSD plugins are the mechanism by which APRSD can respond to APRS Messages. The plugins are loaded at server startup
757
- and can also be loaded at listen startup. When a packet is received by APRSD, it is passed to each of the plugins
758
- in the order they were registered in the config file. The plugins can then decide what to do with the packet.
759
- When a plugin is called, it is passed a APRSD Packet object. The plugin can then do something with the packet and
760
- return a reply message if desired. If a plugin does not want to reply to the packet, it can just return None.
761
- When a plugin does return a reply message, APRSD will send the reply message to the appropriate destination.
762
-
763
- For example, when a 'ping' message is received, the PingPlugin will return a reply message of 'pong'. When APRSD
764
- receives the 'pong' message, it will be sent back to the original caller of the ping message.
765
-
766
- APRSD plugins are simply python packages that can be installed from pypi.org. They are installed into the
767
- aprsd virtualenv and can be imported by APRSD at runtime. The plugins are registered in the config file and loaded
768
- at startup of the aprsd server command or the aprsd listen command.
769
-
770
- Overview
771
- --------
772
- You can build your own plugins by following the instructions in the `Building your own APRSD plugins`_ section.
773
-
774
- Plugins are called by APRSD when packe
775
-
776
- Docker Container
777
- ================
778
-
779
- Building
780
- ========
781
-
782
- There are 2 versions of the container Dockerfile that can be used.
783
- The main Dockerfile, which is for building the official release container
784
- based off of the pip install version of aprsd and the Dockerfile-dev,
785
- which is used for building a container based off of a git branch of
786
- the repo.
787
-
788
- Official Build
789
- ==============
790
-
791
- ``docker build -t hemna6969/aprsd:latest .``
792
-
793
- Development Build
794
- =================
795
-
796
- ``docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .``
797
-
798
-
799
- Running the container
800
- =====================
801
-
802
- There is a ``docker-compose.yml`` file in the ``docker/`` directory
803
- that can be used to run your container. To provide the container
804
- an ``aprsd.conf`` configuration file, change your
805
- ``docker-compose.yml`` as shown below:
806
-
807
- ::
808
-
809
- volumes:
810
- - $HOME/.config/aprsd:/config
811
-
812
- To install plugins at container start time, pass in a list of
813
- comma-separated list of plugins on PyPI using the ``APRSD_PLUGINS``
814
- environment variable in the ``docker-compose.yml`` file. Note that
815
- version constraints may also be provided. For example:
816
-
817
- ::
818
-
819
- environment:
820
- - APRSD_PLUGINS=aprsd-slack-plugin>=1.0.2,aprsd-twitter-plugin
821
-
822
-
823
- .. badges
824
-
825
- .. |pypi| image:: https://badge.fury.io/py/aprsd.svg
826
- :target: https://badge.fury.io/py/aprsd
827
-
828
- .. |pytest| image:: https://github.com/craigerl/aprsd/workflows/python/badge.svg
829
- :target: https://github.com/craigerl/aprsd/actions
830
-
831
- .. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd.svg
832
- :target: https://pypi.org/pypi/aprsd
833
-
834
- .. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack
835
- :target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP
836
-
837
- .. |imports| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
838
- :target: https://timothycrosley.github.io/isort/
839
-
840
- .. |issues| image:: https://img.shields.io/github/issues/craigerl/aprsd
841
-
842
- .. |commit| image:: https://img.shields.io/github/last-commit/craigerl/aprsd
843
-
844
- .. |down| image:: https://static.pepy.tech/personalized-badge/aprsd?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads
845
- :target: https://pepy.tech/project/aprsd
846
-
847
- .. links
848
- .. _read the docs:
849
- https://aprsd.readthedocs.io