aprsd 1.0.0__py3-none-any.whl → 3.4.2__py3-none-any.whl

aprsd-3.4.2.dist-info/METADATA

@@ -0,0 +1,793 @@
+Metadata-Version: 2.1
+Name: aprsd
+Version: 3.4.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.8
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: aprslib==0.7.2
+Requires-Dist: attrs==24.2.0
+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: 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: flask-httpauth==4.8.0
+Requires-Dist: flask-socketio==5.4.1
+Requires-Dist: geographiclib==2.0
+Requires-Dist: geopy==2.4.1
+Requires-Dist: h11==0.14.0
+Requires-Dist: idna==3.10
+Requires-Dist: imapclient==3.0.1
+Requires-Dist: importlib-metadata==8.5.0
+Requires-Dist: itsdangerous==2.2.0
+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: 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: pbr==6.1.0
+Requires-Dist: pluggy==1.5.0
+Requires-Dist: pygments==2.18.0
+Requires-Dist: pyserial==3.5
+Requires-Dist: pyserial-asyncio==0.6
+Requires-Dist: python-engineio==4.10.1
+Requires-Dist: python-socketio==5.11.4
+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: 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: tabulate==0.9.0
+Requires-Dist: thesmuggler==1.0.1
+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: wsproto==1.2.0
+Requires-Dist: zipp==3.20.2
+Provides-Extra: dev
+Requires-Dist: add-trailing-comma==3.1.0; extra == "dev"
+Requires-Dist: alabaster==1.0.0; extra == "dev"
+Requires-Dist: autoflake==1.5.3; extra == "dev"
+Requires-Dist: babel==2.16.0; extra == "dev"
+Requires-Dist: black==24.10.0; extra == "dev"
+Requires-Dist: build==1.2.2.post1; extra == "dev"
+Requires-Dist: cachetools==5.5.0; extra == "dev"
+Requires-Dist: certifi==2024.8.30; extra == "dev"
+Requires-Dist: cfgv==3.4.0; extra == "dev"
+Requires-Dist: chardet==5.2.0; extra == "dev"
+Requires-Dist: charset-normalizer==3.4.0; extra == "dev"
+Requires-Dist: check-manifest==0.50; extra == "dev"
+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: distlib==0.3.9; extra == "dev"
+Requires-Dist: docutils==0.21.2; extra == "dev"
+Requires-Dist: exceptiongroup==1.2.2; extra == "dev"
+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: 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: 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-extensions==1.0.0; extra == "dev"
+Requires-Dist: nodeenv==1.9.1; extra == "dev"
+Requires-Dist: packaging==24.1; 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"
+Requires-Dist: platformdirs==4.3.6; extra == "dev"
+Requires-Dist: pluggy==1.5.0; extra == "dev"
+Requires-Dist: pre-commit==4.0.1; extra == "dev"
+Requires-Dist: pycodestyle==2.12.1; extra == "dev"
+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: pyyaml==6.0.2; extra == "dev"
+Requires-Dist: requests==2.32.3; extra == "dev"
+Requires-Dist: rich==12.6.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: tokenize-rt==6.0.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: 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"
+
+===============================================
+APRSD - Ham radio APRS-IS Message plugin server
+===============================================
+
+KM6LYW and WB4BOR
+____________________
+
+|pypi| |pytest| |versions| |slack| |issues| |commit| |imports| |down|
+
+
+`APRSD <http://github.com/craigerl/aprsd>`_ is a Ham radio `APRS <http://aprs.org>`_ message command gateway built on python.
+
+
+What is APRSD
+=============
+APRSD is a python application for interacting with the APRS network 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
+    * webchat - web based chat program over APRS
+    * send-message - Send a message to a callsign via APRS_IS.
+    * listen - Listen to packets on the APRS-IS Network based on FILTER.
+
+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.
+
+Please `read the docs`_ to learn more!
+
+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.
+      webchat          Web based HAM Radio chat program!
+
+
+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
+    Load config
+    12/07/2021 03:16:17 PM MainThread      INFO     APRSD is up to date                                                                   server.py:51
+    12/07/2021 03:16:17 PM MainThread      INFO     APRSD Started version: 2.5.6                                                          server.py:52
+    12/07/2021 03:16:17 PM MainThread      INFO     Using CONFIG values:                                                                  server.py:55
+    12/07/2021 03:16:17 PM MainThread      INFO     ham.callsign = WB4BOR                                                                 server.py:60
+    12/07/2021 03:16:17 PM MainThread      INFO     aprs.login = WB4BOR-12                                                                server.py:60
+    12/07/2021 03:16:17 PM MainThread      INFO     aprs.password = XXXXXXXXXXXXXXXXXXX                                                   server.py:58
+    12/07/2021 03:16:17 PM MainThread      INFO     aprs.host = noam.aprs2.net                                                            server.py:60
+    12/07/2021 03:16:17 PM MainThread      INFO     aprs.port = 14580                                                                     server.py:60
+    12/07/2021 03:16:17 PM MainThread      INFO     aprs.logfile = /tmp/aprsd.log                                                         server.py:60
+
+
+Current list of built-in 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 │
+    │ EmailPlugin       │ Send and Receive email                                     │ RegexCommand │ aprsd.plugins.email.EmailPlugin         │
+    │ FortunePlugin     │ Give me a fortune                                          │ RegexCommand │ aprsd.plugins.fortune.FortunePlugin     │
+    │ LocationPlugin    │ Where in the world is a CALLSIGN's last GPS beacon?        │ RegexCommand │ aprsd.plugins.location.LocationPlugin   │
+    │ 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           │
+    │ QueryPlugin       │ APRSD Owner command to query messages in the MsgTrack      │ RegexCommand │ aprsd.plugins.query.QueryPlugin         │
+    │ 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-stock-plugin        │ Ham Radio APRSD Plugin for fetching stock quotes                   │  0.1.3  │ Dec 2, 2022  │     No     │
+    │ 📂 aprsd-sentry-plugin       │ Ham radio APRSD plugin that does....                               │  0.1.2  │ Dec 2, 2022  │     No     │
+    │ 📂 aprsd-timeopencage-plugin │ APRSD plugin for fetching time based on GPS location               │  0.1.0  │ Dec 2, 2022  │     No     │
+    │ 📂 aprsd-weewx-plugin        │ HAM Radio APRSD that reports weather from a weewx weather station. │  0.1.4  │ Dec 7, 2021  │    Yes     │
+    │ 📂 aprsd-repeat-plugins      │ APRSD Plugins for the REPEAT service                               │ 1.0.12  │ Dec 2, 2022  │     No     │
+    │ 📂 aprsd-telegram-plugin     │ Ham Radio APRS APRSD plugin for Telegram IM service                │  0.1.3  │ Dec 2, 2022  │     No     │
+    │ 📂 aprsd-twitter-plugin      │ Python APRSD plugin to send tweets                                 │  0.3.0  │ Dec 7, 2021  │     No     │
+    │ 📂 aprsd-slack-plugin        │ Amateur radio APRS daemon which listens for messages and responds  │  1.0.5  │ Dec 18, 2022 │     No     │
+    └──────────────────────────────┴────────────────────────────────────────────────────────────────────┴─────────┴──────────────┴────────────┘
+
+
+                                      🐍 APRSD Installed 3rd party Plugins 🐍
+    ┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+    ┃ Package Name       ┃ Plugin Name     ┃ Version ┃ Type         ┃ Plugin Path                              ┃
+    ┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+    │ aprsd-weewx-plugin │ WeewxMQTTPlugin │   1.0   │ RegexCommand │ aprsd_weewx_plugin.weewx.WeewxMQTTPlugin │
+    └────────────────────┴─────────────────┴─────────┴──────────────┴──────────────────────────────────────────┘
+
+
+
+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.
+
+
+SEND EMAIL (radio to smtp server)
+=================================
+
+::
+
+    Received message______________
+    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :-user@host.com test new shortcuts global, radio to pc{29
+    From        : KM6XXX
+    Message     : -user@host.com test new shortcuts global, radio to pc
+    Msg number  : 29
+
+    Sending Email_________________
+    To          : user@host.com
+    Subject     : KM6XXX
+    Body        : test new shortcuts global, radio to pc
+
+    Sending ack __________________ Tx(3)
+    Raw         : KM6XXX-9>APRS::KM6XXX   :ack29
+    To          : KM6XXX
+    Ack number  : 29
+
+
+RECEIVE EMAIL (imap server to radio)
+====================================
+
+::
+
+    Sending message_______________ 6(Tx3)
+    Raw         : KM6XXX-9>APRS::KM6XXX   :-somebody@gmail.com email from internet to radio{6
+    To          : KM6XXX
+    Message     : -somebody@gmail.com email from internet to radio
+
+    Received message______________
+    Raw         : KM6XXX>APY400,WIDE1-1,qAO,KM6XXX-1::KM6XXX-9 :ack6
+    From        : KM6XXX
+    Message     : ack6
+    Msg number  : 0
+
+
+LOCATION
+========
+
+::
+
+    Received Message _______________
+    Raw         : KM6XXX-6>APRS,TCPIP*,qAC,T2CAEAST::KM6XXX-14:location{2
+    From        : KM6XXX-6
+    Message     : location
+    Msg number  : 2
+    Received Message _______________ Complete
+
+    Sending Message _______________
+    Raw         : KM6XXX-14>APRS::KM6XXX-6 :KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago{2
+    To          : KM6XXX-6
+    Message     : KM6XXX-6: 8 Miles E Auburn CA 0' 0,-120.93584 1873.7h ago
+    Msg number  : 2
+    Sending Message _______________ Complete
+
+    Sending ack _______________
+    Raw         : KM6XXX-14>APRS::KM6XXX-6 :ack2
+    To          : KM6XXX-6
+    Ack         : 2
+    Sending ack _______________ Complete
+
+AND... ping, fortune, time.....
+
+
+Web Admin Interface
+===================
+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"
+
+The web admin interface will be running on port 8080 on the local machine.  http://localhost:8080
+
+
+
+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``
+
+
+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
+
+
+.. badges
+
+.. |pypi| image:: https://badge.fury.io/py/aprsd.svg
+    :target: https://badge.fury.io/py/aprsd
+
+.. |pytest| image:: https://github.com/craigerl/aprsd/workflows/python/badge.svg
+    :target: https://github.com/craigerl/aprsd/actions
+
+.. |versions| image:: https://img.shields.io/pypi/pyversions/aprsd.svg
+    :target: https://pypi.org/pypi/aprsd
+
+.. |slack| image:: https://img.shields.io/badge/slack-@hemna/aprsd-blue.svg?logo=slack
+    :target: https://hemna.slack.com/app_redirect?channel=C01KQSCP5RP
+
+.. |imports| image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
+    :target: https://timothycrosley.github.io/isort/
+
+.. |issues| image:: https://img.shields.io/github/issues/craigerl/aprsd
+
+.. |commit| image:: https://img.shields.io/github/last-commit/craigerl/aprsd
+
+.. |down| image:: https://static.pepy.tech/personalized-badge/aprsd?period=month&units=international_system&left_color=black&right_color=orange&left_text=Downloads
+     :target: https://pepy.tech/project/aprsd
+
+.. links
+.. _read the docs:
+ https://aprsd.readthedocs.io