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

aprsd/conf/common.py

@@ -2,30 +2,20 @@ from pathlib import Path
 
 from oslo_config import cfg
 
-
 home = str(Path.home())
 DEFAULT_CONFIG_DIR = f"{home}/.config/aprsd/"
 APRSD_DEFAULT_MAGIC_WORD = "CHANGEME!!!"
 
-admin_group = cfg.OptGroup(
-    name="admin",
-    title="Admin web interface settings",
-)
 watch_list_group = cfg.OptGroup(
     name="watch_list",
     title="Watch List settings",
 )
-webchat_group = cfg.OptGroup(
-    name="webchat",
-    title="Settings specific to the webchat command",
-)
 
 registry_group = cfg.OptGroup(
     name="aprs_registry",
     title="APRS Registry settings",
 )
 
-
 aprsd_opts = [
     cfg.StrOpt(
         "callsign",
@@ -56,15 +46,15 @@ aprsd_opts = [
         "ack_rate_limit_period",
         default=1,
         help="The wait period in seconds per Ack packet being sent."
-             "1 means 1 ack packet per second allowed."
-             "2 means 1 pack packet every 2 seconds allowed",
+        "1 means 1 ack packet per second allowed."
+        "2 means 1 pack packet every 2 seconds allowed",
     ),
     cfg.IntOpt(
         "msg_rate_limit_period",
         default=2,
         help="Wait period in seconds per non AckPacket being sent."
-             "2 means 1 packet every 2 seconds allowed."
-             "5 means 1 pack packet every 5 seconds allowed",
+        "2 means 1 packet every 2 seconds allowed."
+        "5 means 1 pack packet every 5 seconds allowed",
     ),
     cfg.IntOpt(
         "packet_dupe_timeout",
@@ -75,7 +65,7 @@ aprsd_opts = [
         "enable_beacon",
         default=False,
         help="Enable sending of a GPS Beacon packet to locate this service. "
-             "Requires latitude and longitude to be set.",
+        "Requires latitude and longitude to be set.",
     ),
     cfg.IntOpt(
         "beacon_interval",
@@ -102,8 +92,8 @@ aprsd_opts = [
         choices=["compact", "multiline", "both"],
         default="compact",
         help="When logging packets 'compact' will use a single line formatted for each packet."
-             "'multiline' will use multiple lines for each packet and is the traditional format."
-             "both will log both compact and multiline.",
+        "'multiline' will use multiple lines for each packet and is the traditional format."
+        "both will log both compact and multiline.",
     ),
     cfg.IntOpt(
         "default_packet_send_count",
@@ -129,7 +119,7 @@ aprsd_opts = [
         "enable_seen_list",
         default=True,
         help="Enable the Callsign seen list tracking feature.  This allows aprsd to keep track of "
-             "callsigns that have been seen and when they were last seen.",
+        "callsigns that have been seen and when they were last seen.",
     ),
     cfg.BoolOpt(
         "enable_packet_logging",
@@ -145,7 +135,7 @@ aprsd_opts = [
         "enable_sending_ack_packets",
         default=True,
         help="Set this to False, to disable sending of ack packets. This will entirely stop"
-             "APRSD from sending ack packets.",
+        "APRSD from sending ack packets.",
     ),
 ]
 
@@ -154,8 +144,8 @@ watch_list_opts = [
         "enabled",
         default=False,
         help="Enable the watch list feature.  Still have to enable "
-             "the correct plugin.  Built-in plugin to use is "
-             "aprsd.plugins.notify.NotifyPlugin",
+        "the correct plugin.  Built-in plugin to use is "
+        "aprsd.plugins.notify.NotifyPlugin",
     ),
     cfg.ListOpt(
         "callsigns",
@@ -174,36 +164,7 @@ watch_list_opts = [
         "alert_time_seconds",
         default=3600,
         help="Time to wait before alert is sent on new message for "
-             "users in callsigns.",
-    ),
-]
-
-admin_opts = [
-    cfg.BoolOpt(
-        "web_enabled",
-        default=False,
-        help="Enable the Admin Web Interface",
-    ),
-    cfg.StrOpt(
-        "web_ip",
-        default="0.0.0.0",
-        help="The ip address to listen on",
-    ),
-    cfg.PortOpt(
-        "web_port",
-        default=8001,
-        help="The port to listen on",
-    ),
-    cfg.StrOpt(
-        "user",
-        default="admin",
-        help="The admin user for the admin web interface",
-    ),
-    cfg.StrOpt(
-        "password",
-        default="password",
-        secret=True,
-        help="Admin interface password",
+        "users in callsigns.",
     ),
 ]
 
@@ -212,7 +173,6 @@ enabled_plugins_opts = [
     cfg.ListOpt(
         "enabled_plugins",
         default=[
-            "aprsd.plugins.email.EmailPlugin",
             "aprsd.plugins.fortune.FortunePlugin",
             "aprsd.plugins.location.LocationPlugin",
             "aprsd.plugins.ping.PingPlugin",
@@ -222,36 +182,8 @@ enabled_plugins_opts = [
             "aprsd.plugins.notify.NotifySeenPlugin",
         ],
         help="Comma separated list of enabled plugins for APRSD."
-             "To enable installed external plugins add them here."
-             "The full python path to the class name must be used",
-    ),
-]
-
-webchat_opts = [
-    cfg.StrOpt(
-        "web_ip",
-        default="0.0.0.0",
-        help="The ip address to listen on",
-    ),
-    cfg.PortOpt(
-        "web_port",
-        default=8001,
-        help="The port to listen on",
-    ),
-    cfg.StrOpt(
-        "latitude",
-        default=None,
-        help="Latitude for the GPS Beacon button.  If not set, the button will not be enabled.",
-    ),
-    cfg.StrOpt(
-        "longitude",
-        default=None,
-        help="Longitude for the GPS Beacon button.  If not set, the button will not be enabled.",
-    ),
-    cfg.BoolOpt(
-        "disable_url_request_logging",
-        default=False,
-        help="Disable the logging of url requests in the webchat command.",
+        "To enable installed external plugins add them here."
+        "The full python path to the class name must be used",
     ),
 ]
 
@@ -260,16 +192,16 @@ registry_opts = [
         "enabled",
         default=False,
         help="Enable sending aprs registry information.  This will let the "
-             "APRS registry know about your service and it's uptime.  "
-             "No personal information is sent, just the callsign, uptime and description. "
-             "The service callsign is the callsign set in [DEFAULT] section.",
+        "APRS registry know about your service and it's uptime.  "
+        "No personal information is sent, just the callsign, uptime and description. "
+        "The service callsign is the callsign set in [DEFAULT] section.",
     ),
     cfg.StrOpt(
         "description",
         default=None,
         help="Description of the service to send to the APRS registry. "
-             "This is what will show up in the APRS registry."
-             "If not set, the description will be the same as the callsign.",
+        "This is what will show up in the APRS registry."
+        "If not set, the description will be the same as the callsign.",
     ),
     cfg.StrOpt(
         "registry_url",
@@ -292,12 +224,8 @@ registry_opts = [
 def register_opts(config):
     config.register_opts(aprsd_opts)
     config.register_opts(enabled_plugins_opts)
-    config.register_group(admin_group)
-    config.register_opts(admin_opts, group=admin_group)
     config.register_group(watch_list_group)
     config.register_opts(watch_list_opts, group=watch_list_group)
-    config.register_group(webchat_group)
-    config.register_opts(webchat_opts, group=webchat_group)
     config.register_group(registry_group)
     config.register_opts(registry_opts, group=registry_group)
 
@@ -305,8 +233,6 @@ def register_opts(config):
 def list_opts():
     return {
         "DEFAULT": (aprsd_opts + enabled_plugins_opts),
-        admin_group.name: admin_opts,
         watch_list_group.name: watch_list_opts,
-        webchat_group.name: webchat_opts,
         registry_group.name: registry_opts,
     }

aprsd/conf/log.py

@@ -1,11 +1,11 @@
 """
 The options for log setup
 """
+
 import logging
 
 from oslo_config import cfg
 
-
 LOG_LEVELS = {
     "CRITICAL": logging.CRITICAL,
     "ERROR": logging.ERROR,
@@ -59,7 +59,5 @@ def register_opts(config):
 
 def list_opts():
     return {
-        logging_group.name: (
-            logging_opts
-        ),
+        logging_group.name: (logging_opts),
     }

aprsd/conf/opts.py

@@ -31,7 +31,6 @@ import importlib
 import os
 import pkgutil
 
-
 LIST_OPTS_FUNC_NAME = "list_opts"
 
 
@@ -64,9 +63,11 @@ def _import_modules(module_names):
     for modname in module_names:
         mod = importlib.import_module("aprsd.conf." + modname)
         if not hasattr(mod, LIST_OPTS_FUNC_NAME):
-            msg = "The module 'aprsd.conf.%s' should have a '%s' "\
-                  "function which returns the config options." % \
-                  (modname, LIST_OPTS_FUNC_NAME)
+            msg = (
+                "The module 'aprsd.conf.%s' should have a '%s' "
+                "function which returns the config options."
+                % (modname, LIST_OPTS_FUNC_NAME)
+            )
             raise Exception(msg)
         else:
             imported_modules.append(mod)

aprsd/conf/plugin_common.py

@@ -1,6 +1,5 @@
 from oslo_config import cfg
 
-
 aprsfi_group = cfg.OptGroup(
     name="aprs_fi",
     title="APRS.FI website settings",
@@ -18,16 +17,10 @@ owm_wx_group = cfg.OptGroup(
     title="Options for the OWMWeatherPlugin",
 )
 
-location_group = cfg.OptGroup(
-    name="location_plugin",
-    title="Options for the LocationPlugin",
-)
-
 aprsfi_opts = [
     cfg.StrOpt(
         "apiKey",
-        help="Get the apiKey from your aprs.fi account here:"
-             "http://aprs.fi/account",
+        help="Get the apiKey from your aprs.fi account here:" "http://aprs.fi/account",
     ),
 ]
 
@@ -35,11 +28,11 @@ owm_wx_opts = [
     cfg.StrOpt(
         "apiKey",
         help="OWMWeatherPlugin api key to OpenWeatherMap's API."
-             "This plugin uses the openweathermap API to fetch"
-             "location and weather information."
-             "To use this plugin you need to get an openweathermap"
-             "account and apikey."
-             "https://home.openweathermap.org/api_keys",
+        "This plugin uses the openweathermap API to fetch"
+        "location and weather information."
+        "To use this plugin you need to get an openweathermap"
+        "account and apikey."
+        "https://home.openweathermap.org/api_keys",
     ),
 ]
 
@@ -47,116 +40,16 @@ avwx_opts = [
     cfg.StrOpt(
         "apiKey",
         help="avwx-api is an opensource project that has"
-             "a hosted service here: https://avwx.rest/"
-             "You can launch your own avwx-api in a container"
-             "by cloning the githug repo here:"
-             "https://github.com/avwx-rest/AVWX-API",
+        "a hosted service here: https://avwx.rest/"
+        "You can launch your own avwx-api in a container"
+        "by cloning the githug repo here:"
+        "https://github.com/avwx-rest/AVWX-API",
     ),
     cfg.StrOpt(
         "base_url",
         default="https://avwx.rest",
         help="The base url for the avwx API.  If you are hosting your own"
-             "Here is where you change the url to point to yours.",
-    ),
-]
-
-location_opts = [
-    cfg.StrOpt(
-        "geopy_geocoder",
-        choices=[
-            "ArcGIS", "AzureMaps", "Baidu", "Bing", "GoogleV3", "HERE",
-            "Nominatim", "OpenCage", "TomTom", "USGov", "What3Words", "Woosmap",
-        ],
-        default="Nominatim",
-        help="The geopy geocoder to use.  Default is Nominatim."
-             "See https://geopy.readthedocs.io/en/stable/#module-geopy.geocoders"
-             "for more information.",
-    ),
-    cfg.StrOpt(
-        "user_agent",
-        default="APRSD",
-        help="The user agent to use for the Nominatim geocoder."
-             "See https://geopy.readthedocs.io/en/stable/#module-geopy.geocoders"
-             "for more information.",
-    ),
-    cfg.StrOpt(
-        "arcgis_username",
-        default=None,
-        help="The username to use for the ArcGIS geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#arcgis"
-             "for more information."
-             "Only used for the ArcGIS geocoder.",
-    ),
-    cfg.StrOpt(
-        "arcgis_password",
-        default=None,
-        help="The password to use for the ArcGIS geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#arcgis"
-             "for more information."
-             "Only used for the ArcGIS geocoder.",
-    ),
-    cfg.StrOpt(
-        "azuremaps_subscription_key",
-        help="The subscription key to use for the AzureMaps geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#azuremaps"
-             "for more information."
-             "Only used for the AzureMaps geocoder.",
-    ),
-    cfg.StrOpt(
-        "baidu_api_key",
-        help="The API key to use for the Baidu geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#baidu"
-             "for more information."
-             "Only used for the Baidu geocoder.",
-    ),
-    cfg.StrOpt(
-        "bing_api_key",
-        help="The API key to use for the Bing geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#bing"
-             "for more information."
-             "Only used for the Bing geocoder.",
-    ),
-    cfg.StrOpt(
-        "google_api_key",
-        help="The API key to use for the Google geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#googlev3"
-             "for more information."
-             "Only used for the Google geocoder.",
-    ),
-    cfg.StrOpt(
-        "here_api_key",
-        help="The API key to use for the HERE geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#here"
-             "for more information."
-             "Only used for the HERE geocoder.",
-    ),
-    cfg.StrOpt(
-        "opencage_api_key",
-        help="The API key to use for the OpenCage geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#opencage"
-             "for more information."
-             "Only used for the OpenCage geocoder.",
-    ),
-    cfg.StrOpt(
-        "tomtom_api_key",
-        help="The API key to use for the TomTom geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#tomtom"
-             "for more information."
-             "Only used for the TomTom geocoder.",
-    ),
-    cfg.StrOpt(
-        "what3words_api_key",
-        help="The API key to use for the What3Words geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#what3words"
-             "for more information."
-             "Only used for the What3Words geocoder.",
-    ),
-    cfg.StrOpt(
-        "woosmap_api_key",
-        help="The API key to use for the Woosmap geocoder."
-             "See https://geopy.readthedocs.io/en/latest/#woosmap"
-             "for more information."
-             "Only used for the Woosmap geocoder.",
+        "Here is where you change the url to point to yours.",
     ),
 ]
 
@@ -169,8 +62,6 @@ def register_opts(config):
     config.register_opts(owm_wx_opts, group=owm_wx_group)
     config.register_group(avwx_group)
     config.register_opts(avwx_opts, group=avwx_group)
-    config.register_group(location_group)
-    config.register_opts(location_opts, group=location_group)
 
 
 def list_opts():
@@ -178,5 +69,4 @@ def list_opts():
         aprsfi_group.name: aprsfi_opts,
         owm_wx_group.name: owm_wx_opts,
         avwx_group.name: avwx_opts,
-        location_group.name: location_opts,
     }

aprsd/exception.py

@@ -1,11 +1,13 @@
 class MissingConfigOptionException(Exception):
     """Missing a config option."""
+
     def __init__(self, config_option):
         self.message = f"Option '{config_option}' was not in config file"
 
 
 class ConfigOptionBogusDefaultException(Exception):
     """Missing a config option."""
+
     def __init__(self, config_option, default_fail):
         self.message = (
             f"Config file option '{config_option}' needs to be "

aprsd/log/log.py

@@ -1,5 +1,4 @@
 import logging
-from logging.handlers import QueueHandler
 import queue
 import sys
 
@@ -8,7 +7,6 @@ from oslo_config import cfg
 
 from aprsd.conf import log as conf_log
 
-
 CONF = cfg.CONF
 # LOG = logging.getLogger("APRSD")
 LOG = logger
@@ -19,6 +17,7 @@ class QueueLatest(queue.Queue):
 
     This prevents the queue from blowing up in size.
     """
+
     def put(self, *args, **kwargs):
         try:
             super().put(*args, **kwargs)
@@ -44,7 +43,9 @@ class InterceptHandler(logging.Handler):
             frame = frame.f_back
             depth += 1
 
-        logger.opt(depth=depth, exception=record.exc_info).log(level, record.getMessage())
+        logger.opt(depth=depth, exception=record.exc_info).log(
+            level, record.getMessage()
+        )
 
 
 # Setup the log faciility
@@ -60,43 +61,18 @@ def setup_logging(loglevel=None, quiet=False):
     logging.root.handlers = [InterceptHandler()]
     logging.root.setLevel(log_level)
 
-    imap_list = [
-        "imapclient.imaplib", "imaplib", "imapclient",
-        "imapclient.util",
-    ]
-    aprslib_list = [
+    # We don't really want to see the aprslib parsing debug output.
+    disable_list = [
         "aprslib",
         "aprslib.parsing",
         "aprslib.exceptions",
     ]
-    webserver_list = [
-        "werkzeug",
-        "werkzeug._internal",
-        "socketio",
-        "urllib3.connectionpool",
-        "chardet",
-        "chardet.charsetgroupprober",
-        "chardet.eucjpprober",
-        "chardet.mbcharsetprober",
-    ]
-
-    # We don't really want to see the aprslib parsing debug output.
-    disable_list = imap_list + aprslib_list + webserver_list
 
     # remove every other logger's handlers
     # and propagate to root logger
     for name in logging.root.manager.loggerDict.keys():
         logging.getLogger(name).handlers = []
-        if name in disable_list:
-            logging.getLogger(name).propagate = False
-        else:
-            logging.getLogger(name).propagate = True
-
-    if CONF.webchat.disable_url_request_logging:
-        for name in webserver_list:
-            logging.getLogger(name).handlers = []
-            logging.getLogger(name).propagate = True
-            logging.getLogger(name).setLevel(logging.ERROR)
+        logging.getLogger(name).propagate = name not in disable_list
 
     handlers = [
         {
@@ -118,21 +94,6 @@ def setup_logging(loglevel=None, quiet=False):
             },
         )
 
-    if CONF.email_plugin.enabled and CONF.email_plugin.debug:
-        for name in imap_list:
-            logging.getLogger(name).propagate = True
-
-    if CONF.admin.web_enabled:
-        qh = QueueHandler(logging_queue)
-        handlers.append(
-            {
-                "sink": qh, "serialize": False,
-                "format": CONF.logging.logformat,
-                "level": log_level,
-                "colorize": False,
-            },
-        )
-
     # configure loguru
     logger.configure(handlers=handlers)
     logger.level("DEBUG", color="<fg #BABABA>")

aprsd/main.py

@@ -22,11 +22,11 @@
 # python included libs
 import datetime
 import importlib.metadata as imp
-from importlib.metadata import version as metadata_version
 import logging
 import signal
 import sys
 import time
+from importlib.metadata import version as metadata_version
 
 import click
 from oslo_config import cfg, generator
@@ -36,7 +36,6 @@ import aprsd
 from aprsd import cli_helper, packets, threads, utils
 from aprsd.stats import collector
 
-
 # setup the global logger
 # log.basicConfig(level=log.DEBUG) # level=10
 CONF = cfg.CONF
@@ -54,8 +53,14 @@ def cli(ctx):
 
 def load_commands():
     from .cmds import (  # noqa
-        admin, completion, dev, fetch_stats, healthcheck, list_plugins, listen,
-        send_message, server, webchat,
+        completion,
+        dev,
+        fetch_stats,
+        healthcheck,
+        list_plugins,
+        listen,
+        send_message,
+        server,
     )
 
 
@@ -115,6 +120,7 @@ def sample_config(ctx):
 
     def _get_selected_entry_points():
         import sys
+
         if sys.version_info < (3, 10):
             all = imp.entry_points()
             selected = []

aprsd/packets/__init__.py

@@ -1,15 +1,25 @@
 from aprsd.packets import collector
 from aprsd.packets.core import (  # noqa: F401
-    AckPacket, BeaconPacket, BulletinPacket, GPSPacket, MessagePacket,
-    MicEPacket, ObjectPacket, Packet, RejectPacket, StatusPacket,
-    ThirdPartyPacket, UnknownPacket, WeatherPacket, factory,
+    AckPacket,
+    BeaconPacket,
+    BulletinPacket,
+    GPSPacket,
+    MessagePacket,
+    MicEPacket,
+    ObjectPacket,
+    Packet,
+    RejectPacket,
+    StatusPacket,
+    ThirdPartyPacket,
+    UnknownPacket,
+    WeatherPacket,
+    factory,
 )
 from aprsd.packets.packet_list import PacketList  # noqa: F401
 from aprsd.packets.seen_list import SeenList  # noqa: F401
 from aprsd.packets.tracker import PacketTrack  # noqa: F401
 from aprsd.packets.watch_list import WatchList  # noqa: F401
 
-
 # Register all the packet tracking objects.
 collector.PacketCollector().register(PacketList)
 collector.PacketCollector().register(SeenList)