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

aprsd-4.0.2.dist-info/METADATA

@@ -0,0 +1,748 @@
+Metadata-Version: 2.2
+Name: aprsd
+Version: 4.0.2
+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>
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+Project-URL: Homepage, https://github.com/craigerl/aprsd
+Project-URL: Bug Reports, https://github.com/craigerl/aprsd/issues
+Project-URL: Source, https://github.com/craigerl/aprsd
+Keywords: aprs,aprs-is,aprsd,aprsd-server,aprsd-client,aprsd-socket,aprsd-socket-server,aprsd-socket-client
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Topic :: Communications :: Ham Radio
+Classifier: Topic :: Internet
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: aprslib==0.7.2
+Requires-Dist: attrs==24.3.0
+Requires-Dist: ax253==0.1.5.post1
+Requires-Dist: bitarray==3.0.0
+Requires-Dist: certifi==2024.12.14
+Requires-Dist: charset-normalizer==3.4.1
+Requires-Dist: click==8.1.8
+Requires-Dist: commonmark==0.9.1
+Requires-Dist: dataclasses-json==0.6.7
+Requires-Dist: debtcollector==3.0.0
+Requires-Dist: haversine==2.9.0
+Requires-Dist: idna==3.10
+Requires-Dist: importlib-metadata==8.6.1
+Requires-Dist: kiss3==8.0.0
+Requires-Dist: loguru==0.7.3
+Requires-Dist: marshmallow==3.26.0
+Requires-Dist: mypy-extensions==1.0.0
+Requires-Dist: netaddr==1.3.0
+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.19.1
+Requires-Dist: pyserial==3.5
+Requires-Dist: pyserial-asyncio==0.6
+Requires-Dist: pytz==2024.2
+Requires-Dist: pyyaml==6.0.2
+Requires-Dist: requests==2.32.3
+Requires-Dist: rfc3986==2.0.0
+Requires-Dist: rich==12.6.0
+Requires-Dist: rush==2021.4.0
+Requires-Dist: stevedore==5.4.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.3.0
+Requires-Dist: wrapt==1.17.2
+Requires-Dist: zipp==3.21.0
+Provides-Extra: dev
+Requires-Dist: alabaster==1.0.0; extra == "dev"
+Requires-Dist: babel==2.16.0; extra == "dev"
+Requires-Dist: build==1.2.2.post1; extra == "dev"
+Requires-Dist: cachetools==5.5.1; extra == "dev"
+Requires-Dist: certifi==2024.12.14; extra == "dev"
+Requires-Dist: cfgv==3.4.0; extra == "dev"
+Requires-Dist: chardet==5.2.0; extra == "dev"
+Requires-Dist: charset-normalizer==3.4.1; extra == "dev"
+Requires-Dist: click==8.1.8; extra == "dev"
+Requires-Dist: colorama==0.4.6; extra == "dev"
+Requires-Dist: distlib==0.3.9; extra == "dev"
+Requires-Dist: docutils==0.21.2; extra == "dev"
+Requires-Dist: filelock==3.17.0; extra == "dev"
+Requires-Dist: identify==2.6.6; extra == "dev"
+Requires-Dist: idna==3.10; extra == "dev"
+Requires-Dist: imagesize==1.4.1; extra == "dev"
+Requires-Dist: jinja2==3.1.5; extra == "dev"
+Requires-Dist: m2r==0.3.1; extra == "dev"
+Requires-Dist: markupsafe==3.0.2; extra == "dev"
+Requires-Dist: mistune==0.8.4; extra == "dev"
+Requires-Dist: nodeenv==1.9.1; extra == "dev"
+Requires-Dist: packaging==24.2; extra == "dev"
+Requires-Dist: pip==24.3.1; extra == "dev"
+Requires-Dist: pip-tools==7.4.1; extra == "dev"
+Requires-Dist: platformdirs==4.3.6; extra == "dev"
+Requires-Dist: pluggy==1.5.0; extra == "dev"
+Requires-Dist: pre-commit==4.1.0; extra == "dev"
+Requires-Dist: pygments==2.19.1; extra == "dev"
+Requires-Dist: pyproject-api==1.9.0; extra == "dev"
+Requires-Dist: pyproject-hooks==1.2.0; extra == "dev"
+Requires-Dist: pyyaml==6.0.2; extra == "dev"
+Requires-Dist: requests==2.32.3; extra == "dev"
+Requires-Dist: setuptools==75.8.0; extra == "dev"
+Requires-Dist: snowballstemmer==2.2.0; extra == "dev"
+Requires-Dist: sphinx==8.1.3; extra == "dev"
+Requires-Dist: sphinxcontrib-applehelp==2.0.0; extra == "dev"
+Requires-Dist: sphinxcontrib-devhelp==2.0.0; extra == "dev"
+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: tomli==2.2.1; extra == "dev"
+Requires-Dist: tox==4.24.1; extra == "dev"
+Requires-Dist: typing-extensions==4.12.2; extra == "dev"
+Requires-Dist: urllib3==2.3.0; extra == "dev"
+Requires-Dist: virtualenv==20.29.1; extra == "dev"
+Requires-Dist: wheel==0.45.1; extra == "dev"
+
+# APRSD - Ham radio APRS-IS Message platform software
+
+## KM6LYW and WB4BOR
+
+[![pypi](https://badge.fury.io/py/aprsd.svg)](https://badge.fury.io/py/aprsd)
+[![versions](https://img.shields.io/pypi/pyversions/aprsd.svg)](https://pypi.org/pypi/aprsd)
+[![slack](https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack)](https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP)
+![issues](https://img.shields.io/github/issues/craigerl/aprsd)
+![commit](https://img.shields.io/github/last-commit/craigerl/aprsd)
+[![imports](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://timothycrosley.github.io/isort/)
+[![down](https://static.pepy.tech/personalized-badge/aprsd?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads)](https://pepy.tech/project/aprsd)
+
+[APRSD](http://github.com/craigerl/aprsd) is a Ham radio
+[APRS](http://aprs.org) message platform built with python.
+
+![image](./aprsd_logo.png)
+
+# Table of Contents
+
+1. [APRSD - Ham radio APRS-IS Message platform software](#aprsd---ham-radio-aprs-is-message-platform-software)
+2. [What is APRSD](#what-is-aprsd)
+3. [APRSD Plugins/Extensions](#aprsd-pluginsextensions)
+4. [List of existing plugins - APRS Message processing/responders](#list-of-existing-plugins---aprs-message-processingresponders)
+5. [List of existing extensions - Add new capabilities to APRSD](#list-of-existing-extensions---add-new-capabilities-to-aprsd)
+6. [APRSD Overview Diagram](#aprsd-overview-diagram)
+7. [Typical use case](#typical-use-case)
+8. [Installation](#installation)
+9. [Example usage](#example-usage)
+10. [Help](#help)
+11. [Commands](#commands)
+12. [Configuration](#configuration)
+13. [server](#server)
+14. [Current list plugins](#current-list-plugins)
+15. [Current list extensions](#current-list-extensions)
+16. [send-message](#send-message)
+17. [Development](#development)
+18. [Release](#release)
+19. [Building your own APRSD plugins](#building-your-own-aprsd-plugins)
+20. [Overview](#overview)
+21. [Docker Container](#docker-container)
+22. [Building](#building)
+23. [Official Build](#official-build)
+24. [Development Build](#development-build)
+25. [Running the container](#running-the-container)
+26. [Activity](#activity)
+27. [Star History](#star-history)
+
+---
+
+> [!WARNING]
+> Legal operation of this software requires an amateur radio license and a valid call sign.
+
+> [!NOTE]
+> Star this repo to follow our progress! This code is under active development, and contributions are both welcomed and appreciated. See [CONTRIBUTING.md](<https://github.com/craigerl/aprsd/blob/master/CONTRIBUTING.md>) for details.
+
+### What is APRSD
+
+APRSD is a python application for interacting with the APRS network and Ham radios with KISS interfaces and
+providing APRS services for HAM radio operators.
+
+APRSD currently has 4 main commands to use.
+
+ -  server - Connect to APRS and listen/respond to APRS messages
+ -  send-message - Send a message to a callsign via APRS_IS.
+ -  listen - Listen to packets on the APRS-IS Network based on FILTER.
+ -  check-version - check the version of aprsd
+ -  sample-config - generate a sample config file
+ -  dev - helpful for testing new aprsd plugins under development
+ -  dump-stats - output the stats of a running aprsd server command
+ -  list-plugins - list the built in plugins, available plugins on pypi.org and installed plugins
+ -  list-extensions - list the available extensions on pypi.org and installed extensions
+
+Each of those commands can connect to the APRS-IS network if internet
+connectivity is available. If internet is not available, then APRS can
+be configured to talk to a TCP KISS TNC for radio connectivity directly.
+
+Please [read the docs](https://aprsd.readthedocs.io) to learn more!
+
+
+### APRSD Plugins/Extensions
+
+APRSD Has the ability to add plugins and extensions.  Plugins add new message filters that can look for specific messages and respond.  For example, the aprsd-email-plugin adds the ability to send/recieve email to/from an APRS callsign.  Extensions add new unique capabilities to APRSD itself.  For example the aprsd-admin-extension adds a web interface command that shows the running status of the aprsd server command.  aprsd-webchat-extension is a new web based APRS 'chat' command.
+
+You can see the [available plugins/extensions on pypi here:](https://pypi.org/search/?q=aprsd) [https://pypi.org/search/?q=aprsd](https://pypi.org/search/?q=aprsd)
+
+> [!NOTE]
+> aprsd admin and webchat commands have been extracted into separate extensions.
+ * [See admin extension here](https://github.com/hemna/aprsd-admin-extension) <div id="admin logo" align="left"><img src="https://raw.githubusercontent.com/hemna/aprsd-admin-extension/refs/heads/master/screenshot.png" alt="Web Admin" width="340"/></div>
+
+ * [See webchat extension here](https://github.com/hemna/aprsd-webchat-extension) <div id="webchat logo" align="left"><img src="https://raw.githubusercontent.com/hemna/aprsd-webchat-extension/master/screenshot.png" alt="Webchat" width="340"/></div>
+
+
+### List of existing plugins - APRS Message processing/responders
+
+ - [aprsd-email-plugin](https://github.com/hemna/aprsd-email-plugin) - send/receive email!
+ - [aprsd-location-plugin](https://github.com/hemna/aprsd-location-plugin) - get latest GPS location.
+ - [aprsd-locationdata-plugin](https://github.com/hemna/aprsd-locationdata-plugin) - get latest GPS location
+ - [aprsd-digipi-plugin](https://github.com/hemna/aprsd-digipi-plugin) - Look for digipi beacon packets
+ - [aprsd-w3w-plugin](https://github.com/hemna/aprsd-w3w-plugin) - get your w3w coordinates
+ - [aprsd-mqtt-plugin](https://github.com/hemna/aprsd-mqtt-plugin) - send aprs packets to an MQTT topic
+ - [aprsd-telegram-plugin](https://github.com/hemna/aprsd-telegram-plugin) - send/receive messages to telegram
+ - [aprsd-borat-plugin](https://github.com/hemna/aprsd-borat-plugin) - get Borat quotes
+ - [aprsd-wxnow-plugin](https://github.com/hemna/aprsd-wxnow-plugin) - get closest N weather station reports
+ - [aprsd-weewx-plugin](https://github.com/hemna/aprsd-weewx-plugin) - get weather from your weewx weather station
+ - [aprsd-slack-plugin](https://github.com/hemna/aprsd-slack-plugin) - send/receive messages to a slack channel
+ - [aprsd-sentry-plugin](https://github.com/hemna/aprsd-sentry-plugin) -
+ - [aprsd-repeat-plugins](https://github.com/hemna/aprsd-repeat-plugins) - plugins for the REPEAT service. Get nearest Ham radio repeaters!
+ - [aprsd-twitter-plugin](https://github.com/hemna/aprsd-twitter-plugin) - make tweets from your Ham Radio!
+ - [aprsd-timeopencage-plugin](https://github.com/hemna/aprsd-timeopencage-plugin) - Get local time for a callsign
+ - [aprsd-stock-plugin](https://github.com/hemna/aprsd-stock-plugin) - get stock quotes from your Ham radio
+
+### List of existing extensions - Add new capabilities to APRSD
+
+ - [aprsd-admin-extension](https://github.com/hemna/aprsd-admin-extension) - Web Administration page for APRSD
+ - [aprsd-webchat-extension](https://github.com/hemna/aprsd-webchat-extension) - Web page for APRS Messaging
+ - [aprsd-irc-extension](https://github.com/hemna/aprsd-irc-extension) - an IRC like server command for APRS
+
+### APRSD Overview Diagram
+
+![image](https://raw.githubusercontent.com/craigerl/aprsd/master/docs/_static/aprsd_overview.svg?sanitize=true)
+
+### Typical use case
+
+APRSD\'s typical use case is that of providing an APRS wide service to
+all HAM radio operators. For example the callsign \'REPEAT\' on the APRS
+network is actually an instance of APRSD that can provide a list of HAM
+repeaters in the area of the callsign that sent the message.
+
+Ham radio operator using an APRS enabled HAM radio sends a message to
+check the weather. An APRS message is sent, and then picked up by APRSD.
+The APRS packet is decoded, and the message is sent through the list of
+plugins for processing. For example, the WeatherPlugin picks up the
+message, fetches the weather for the area around the user who sent the
+request, and then responds with the weather conditions in that area.
+Also includes a watch list of HAM callsigns to look out for. The watch
+list can notify you when a HAM callsign in the list is seen and now
+available to message on the APRS network.
+
+### Installation
+
+To install `aprsd`, use Pip:
+
+`pip install aprsd`
+
+### Example usage
+
+`aprsd -h`
+
+### Help
+
+:
+
+    └─> aprsd -h
+    Usage: aprsd [OPTIONS] COMMAND [ARGS]...
+
+    Options:
+      --version   Show the version and exit.
+      -h, --help  Show this message and exit.
+
+    Commands:
+      check-version    Check this version against the latest in pypi.org.
+      completion       Show the shell completion code
+      dev              Development type subcommands
+      fetch-stats      Fetch stats from a APRSD admin web interface.
+      healthcheck      Check the health of the running aprsd server.
+      list-extensions  List the built in plugins available to APRSD.
+      list-plugins     List the built in plugins available to APRSD.
+      listen           Listen to packets on the APRS-IS Network based on FILTER.
+      sample-config    Generate a sample Config file from aprsd and all...
+      send-message     Send a message to a callsign via APRS_IS.
+      server           Start the aprsd server gateway process.
+      version          Show the APRSD version.
+
+### Commands
+
+### Configuration
+
+This command outputs a sample config yml formatted block that you can
+edit and use to pass in to `aprsd` with `-c`. By default aprsd looks in
+`~/.config/aprsd/aprsd.yml`
+
+`aprsd sample-config`
+
+    └─> aprsd sample-config
+    ...
+
+### server
+
+This is the main server command that will listen to APRS-IS servers and
+look for incomming commands to the callsign configured in the config
+file
+
+    └─[$] > aprsd server --help
+        Usage: aprsd server [OPTIONS]
+
+          Start the aprsd server gateway process.
+
+        Options:
+          --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
+                                          The log level to use for aprsd.log
+                                          [default: INFO]
+          -c, --config TEXT               The aprsd config file to use for options.
+                                          [default:
+                                          /Users/i530566/.config/aprsd/aprsd.yml]
+          --quiet                         Don't log to stdout
+          -f, --flush                     Flush out all old aged messages on disk.
+                                          [default: False]
+          -h, --help                      Show this message and exit.
+
+    └─> aprsd server
+    Registering LogMonitorThread
+    2025-01-06 16:27:12.398 | MainThread         | INFO     | APRSD is up to date | aprsd.cmds.server:server:82
+    2025-01-06 16:27:12.398 | MainThread         | INFO     | APRSD Started version: 3.5.1.dev0+g72d068c.d20250102 | aprsd.cmds.server:server:83
+    2025-01-06 16:27:12.398 | MainThread         | INFO     | Creating client connection | aprsd.cmds.server:server:101
+    2025-01-06 16:27:12.398 | MainThread         | INFO     | Creating aprslib client(noam.aprs2.net:14580) and logging in WB4BOR-1. | aprsd.client.aprsis:setup_connection:136
+    2025-01-06 16:27:12.398 | MainThread         | INFO     | Attempting connection to noam.aprs2.net:14580 | aprslib.inet:_connect:226
+    2025-01-06 16:27:12.473 | MainThread         | INFO     | Connected to ('44.135.208.225', 14580) | aprslib.inet:_connect:233
+    2025-01-06 16:27:12.617 | MainThread         | INFO     | Login successful | aprsd.client.drivers.aprsis:_send_login:154
+    2025-01-06 16:27:12.618 | MainThread         | INFO     | Connected to T2BC | aprsd.client.drivers.aprsis:_send_login:156
+    2025-01-06 16:27:12.618 | MainThread         | INFO     | <aprsd.client.aprsis.APRSISClient object at 0x103a36480> | aprsd.cmds.server:server:103
+    2025-01-06 16:27:12.618 | MainThread         | INFO     | Loading Plugin Manager and registering plugins | aprsd.cmds.server:server:117
+    2025-01-06 16:27:12.619 | MainThread         | INFO     | Loading APRSD Plugins | aprsd.plugin:setup_plugins:492
+
+
+#### Current list plugins
+
+    └─> aprsd list-plugins
+                                                        🐍 APRSD Built-in Plugins 🐍
+    ┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+    ┃ Plugin Name       ┃ Info                                                       ┃ Type         ┃ Plugin Path                             ┃
+    ┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+    │ AVWXWeatherPlugin │ AVWX weather of GPS Beacon location                        │ RegexCommand │ aprsd.plugins.weather.AVWXWeatherPlugin │
+    │ FortunePlugin     │ Give me a fortune                                          │ RegexCommand │ aprsd.plugins.fortune.FortunePlugin     │
+    │ NotifySeenPlugin  │ Notify me when a CALLSIGN is recently seen on APRS-IS      │ WatchList    │ aprsd.plugins.notify.NotifySeenPlugin   │
+    │ OWMWeatherPlugin  │ OpenWeatherMap weather of GPS Beacon location              │ RegexCommand │ aprsd.plugins.weather.OWMWeatherPlugin  │
+    │ PingPlugin        │ reply with a Pong!                                         │ RegexCommand │ aprsd.plugins.ping.PingPlugin           │
+    │ TimeOWMPlugin     │ Current time of GPS beacon's timezone. Uses OpenWeatherMap │ RegexCommand │ aprsd.plugins.time.TimeOWMPlugin        │
+    │ TimePlugin        │ What is the current local time.                            │ RegexCommand │ aprsd.plugins.time.TimePlugin           │
+    │ USMetarPlugin     │ USA only METAR of GPS Beacon location                      │ RegexCommand │ aprsd.plugins.weather.USMetarPlugin     │
+    │ USWeatherPlugin   │ Provide USA only weather of GPS Beacon location            │ RegexCommand │ aprsd.plugins.weather.USWeatherPlugin   │
+    │ VersionPlugin     │ What is the APRSD Version                                  │ RegexCommand │ aprsd.plugins.version.VersionPlugin     │
+    └───────────────────┴────────────────────────────────────────────────────────────┴──────────────┴─────────────────────────────────────────┘
+
+
+                                                    Pypi.org APRSD Installable Plugin Packages
+
+                                                    Install any of the following plugins with
+                                                        'pip install <Plugin Package Name>'
+    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
+    ┃ Plugin Package Name          ┃ Description                                                  ┃  Version   ┃      Released       ┃ Installed? ┃
+    ┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
+    │ 📂 aprsd-assistant-plugin    │ APRSd plugin for hosting the APRS Assistant chatbot          │   0.0.3    │ 2024-10-20T02:59:39 │     No     │
+    │                              │ (aprs-assistant)                                             │            │                     │            │
+    │ 📂 aprsd-borat-plugin        │ Borat quotes for aprsd plugin                                │ 0.1.1.dev1 │ 2024-01-19T16:04:38 │     No     │
+    │ 📂 aprsd-locationdata-plugin │ Fetch location information from a callsign                   │   0.3.0    │ 2024-02-06T17:20:43 │     No     │
+    │ 📂 aprsd-mqtt-plugin         │ APRSD MQTT Plugin sends APRS packets to mqtt queue           │   0.2.0    │ 2023-04-17T16:01:50 │     No     │
+    │ 📂 aprsd-repeat-plugins      │ APRSD Plugins for the REPEAT service                         │   1.2.0    │ 2023-01-10T17:15:36 │     No     │
+    │ 📂 aprsd-sentry-plugin       │ Ham radio APRSD plugin that does....                         │   0.1.2    │ 2022-12-02T19:07:33 │     No     │
+    │ 📂 aprsd-slack-plugin        │ Amateur radio APRS daemon which listens for messages and     │   1.2.0    │ 2023-01-10T19:21:33 │     No     │
+    │                              │ responds                                                     │            │                     │            │
+    │ 📂 aprsd-stock-plugin        │ Ham Radio APRSD Plugin for fetching stock quotes             │   0.1.3    │ 2022-12-02T18:56:19 │    Yes     │
+    │ 📂 aprsd-telegram-plugin     │ Ham Radio APRS APRSD plugin for Telegram IM service          │   0.1.3    │ 2022-12-02T19:07:15 │     No     │
+    │ 📂 aprsd-timeopencage-plugin │ APRSD plugin for fetching time based on GPS location         │   0.2.0    │ 2023-01-10T17:07:11 │     No     │
+    │ 📂 aprsd-twitter-plugin      │ Python APRSD plugin to send tweets                           │   0.5.0    │ 2023-01-10T16:51:47 │     No     │
+    │ 📂 aprsd-weewx-plugin        │ HAM Radio APRSD that reports weather from a weewx weather    │   0.3.2    │ 2023-04-20T20:16:19 │     No     │
+    │                              │ station.                                                     │            │                     │            │
+    │ 📂 aprsd-wxnow-plugin        │ APRSD Plugin for getting the closest wx reports to last      │   0.2.0    │ 2023-10-08T01:27:29 │    Yes     │
+    │                              │ beacon                                                       │            │                     │            │
+    └──────────────────────────────┴──────────────────────────────────────────────────────────────┴────────────┴─────────────────────┴────────────┘
+
+
+                                    🐍 APRSD Installed 3rd party Plugins 🐍
+    ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+    ┃ Package Name       ┃ Plugin Name     ┃ Version ┃ Type         ┃ Plugin Path                              ┃
+    ┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+    │ aprsd-stock-plugin │ YahooStockQuote │  0.1.3  │ RegexCommand │ aprsd_stock_plugin.stock.YahooStockQuote │
+    │ aprsd-wxnow-plugin │ WXNowPlugin     │  0.2.0  │ RegexCommand │ aprsd_wxnow_plugin.conf.opts.WXNowPlugin │
+    └────────────────────┴─────────────────┴─────────┴──────────────┴──────────────────────────────────────────┘
+
+#### Current list extensions
+    └─> aprsd list-extensions
+
+
+                                                    Pypi.org APRSD Installable Extension Packages
+
+                                                Install any of the following extensions by running
+                                                        'pip install <Plugin Package Name>'
+    ┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓
+    ┃ Extension Package Name   ┃ Description                                                         ┃ Version ┃      Released       ┃ Installed? ┃
+    ┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩
+    │ 📂 aprsd-admin-extension │ Administration extension for the Ham radio APRSD Server             │  1.0.1  │ 2025-01-06T21:57:24 │    Yes     │
+    │ 📂 aprsd-irc-extension   │ An Extension to Ham radio APRSD Daemon to act like an irc server    │  0.0.5  │ 2024-04-09T11:28:47 │     No     │
+    │                          │ for APRS                                                            │         │                     │            │
+    └──────────────────────────┴─────────────────────────────────────────────────────────────────────┴─────────┴─────────────────────┴────────────┘
+
+### send-message
+
+This command is typically used for development to send another aprsd
+instance test messages
+
+    └─[$] > aprsd send-message -h
+    Usage: aprsd send-message [OPTIONS] TOCALLSIGN COMMAND...
+
+      Send a message to a callsign via APRS_IS.
+
+    Options:
+      --loglevel [CRITICAL|ERROR|WARNING|INFO|DEBUG]
+                                      The log level to use for aprsd.log
+                                      [default: INFO]
+      -c, --config TEXT               The aprsd config file to use for options.
+                                      [default:
+                                      /Users/i530566/.config/aprsd/aprsd.yml]
+      --quiet                         Don't log to stdout
+      --aprs-login TEXT               What callsign to send the message from.
+                                      [env var: APRS_LOGIN]
+      --aprs-password TEXT            the APRS-IS password for APRS_LOGIN  [env
+                                      var: APRS_PASSWORD]
+      -n, --no-ack                    Don't wait for an ack, just sent it to APRS-
+                                      IS and bail.  [default: False]
+      -w, --wait-response             Wait for a response to the message?
+                                      [default: False]
+      --raw TEXT                      Send a raw message.  Implies --no-ack
+      -h, --help                      Show this message and exit.
+
+### Development
+
+-   `git clone git@github.com:craigerl/aprsd.git`
+-   `cd aprsd`
+-   `make`
+
+#### Workflow
+
+While working aprsd, The workflow is as follows:
+
+-   Checkout a new branch to work on by running
+
+    `git checkout -b mybranch`
+
+-   Make your changes to the code
+
+-   Run Tox with the following options:
+
+    -   `tox -epep8`
+    -   `tox -efmt`
+    -   `tox -p`
+
+-   Commit your changes. This will run the pre-commit hooks which does
+    checks too
+
+    `git commit`
+
+-   Once you are done with all of your commits, then push up the branch
+    to github with:
+
+    `git push -u origin mybranch`
+
+-   Create a pull request from your branch so github tests can run and
+    we can do a code review.
+
+#### Release
+
+To do release to pypi:
+
+-   Tag release with:
+
+    `git tag -v1.XX -m "New release"`
+
+-   Push release tag:
+
+    `git push origin master --tags`
+
+-   Do a test build and verify build is valid by running:
+
+    `make build`
+
+-   Once twine is happy, upload 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](#building-your-own-aprsd-plugins)
+section.
+
+Plugins are called by APRSD when packe
+
+### Docker Container
+
+### Building
+
+There are 2 versions of the container Dockerfile that can be used. The
+main Dockerfile, which is for building the official release container
+based off of the pip install version of aprsd and the Dockerfile-dev,
+which is used for building a container based off of a git branch of the
+repo.
+
+### Official Build
+
+`docker build -t hemna6969/aprsd:latest .`
+
+### Development Build
+
+`docker build -t hemna6969/aprsd:latest -f Dockerfile-dev .`
+
+### Running the container
+
+There is a `docker-compose.yml` file in the `docker/` directory that can
+be used to run your container. To provide the container an `aprsd.conf`
+configuration file, change your `docker-compose.yml` as shown below:
+
+    volumes:
+        - $HOME/.config/aprsd:/config
+
+To install plugins at container start time, pass in a list of
+comma-separated list of plugins on PyPI using the `APRSD_PLUGINS`
+environment variable in the `docker-compose.yml` file. Note that version
+constraints may also be provided. For example:
+
+    environment:
+        - APRSD_PLUGINS=aprsd-slack-plugin>=1.0.2,aprsd-twitter-plugin
+
+
+### Activity
+
+![Alt](https://repobeats.axiom.co/api/embed/8b96657861770a15f0b851a5eebafb34d0e0b3d3.svg "Repobeats analytics image")
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=craigerl/aprsd&type=Date)](https://star-history.com/#craigerl/aprsd&Date)