aprsd 3.4.3__tar.gz → 3.4.4__tar.gz

{aprsd-3.4.3 → aprsd-3.4.4}/ChangeLog.md

@@ -4,12 +4,81 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [3.4.4](https://github.com/craigerl/aprsd/compare/3.4.3...3.4.4)
+
+> 6 December 2024
+
+- Update counter.py [`#182`](https://github.com/craigerl/aprsd/pull/182)
+- Added an option to disable the loading of the help plugin. [`#177`](https://github.com/craigerl/aprsd/pull/177)
+- Added unit test for client base [`#181`](https://github.com/craigerl/aprsd/pull/181)
+- Walt listen test [`#180`](https://github.com/craigerl/aprsd/pull/180)
+- Bump werkzeug from 3.0.4 to 3.0.6 [`#178`](https://github.com/craigerl/aprsd/pull/178)
+- Added new aprsd admin command [`0271ccd`](https://github.com/craigerl/aprsd/commit/0271ccd14582cf042846e9c65c64fe501538bc5a)
+- Added some changes to listen [`df0ca04`](https://github.com/craigerl/aprsd/commit/df0ca0448373b1ce5707b01b2acaca9a50340715)
+- Added some changes to listen [`d863474`](https://github.com/craigerl/aprsd/commit/d863474c133d7650f9c79d1a88f0a4a04a2b056f)
+- Fix a small issue with packet sending failures [`3fd6069`](https://github.com/craigerl/aprsd/commit/3fd606946db8df368da0cd0e9f6e9a0c18d36525)
+- Fix a small issue with packet sending failures [`f265e8f`](https://github.com/craigerl/aprsd/commit/f265e8f3541701eeaaba820ed93eb23902b40f05)
+- Added new dump-stats command [`add18f1`](https://github.com/craigerl/aprsd/commit/add18f1a6f08a8eda6729c82634c0e68f73b48f8)
+- Update PacketList [`7e8d7cd`](https://github.com/craigerl/aprsd/commit/7e8d7cdf8671fbc559400ef2041d5bbe6fdb8c6d)
+- Updated APRSClient [`d808e21`](https://github.com/craigerl/aprsd/commit/d808e217a2bdd1cfffa7d69344a0b9a664bf2f6f)
+- Calculate delta once and reuse it [`0be87d8`](https://github.com/craigerl/aprsd/commit/0be87d8b4f1fa258a5cd32188eccd4aa22b7446e)
+- Added unit test for ClientFactory [`ab2de86`](https://github.com/craigerl/aprsd/commit/ab2de86726106582c06230ed4e513d78f0bafb03)
+- Added unit test for APRSISClient [`224686c`](https://github.com/craigerl/aprsd/commit/224686cac5e4cefd559fb9149ccac18069914423)
+- optimized Packet.get() [`579d0c9`](https://github.com/craigerl/aprsd/commit/579d0c95a085a7cb796ae9476da8c48fca201601)
+- fixed name for dump-stats output [`563b068`](https://github.com/craigerl/aprsd/commit/563b06876c02eb9193b0c7559765e47d932a5978)
+- updated README.rst [`229155d`](https://github.com/craigerl/aprsd/commit/229155d0ee63aa80c8bc4ffbdbb5a3eb8a4a6e7c)
+- Only load EmailStats if email is enabled [`2fdc7b1`](https://github.com/craigerl/aprsd/commit/2fdc7b111d31006b568e820ee7aaa8290f5944b9)
+- Added rich output for dump-stats [`d0018a8`](https://github.com/craigerl/aprsd/commit/d0018a8cd39d8d9b74b83655083b33be2e2b70a7)
+- Allow disabling sending all AckPackets [`6e62ac1`](https://github.com/craigerl/aprsd/commit/6e62ac14b8cca193faf6c73464eb47e54efd7abe)
+- Allow loading a specific list of plugins [`9f3c8f8`](https://github.com/craigerl/aprsd/commit/9f3c8f889f1866a7747bc82c1b3c2c39687dcb1c)
+- Catch and log exceptions in consumer [`adcf94d`](https://github.com/craigerl/aprsd/commit/adcf94d8c755af7020ac93d7fb3731c637aefc3e)
+- Fixed the protocol for Stats Collector [`bd0bcc1`](https://github.com/craigerl/aprsd/commit/bd0bcc19244a8a5bf0bf851533eb303e7845c8ca)
+- Added new features to listen command. [`7d1e739`](https://github.com/craigerl/aprsd/commit/7d1e73950288c721bb5a07224bc4b5bb52bb9164)
+- Don't break logging aprslib failures [`98a6210`](https://github.com/craigerl/aprsd/commit/98a62102b742960ff7202b0614fc2801dd60ad12)
+- Change healthcheck email thread check timeout [`03ce5a3`](https://github.com/craigerl/aprsd/commit/03ce5a3d506a1304b93fd11cd2a43661f874d144)
+- Addressing comments in PR. [`2471492`](https://github.com/craigerl/aprsd/commit/24714923be4c55fdac434a868707e917b6ed21b1)
+- Update utils.trace [`c3df974`](https://github.com/craigerl/aprsd/commit/c3df97400458d1f3c72a03d0f9ae72addad63d29)
+- Update requirements [`257fa0d`](https://github.com/craigerl/aprsd/commit/257fa0db7d9f9cef8b3235cacf954adb862a2bfb)
+- Fixes for webchat UI. [`f0b9956`](https://github.com/craigerl/aprsd/commit/f0b99564d15fedb055c9e2cb1ea9146814024478)
+- Sending message to new callsign displays in an active tab [`d42638e`](https://github.com/craigerl/aprsd/commit/d42638efe3ebb22d777573d934ed4dd8216ac705)
+- Update WebChat [`9f7d169`](https://github.com/craigerl/aprsd/commit/9f7d169c18c6ac593d49efd9dde42bc40b28bc70)
+- Update Client to report login status [`06c1fb9`](https://github.com/craigerl/aprsd/commit/06c1fb985efea1f6697bedbe340557cde7225bf4)
+- Updated server client checks [`1c50c39`](https://github.com/craigerl/aprsd/commit/1c50c39e6104d6e9462fd9ed5e2deed7f9e6b1fe)
+- Fixed broken unit tests [`c82e9ba`](https://github.com/craigerl/aprsd/commit/c82e9ba5977424e6f03ddbbfcbd816634ef667ce)
+- Fixed pep8 failure on counter.py [`1eaa4b8`](https://github.com/craigerl/aprsd/commit/1eaa4b8e10f12ba8fe17b0cee44d6dee4a5689aa)
+- No reason to create the client in init [`e99c906`](https://github.com/craigerl/aprsd/commit/e99c906fed564fecae0f389fa21f25e624db9088)
+- Added APRSDThread pause/unpause capability [`95094b8`](https://github.com/craigerl/aprsd/commit/95094b874cc99201497cb7920a0c73c7c332e65a)
+- Added client_exists() for client factory [`505565d`](https://github.com/craigerl/aprsd/commit/505565d3a6befaba3b57c87c22333b0e965ab347)
+- Added pause_all, unpause_all in threadlist [`76d275d`](https://github.com/craigerl/aprsd/commit/76d275db9c8968ce5bd9b52e52fa39c9002aaa86)
+- Make sure to sleep(1) in the main RX thread [`98a96cb`](https://github.com/craigerl/aprsd/commit/98a96cbe34ee50bbd242542c5891768608e586b4)
+- Put safety checks around the timeago for keepalive [`be6357a`](https://github.com/craigerl/aprsd/commit/be6357a552e8c05b5fd5a94d4fb6318abaf78cfc)
+- Properly report TCPKISS connection [`3e488db`](https://github.com/craigerl/aprsd/commit/3e488db3d7e864c6b4411ce67d5018648faeac2d)
+- Fix call in kiss consumer [`aba5bb0`](https://github.com/craigerl/aprsd/commit/aba5bb03a2dd973e545a5f1ec0515c8f500ddadb)
+- Update RX Packet dupe checking [`8f3da96`](https://github.com/craigerl/aprsd/commit/8f3da961e7802340f9a77d437631c6bbe94e0102)
+- Webchat: Don't automatically fetch location KISS [`e8ae380`](https://github.com/craigerl/aprsd/commit/e8ae3807db87880ec65923854b07e5cc225a72c3)
+- Fixed issue not processing null msg ids [`a17b80d`](https://github.com/craigerl/aprsd/commit/a17b80ddd871bfd16c59b29a9a7f7ef34f921f6c)
+- Updated keepalive thread to report client [`8529f1f`](https://github.com/craigerl/aprsd/commit/8529f1f8d1a4a86a66aecfda6e6075c394bbff56)
+- Fixed webchat popovers not working. [`3a8b8f2`](https://github.com/craigerl/aprsd/commit/3a8b8f26dda9d7b4099061b2a24a393fb639124c)
+- Fixed issue with packet object and prepare() [`f66b962`](https://github.com/craigerl/aprsd/commit/f66b96288f7c594bc9775f28ffc93e3bbd3bb46f)
+- Fixed webchat packets without msgNo [`d4ae726`](https://github.com/craigerl/aprsd/commit/d4ae72608b9d7c2da1b89c20bf58fcae796f552d)
+- Added __contains__ to threadlist [`d94a3e7`](https://github.com/craigerl/aprsd/commit/d94a3e7b908fd313a8af0c71a4928114ea83cf35)
+- Update healthcheck [`7fb0c74`](https://github.com/craigerl/aprsd/commit/7fb0c7454ea9fe4cd5886989e9890ef70a789fdf)
+- Remove dataclasses from requirements [`db73a54`](https://github.com/craigerl/aprsd/commit/db73a540baf0c8d658d1f9efa08ba9f085ce01d4)
+- Update requirements.dev [`0d8a1ac`](https://github.com/craigerl/aprsd/commit/0d8a1ac33441cf85270423b80264110fe9286754)
+- Added new acked property to the core Packet [`3c058f3`](https://github.com/craigerl/aprsd/commit/3c058f3e7b89227c613234f8ae91687fbdf19ae1)
+- Fixed some pep8 failures [`63bcd41`](https://github.com/craigerl/aprsd/commit/63bcd4139bb40718152b66002dfa45f236c54e11)
+
+#### [3.4.3](https://github.com/craigerl/aprsd/compare/v3.4.3...3.4.3)
+
+> 18 November 2024
+
 #### [v3.4.3](https://github.com/craigerl/aprsd/compare/v3.4.2...v3.4.3)
 
 > 29 October 2024
 
 - Change virtual env name to .venv [`882e907`](https://github.com/craigerl/aprsd/commit/882e90767dd967a4d1018c834a074b33ca9dcb06)
 - Fixed issue in send_message command [`ecf30d3`](https://github.com/craigerl/aprsd/commit/ecf30d33978e26150bf41ff60b97ff00ab5d5f96)
+- Update Changelog for v3.4.3 [`5780626`](https://github.com/craigerl/aprsd/commit/578062648bb1c188e578c88000852e477a429364)
 
 #### [v3.4.2](https://github.com/craigerl/aprsd/compare/v3.4.1...v3.4.2)
 

{aprsd-3.4.3 → aprsd-3.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: aprsd
-Version: 3.4.3
+Version: 3.4.4
 Summary: APRSd is a APRS-IS server that can be used to connect to APRS-IS and send and receive APRS packets.
 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>
 Maintainer-email: Craig Lamparter <craig@craiger.org>, "Walter A. Boring IV" <waboring@hemna.com>
@@ -207,17 +207,16 @@ Requires-Dist: ax253==0.1.5.post1
 Requires-Dist: beautifulsoup4==4.12.3
 Requires-Dist: bidict==0.23.1
 Requires-Dist: bitarray==3.0.0
-Requires-Dist: blinker==1.8.2
+Requires-Dist: blinker==1.9.0
 Requires-Dist: certifi==2024.8.30
 Requires-Dist: charset-normalizer==3.4.0
 Requires-Dist: click==8.1.7
 Requires-Dist: click-params==0.5.0
 Requires-Dist: commonmark==0.9.1
-Requires-Dist: dataclasses==0.6
 Requires-Dist: dataclasses-json==0.6.7
 Requires-Dist: debtcollector==3.0.0
-Requires-Dist: deprecated==1.2.14
-Requires-Dist: flask==3.0.3
+Requires-Dist: deprecated==1.2.15
+Requires-Dist: flask==3.1.0
 Requires-Dist: flask-httpauth==4.8.0
 Requires-Dist: flask-socketio==5.4.1
 Requires-Dist: geographiclib==2.0
@@ -231,12 +230,12 @@ Requires-Dist: jinja2==3.1.4
 Requires-Dist: kiss3==8.0.0
 Requires-Dist: loguru==0.7.2
 Requires-Dist: markupsafe==3.0.2
-Requires-Dist: marshmallow==3.23.0
+Requires-Dist: marshmallow==3.23.1
 Requires-Dist: mypy-extensions==1.0.0
 Requires-Dist: netaddr==1.3.0
-Requires-Dist: oslo-config==9.6.0
-Requires-Dist: oslo-i18n==6.4.0
-Requires-Dist: packaging==24.1
+Requires-Dist: oslo-config==9.7.0
+Requires-Dist: oslo-i18n==6.5.0
+Requires-Dist: packaging==24.2
 Requires-Dist: pbr==6.1.0
 Requires-Dist: pluggy==1.5.0
 Requires-Dist: pygments==2.18.0
@@ -254,19 +253,20 @@ Requires-Dist: shellingham==1.5.4
 Requires-Dist: simple-websocket==1.1.0
 Requires-Dist: six==1.16.0
 Requires-Dist: soupsieve==2.6
-Requires-Dist: stevedore==5.3.0
+Requires-Dist: stevedore==5.4.0
 Requires-Dist: tabulate==0.9.0
 Requires-Dist: thesmuggler==1.0.1
+Requires-Dist: timeago==1.0.16
 Requires-Dist: typing-extensions==4.12.2
 Requires-Dist: typing-inspect==0.9.0
 Requires-Dist: tzlocal==5.2
 Requires-Dist: update-checker==0.18.0
 Requires-Dist: urllib3==2.2.3
 Requires-Dist: validators==0.22.0
-Requires-Dist: werkzeug==3.0.4
-Requires-Dist: wrapt==1.16.0
+Requires-Dist: werkzeug==3.1.3
+Requires-Dist: wrapt==1.17.0
 Requires-Dist: wsproto==1.2.0
-Requires-Dist: zipp==3.20.2
+Requires-Dist: zipp==3.21.0
 Provides-Extra: dev
 Requires-Dist: add-trailing-comma==3.1.0; extra == "dev"
 Requires-Dist: alabaster==1.0.0; extra == "dev"
@@ -284,7 +284,7 @@ Requires-Dist: click==8.1.7; extra == "dev"
 Requires-Dist: colorama==0.4.6; extra == "dev"
 Requires-Dist: commonmark==0.9.1; extra == "dev"
 Requires-Dist: configargparse==1.7; extra == "dev"
-Requires-Dist: coverage[toml]==7.6.3; extra == "dev"
+Requires-Dist: coverage[toml]==7.6.8; extra == "dev"
 Requires-Dist: distlib==0.3.9; extra == "dev"
 Requires-Dist: docutils==0.21.2; extra == "dev"
 Requires-Dist: exceptiongroup==1.2.2; extra == "dev"
@@ -292,22 +292,22 @@ Requires-Dist: filelock==3.16.1; extra == "dev"
 Requires-Dist: fixit==2.1.0; extra == "dev"
 Requires-Dist: flake8==7.1.1; extra == "dev"
 Requires-Dist: gray==0.15.0; extra == "dev"
-Requires-Dist: identify==2.6.1; extra == "dev"
+Requires-Dist: identify==2.6.3; extra == "dev"
 Requires-Dist: idna==3.10; extra == "dev"
 Requires-Dist: imagesize==1.4.1; extra == "dev"
 Requires-Dist: iniconfig==2.0.0; extra == "dev"
 Requires-Dist: isort==5.13.2; extra == "dev"
 Requires-Dist: jinja2==3.1.4; extra == "dev"
-Requires-Dist: libcst==1.5.0; extra == "dev"
+Requires-Dist: libcst==1.5.1; extra == "dev"
 Requires-Dist: m2r==0.3.1; extra == "dev"
 Requires-Dist: markupsafe==3.0.2; extra == "dev"
 Requires-Dist: mccabe==0.7.0; extra == "dev"
 Requires-Dist: mistune==0.8.4; extra == "dev"
 Requires-Dist: moreorless==0.4.0; extra == "dev"
-Requires-Dist: mypy==1.12.0; extra == "dev"
+Requires-Dist: mypy==1.13.0; extra == "dev"
 Requires-Dist: mypy-extensions==1.0.0; extra == "dev"
 Requires-Dist: nodeenv==1.9.1; extra == "dev"
-Requires-Dist: packaging==24.1; extra == "dev"
+Requires-Dist: packaging==24.2; extra == "dev"
 Requires-Dist: pathspec==0.12.1; extra == "dev"
 Requires-Dist: pep8-naming==0.14.1; extra == "dev"
 Requires-Dist: pip-tools==7.4.1; extra == "dev"
@@ -319,9 +319,9 @@ Requires-Dist: pyflakes==3.2.0; extra == "dev"
 Requires-Dist: pygments==2.18.0; extra == "dev"
 Requires-Dist: pyproject-api==1.8.0; extra == "dev"
 Requires-Dist: pyproject-hooks==1.2.0; extra == "dev"
-Requires-Dist: pytest==8.3.3; extra == "dev"
-Requires-Dist: pytest-cov==5.0.0; extra == "dev"
-Requires-Dist: pyupgrade==3.18.0; extra == "dev"
+Requires-Dist: pytest==8.3.4; extra == "dev"
+Requires-Dist: pytest-cov==6.0.0; extra == "dev"
+Requires-Dist: pyupgrade==3.19.0; extra == "dev"
 Requires-Dist: pyyaml==6.0.2; extra == "dev"
 Requires-Dist: requests==2.32.3; extra == "dev"
 Requires-Dist: rich==12.6.0; extra == "dev"
@@ -333,17 +333,17 @@ Requires-Dist: sphinxcontrib-htmlhelp==2.1.0; extra == "dev"
 Requires-Dist: sphinxcontrib-jsmath==1.0.1; extra == "dev"
 Requires-Dist: sphinxcontrib-qthelp==2.0.0; extra == "dev"
 Requires-Dist: sphinxcontrib-serializinghtml==2.0.0; extra == "dev"
-Requires-Dist: tokenize-rt==6.0.0; extra == "dev"
+Requires-Dist: tokenize-rt==6.1.0; extra == "dev"
 Requires-Dist: toml==0.10.2; extra == "dev"
-Requires-Dist: tomli==2.0.2; extra == "dev"
-Requires-Dist: tox==4.23.0; extra == "dev"
+Requires-Dist: tomli==2.2.1; extra == "dev"
+Requires-Dist: tox==4.23.2; extra == "dev"
 Requires-Dist: trailrunner==1.4.0; extra == "dev"
 Requires-Dist: typing-extensions==4.12.2; extra == "dev"
 Requires-Dist: unify==0.5; extra == "dev"
 Requires-Dist: untokenize==0.1.1; extra == "dev"
 Requires-Dist: urllib3==2.2.3; extra == "dev"
-Requires-Dist: virtualenv==20.27.0; extra == "dev"
-Requires-Dist: wheel==0.44.0; extra == "dev"
+Requires-Dist: virtualenv==20.28.0; extra == "dev"
+Requires-Dist: wheel==0.45.1; extra == "dev"
 
 ===============================================
 APRSD - Ham radio APRS-IS Message plugin server
@@ -358,6 +358,37 @@ ____________________
 `APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.
 
 
+Table of Contents
+=================
+
+1. `What is APRSD <#what-is-aprsd>`_
+2. `APRSD Overview Diagram <#aprsd-overview-diagram>`_
+3. `Typical Use Case <#typical-use-case>`_
+4. `Installation <#installation>`_
+5. `Example Usage <#example-usage>`_
+6. `Help <#help>`_
+7. `Commands <#commands>`_
+   - `Configuration <#configuration>`_
+   - `Server <#server>`_
+   - `Current List of Built-in Plugins <#current-list-of-built-in-plugins>`_
+   - `Pypi.org APRSD Installable Plugin Packages <#pypiorg-aprsd-installable-plugin-packages>`_
+   - `🐍 APRSD Installed 3rd Party Plugins <#aprsd-installed-3rd-party-plugins>`_
+   - `Send Message <#send-message>`_
+   - `Send Email (Radio to SMTP Server) <#send-email-radio-to-smtp-server>`_
+   - `Receive Email (IMAP Server to Radio) <#receive-email-imap-server-to-radio>`_
+   - `Location <#location>`_
+   - `Web Admin Interface <#web-admin-interface>`_
+8. `Development <#development>`_
+   - `Building Your Own APRSD Plugins <#building-your-own-aprsd-plugins>`_
+9. `Workflow <#workflow>`_
+10. `Release <#release>`_
+11. `Docker Container <#docker-container>`_
+    - `Building <#building-1>`_
+    - `Official Build <#official-build>`_
+    - `Development Build <#development-build>`_
+    - `Running the Container <#running-the-container>`_
+
+
 What is APRSD
 =============
 APRSD is a python application for interacting with the APRS network and providing
@@ -494,8 +525,7 @@ look for incomming commands to the callsign configured in the config file
 
 
 Current list of built-in plugins
-======================================
-
+--------------------------------
 ::
 
     └─> aprsd list-plugins
@@ -647,18 +677,21 @@ AND... ping, fortune, time.....
 
 Web Admin Interface
 ===================
+APRSD has a web admin interface that allows you to view the status of the running APRSD server instance.
+The web admin interface shows graphs of packet counts, packet types, number of threads running, the latest
+packets sent and received, and the status of each of the plugins that are loaded.  You can also view the logfile
+and view the raw APRSD configuration file.
+
 To start the web admin interface, You have to install gunicorn in your virtualenv that already has aprsd installed.
 
 ::
 
   source <path to APRSD's virtualenv>/bin/activate
-  pip install gunicorn
-  gunicorn --bind 0.0.0.0:8080 "aprsd.wsgi:app"
+  aprsd admin --loglevel INFO
 
 The web admin interface will be running on port 8080 on the local machine.  http://localhost:8080
 
 
-
 Development
 ===========
 
@@ -667,7 +700,7 @@ Development
 * ``make``
 
 Workflow
-========
+--------
 
 While working aprsd, The workflow is as follows:
 
@@ -696,7 +729,7 @@ While working aprsd, The workflow is as follows:
 
 
 Release
-=======
+-------
 
 To do release to pypi:
 
@@ -717,6 +750,29 @@ To do release to pypi:
   ``make upload``
 
 
+Building your own APRSD plugins
+-------------------------------
+
+APRSD plugins are the mechanism by which APRSD can respond to APRS Messages.  The plugins are loaded at server startup
+and can also be loaded at listen startup.  When a packet is received by APRSD, it is passed to each of the plugins
+in the order they were registered in the config file.  The plugins can then decide what to do with the packet.
+When a plugin is called, it is passed a APRSD Packet object.  The plugin can then do something with the packet and
+return a reply message if desired.  If a plugin does not want to reply to the packet, it can just return None.
+When a plugin does return a reply message, APRSD will send the reply message to the appropriate destination.
+
+For example, when a 'ping' message is received, the PingPlugin will return a reply message of 'pong'.  When APRSD
+receives the 'pong' message, it will be sent back to the original caller of the ping message.
+
+APRSD plugins are simply python packages that can be installed from pypi.org.  They are installed into the
+aprsd virtualenv and can be imported by APRSD at runtime.  The plugins are registered in the config file and loaded
+at startup of the aprsd server command or the aprsd listen command.
+
+Overview
+--------
+You can build your own plugins by following the instructions in the `Building your own APRSD plugins`_ section.
+
+Plugins are called by APRSD when packe
+
 Docker Container
 ================
 

{aprsd-3.4.3 → aprsd-3.4.4}/README.rst

@@ -11,6 +11,37 @@ ____________________
 `APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.
 
 
+Table of Contents
+=================
+
+1. `What is APRSD <#what-is-aprsd>`_
+2. `APRSD Overview Diagram <#aprsd-overview-diagram>`_
+3. `Typical Use Case <#typical-use-case>`_
+4. `Installation <#installation>`_
+5. `Example Usage <#example-usage>`_
+6. `Help <#help>`_
+7. `Commands <#commands>`_
+   - `Configuration <#configuration>`_
+   - `Server <#server>`_
+   - `Current List of Built-in Plugins <#current-list-of-built-in-plugins>`_
+   - `Pypi.org APRSD Installable Plugin Packages <#pypiorg-aprsd-installable-plugin-packages>`_
+   - `🐍 APRSD Installed 3rd Party Plugins <#aprsd-installed-3rd-party-plugins>`_
+   - `Send Message <#send-message>`_
+   - `Send Email (Radio to SMTP Server) <#send-email-radio-to-smtp-server>`_
+   - `Receive Email (IMAP Server to Radio) <#receive-email-imap-server-to-radio>`_
+   - `Location <#location>`_
+   - `Web Admin Interface <#web-admin-interface>`_
+8. `Development <#development>`_
+   - `Building Your Own APRSD Plugins <#building-your-own-aprsd-plugins>`_
+9. `Workflow <#workflow>`_
+10. `Release <#release>`_
+11. `Docker Container <#docker-container>`_
+    - `Building <#building-1>`_
+    - `Official Build <#official-build>`_
+    - `Development Build <#development-build>`_
+    - `Running the Container <#running-the-container>`_
+
+
 What is APRSD
 =============
 APRSD is a python application for interacting with the APRS network and providing
@@ -147,8 +178,7 @@ look for incomming commands to the callsign configured in the config file
 
 
 Current list of built-in plugins
-======================================
-
+--------------------------------
 ::
 
     └─> aprsd list-plugins
@@ -300,18 +330,21 @@ AND... ping, fortune, time.....
 
 Web Admin Interface
 ===================
+APRSD has a web admin interface that allows you to view the status of the running APRSD server instance.
+The web admin interface shows graphs of packet counts, packet types, number of threads running, the latest
+packets sent and received, and the status of each of the plugins that are loaded.  You can also view the logfile
+and view the raw APRSD configuration file.
+
 To start the web admin interface, You have to install gunicorn in your virtualenv that already has aprsd installed.
 
 ::
 
   source <path to APRSD's virtualenv>/bin/activate
-  pip install gunicorn
-  gunicorn --bind 0.0.0.0:8080 "aprsd.wsgi:app"
+  aprsd admin --loglevel INFO
 
 The web admin interface will be running on port 8080 on the local machine.  http://localhost:8080
 
 
-
 Development
 ===========
 
@@ -320,7 +353,7 @@ Development
 * ``make``
 
 Workflow
-========
+--------
 
 While working aprsd, The workflow is as follows:
 
@@ -349,7 +382,7 @@ While working aprsd, The workflow is as follows:
 
 
 Release
-=======
+-------
 
 To do release to pypi:
 
@@ -370,6 +403,29 @@ To do release to pypi:
   ``make upload``
 
 
+Building your own APRSD plugins
+-------------------------------
+
+APRSD plugins are the mechanism by which APRSD can respond to APRS Messages.  The plugins are loaded at server startup
+and can also be loaded at listen startup.  When a packet is received by APRSD, it is passed to each of the plugins
+in the order they were registered in the config file.  The plugins can then decide what to do with the packet.
+When a plugin is called, it is passed a APRSD Packet object.  The plugin can then do something with the packet and
+return a reply message if desired.  If a plugin does not want to reply to the packet, it can just return None.
+When a plugin does return a reply message, APRSD will send the reply message to the appropriate destination.
+
+For example, when a 'ping' message is received, the PingPlugin will return a reply message of 'pong'.  When APRSD
+receives the 'pong' message, it will be sent back to the original caller of the ping message.
+
+APRSD plugins are simply python packages that can be installed from pypi.org.  They are installed into the
+aprsd virtualenv and can be imported by APRSD at runtime.  The plugins are registered in the config file and loaded
+at startup of the aprsd server command or the aprsd listen command.
+
+Overview
+--------
+You can build your own plugins by following the instructions in the `Building your own APRSD plugins`_ section.
+
+Plugins are called by APRSD when packe
+
 Docker Container
 ================
 

{aprsd-3.4.3 → aprsd-3.4.4}/aprsd/client/aprsis.py

@@ -23,13 +23,24 @@ class APRSISClient(base.APRSClient):
         max_timeout = {"hours": 0.0, "minutes": 2, "seconds": 0}
         self.max_delta = datetime.timedelta(**max_timeout)
 
-    def stats(self) -> dict:
+    def stats(self, serializable=False) -> dict:
         stats = {}
         if self.is_configured():
+            if self._client:
+                keepalive = self._client.aprsd_keepalive
+                server_string = self._client.server_string
+                if serializable:
+                    keepalive = keepalive.isoformat()
+            else:
+                keepalive = "None"
+                server_string = "None"
             stats = {
-                "server_string": self._client.server_string,
-                "sever_keepalive": self._client.aprsd_keepalive,
+                "connected": self.is_connected,
                 "filter": self.filter,
+                "login_status": self.login_status,
+                "connection_keepalive": keepalive,
+                "server_string": server_string,
+                "transport": self.transport(),
             }
 
         return stats
@@ -99,22 +110,31 @@ class APRSISClient(base.APRSClient):
         self.connected = False
         backoff = 1
         aprs_client = None
+        retries = 3
+        retry_count = 0
         while not self.connected:
+            retry_count += 1
+            if retry_count >= retries:
+                break
             try:
                 LOG.info(f"Creating aprslib client({host}:{port}) and logging in {user}.")
                 aprs_client = aprsis.Aprsdis(user, passwd=password, host=host, port=port)
                 # Force the log to be the same
                 aprs_client.logger = LOG
                 aprs_client.connect()
-                self.connected = True
+                self.connected = self.login_status["success"] = True
+                self.login_status["message"] = aprs_client.server_string
                 backoff = 1
             except LoginError as e:
                 LOG.error(f"Failed to login to APRS-IS Server '{e}'")
-                self.connected = False
+                self.connected = self.login_status["success"] = False
+                self.login_status["message"] = e.message
+                LOG.error(e.message)
                 time.sleep(backoff)
             except Exception as e:
                 LOG.error(f"Unable to connect to APRS-IS server. '{e}' ")
-                self.connected = False
+                self.connected = self.login_status["success"] = False
+                self.login_status["message"] = e.message
                 time.sleep(backoff)
                 # Don't allow the backoff to go to inifinity.
                 if backoff > 5:
@@ -126,7 +146,16 @@ class APRSISClient(base.APRSClient):
         return aprs_client
 
     def consumer(self, callback, blocking=False, immortal=False, raw=False):
-        self._client.consumer(
-            callback, blocking=blocking,
-            immortal=immortal, raw=raw,
-        )
+        if self._client:
+            try:
+                self._client.consumer(
+                    callback, blocking=blocking,
+                    immortal=immortal, raw=raw,
+                )
+            except Exception as e:
+                LOG.error(e)
+                LOG.info(e.__cause__)
+                raise e
+        else:
+            LOG.warning("client is None, might be resetting.")
+            self.connected = False

{aprsd-3.4.3 → aprsd-3.4.4}/aprsd/client/base.py

@@ -19,6 +19,10 @@ class APRSClient:
     _client = None
 
     connected = False
+    login_status = {
+        "success": False,
+        "message": None,
+    }
     filter = None
     lock = threading.Lock()
 
@@ -32,7 +36,23 @@ class APRSClient:
 
     @abc.abstractmethod
     def stats(self) -> dict:
-        pass
+        """Return statistics about the client connection.
+
+        Returns:
+            dict: Statistics about the connection and packet handling
+        """
+
+    @property
+    def is_connected(self):
+        return self.connected
+
+    @property
+    def login_success(self):
+        return self.login_status.get("success", False)
+
+    @property
+    def login_failure(self):
+        return self.login_status["message"]
 
     def set_filter(self, filter):
         self.filter = filter
@@ -46,22 +66,31 @@ class APRSClient:
         return self._client
 
     def _create_client(self):
-        self._client = self.setup_connection()
-        if self.filter:
-            LOG.info("Creating APRS client filter")
-            self._client.set_filter(self.filter)
+        try:
+            self._client = self.setup_connection()
+            if self.filter:
+                LOG.info("Creating APRS client filter")
+                self._client.set_filter(self.filter)
+        except Exception as e:
+            LOG.error(f"Failed to create APRS client: {e}")
+            self._client = None
+            raise
 
     def stop(self):
         if self._client:
             LOG.info("Stopping client connection.")
             self._client.stop()
 
-    def send(self, packet: core.Packet):
-        """Send a packet to the network."""
+    def send(self, packet: core.Packet) -> None:
+        """Send a packet to the network.
+
+        Args:
+            packet: The APRS packet to send
+        """
         self.client.send(packet)
 
     @wrapt.synchronized(lock)
-    def reset(self):
+    def reset(self) -> None:
         """Call this to force a rebuild/reconnect."""
         LOG.info("Resetting client connection.")
         if self._client:
@@ -76,7 +105,11 @@ class APRSClient:
 
     @abc.abstractmethod
     def setup_connection(self):
-        pass
+        """Initialize and return the underlying APRS connection.
+
+        Returns:
+            object: The initialized connection object
+        """
 
     @staticmethod
     @abc.abstractmethod
@@ -90,7 +123,11 @@ class APRSClient:
 
     @abc.abstractmethod
     def decode_packet(self, *args, **kwargs):
-        pass
+        """Decode raw APRS packet data into a Packet object.
+
+        Returns:
+            Packet: Decoded APRS packet
+        """
 
     @abc.abstractmethod
     def consumer(self, callback, blocking=False, immortal=False, raw=False):