diff --git a/aprsd/utils/config_converter.py b/aprsd/utils/config_converter.py index 3ca6284..011bf81 100644 --- a/aprsd/utils/config_converter.py +++ b/aprsd/utils/config_converter.py @@ -81,14 +81,14 @@ def dict_to_conf( ) -> cfg.CONF: """Convert a flat dictionary back to an oslo_cfg CONF object. - Takes a flat dictionary (with keys like 'group_name.option_name' for grouped + Takes a flat dictionary (with keys like ``group_name.option_name`` for grouped options) and applies those values to a CONF object. Only updates options that exist in the CONF object. Args: config_dict: The configuration dictionary to convert conf: The oslo_cfg CONF object to update (uses cfg.CONF if None) - mask_secrets: If True, skips options with masked values ('****') + mask_secrets: If True, skips options with masked values (four asterisks) Returns: The updated CONF object @@ -101,7 +101,7 @@ def dict_to_conf( 'W5XYZ' Note: - - Options with secret masks ('****') are skipped to avoid overwriting + - Options with secret masks (four asterisks) are skipped to avoid overwriting with placeholder values - Only recognized options in the CONF schema are updated - Invalid group/option names are silently skipped @@ -149,7 +149,7 @@ def json_to_conf( Args: json_str: The JSON string to parse conf: The oslo_cfg CONF object to update (uses cfg.CONF if None) - mask_secrets: If True, skips options with masked values ('****') + mask_secrets: If True, skips options with masked values (four asterisks) Returns: The updated CONF object diff --git a/docs/source/apidoc/aprsd.utils.rst b/docs/source/apidoc/aprsd.utils.rst index 3c3691d..12d8120 100644 --- a/docs/source/apidoc/aprsd.utils.rst +++ b/docs/source/apidoc/aprsd.utils.rst @@ -4,6 +4,14 @@ aprsd.utils package Submodules ---------- +aprsd.utils.config\_converter module +------------------------------------ + +.. automodule:: aprsd.utils.config_converter + :members: + :show-inheritance: + :undoc-members: + aprsd.utils.counter module -------------------------- diff --git a/docs/source/builtin_plugins.rst b/docs/source/builtin_plugins.rst index 6efecd1..f89be2d 100644 --- a/docs/source/builtin_plugins.rst +++ b/docs/source/builtin_plugins.rst @@ -411,7 +411,7 @@ Twitter Plugin * **Description:** Make tweets from your Ham Radio via APRS messages. Time OpenCage Plugin -~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~~ * **PyPI:** https://pypi.org/project/aprsd-timeopencage-plugin/ * **GitHub:** https://github.com/hemna/aprsd-timeopencage-plugin diff --git a/docs/source/readme.rst b/docs/source/readme.rst index 943fcff..72df4af 100644 --- a/docs/source/readme.rst +++ b/docs/source/readme.rst @@ -327,9 +327,12 @@ Current list 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 │