repeaterbook 0.2.0__tar.gz → 0.2.2__tar.gz

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repeaterbook
-Version: 0.2.0
+Version: 0.2.2
 Summary: Python utility to work with data from RepeaterBook.
 Project-URL: homepage, https://github.com/MicaelJarniac/repeaterbook
 Project-URL: source, https://github.com/MicaelJarniac/repeaterbook
@@ -112,6 +112,10 @@ Python utility to work with data from RepeaterBook.
 
 Read RepeaterBook's official [API documentation](https://www.repeaterbook.com/wiki/doku.php?id=api) for more information.
 
+## Related Projects
+- https://github.com/MicaelJarniac/opengd77
+- https://github.com/MicaelJarniac/ogdrb
+
 ## See Also
 - https://github.com/afourney/hamkit/tree/main/packages/repeaterbook
 - https://github.com/desertblade/OpenGD77-Repeaterbook

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/docs/CHANGELOG.md

@@ -1,8 +1,35 @@
 # CHANGELOG
 
 
+## v0.2.2 (2026-01-31)
+
+### Bug Fixes
+
+- Tolerate RepeaterBook API drift ([#2](https://github.com/MicaelJarniac/repeaterbook/pull/2),
+  [`665d78e`](https://github.com/MicaelJarniac/repeaterbook/commit/665d78ee38ca856a242b8f5f6289c441f00193a2))
+
+* fix: tolerate RepeaterBook API drift (sponsor, NA fields, empty Use)
+
+* refactor: simplify Region parsing (use .get)
+
+* refactor: add b() helper for Yes/No + 1/0 fields
+
+
+## v0.2.1 (2025-04-09)
+
+### Chores
+
+- Links
+  ([`1d93cdb`](https://github.com/MicaelJarniac/repeaterbook/commit/1d93cdb5ae7dff17a6cb9943e66b2111f39617b5))
+
+
 ## v0.2.0 (2025-04-08)
 
+### Bug Fixes
+
+- Use `and_` for `square` query
+  ([`9c09b5e`](https://github.com/MicaelJarniac/repeaterbook/commit/9c09b5eff8a2a4cef3dda91d5fa4d44001b0f241))
+
 ### Features
 
 - Queries

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/docs/README.md

@@ -81,6 +81,10 @@ Python utility to work with data from RepeaterBook.
 
 Read RepeaterBook's official [API documentation](https://www.repeaterbook.com/wiki/doku.php?id=api) for more information.
 
+## Related Projects
+- https://github.com/MicaelJarniac/opengd77
+- https://github.com/MicaelJarniac/ogdrb
+
 ## See Also
 - https://github.com/afourney/hamkit/tree/main/packages/repeaterbook
 - https://github.com/desertblade/OpenGD77-Repeaterbook

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/playground/examples.ipynb

@@ -59,7 +59,7 @@
     ")\n",
     "\n",
     "filtered_repeaters = queries.filter_radius(\n",
-    "    rb.query(*queries.square(radius), Repeater.dmr_capable), radius\n",
+    "    rb.query(queries.square(radius), Repeater.dmr_capable), radius\n",
     ")\n",
     "pprint(filtered_repeaters)"
    ]

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "repeaterbook"
-version = "0.2.0"
+version = "0.2.2"
 description = "Python utility to work with data from RepeaterBook."
 authors = [
   {name = "Micael Jarniac", email = "micael@jarniac.dev"},

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/src/repeaterbook/models.py

@@ -165,6 +165,11 @@ EmergencyJSON: TypeAlias = Literal[
 ServiceTypeJSON: TypeAlias = Literal["GMRS"]
 
 
+# RepeaterBook has some variability between North America vs ROW exports.
+# In practice, fields can appear/disappear (e.g. NA includes County/ARES/... and
+# omits Region; ROW can include extra keys like "sponsor").
+#
+# Keep this TypedDict intentionally permissive for runtime robustness.
 RepeaterJSON = TypedDict(
     "RepeaterJSON",
     {
@@ -179,6 +184,11 @@ RepeaterJSON = TypedDict(
         "Region": str | None,
         "State": str,
         "Country": str,
+        "County": str,
+        "ARES": str,
+        "RACES": str,
+        "SKYWARN": str,
+        "CANWARN": str,
         "Lat": str,
         "Long": str,
         "Precise": ZeroOneJSON,
@@ -206,7 +216,9 @@ RepeaterJSON = TypedDict(
         "System Fusion": YesNoJSON,
         "Notes": str,
         "Last Update": str,
+        "sponsor": object,
     },
+    total=False,
 )
 
 

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/src/repeaterbook/queries.py

@@ -16,7 +16,7 @@ from typing import TYPE_CHECKING, NamedTuple
 
 from haversine import haversine  # type: ignore[import-untyped]
 from loguru import logger
-from sqlmodel import or_
+from sqlmodel import and_, or_
 
 from repeaterbook.models import Repeater
 from repeaterbook.utils import Radius, square_bounds
@@ -24,17 +24,16 @@ from repeaterbook.utils import Radius, square_bounds
 if TYPE_CHECKING:  # pragma: no cover
     from collections.abc import Iterable
 
-    from sqlalchemy.sql._typing import _ColumnExpressionArgument
     from sqlalchemy.sql.elements import ColumnElement
 
 
-def square(radius: Radius) -> tuple[_ColumnExpressionArgument[bool] | bool, ...]:
+def square(radius: Radius) -> ColumnElement[bool]:
     """Return a query for repeaters within a given square.
 
     Note: This is a square, not a circle. Use `filter_radius` afterwards.
     """
     bounds = square_bounds(radius=radius)
-    return (
+    return and_(
         Repeater.latitude >= bounds.south,
         Repeater.latitude <= bounds.north,
         Repeater.longitude >= bounds.west,

{repeaterbook-0.2.0 → repeaterbook-0.2.2}/src/repeaterbook/services.py

@@ -107,6 +107,7 @@ USE_MAP: Final = {
     "OPEN": Use.OPEN,
     "PRIVATE": Use.PRIVATE,
     "CLOSED": Use.CLOSED,
+    "": Use.OPEN,  # Some export payloads include empty Use; treat as OPEN.
 }
 
 STATUS_MAP: Final = {
@@ -125,54 +126,90 @@ def parse_date(date_str: str) -> date:
 
 
 def json_to_model(j: RepeaterJSON, /) -> Repeater:
-    """Converts a JSON object to a Repeater model."""
+    """Converts a JSON object to a Repeater model.
+
+    RepeaterBook export payloads vary slightly between endpoints.
+
+    - `exportROW.php` may include extra keys like `sponsor`.
+    - `export.php` (North America) includes keys like `County`/`ARES`/… and may omit
+      `Region`.
+
+    This function should be resilient to those differences.
+    """
+
+    def s(key: str) -> str:
+        v = j.get(key, "")
+        if v is None:
+            return ""
+        return str(v)
+
+    def b(key: str, *, default: bool = False) -> bool:
+        """Parse RepeaterBook boolean-ish fields.
+
+        RepeaterBook uses a mix of "Yes"/"No" strings and 1/0 ints.
+        Missing/unknown values fall back to `default`.
+        """
+        return BOOL_MAP.get(j.get(key), default)
+
     return Repeater.model_validate(
         Repeater(
-            state_id=j["State ID"],
-            repeater_id=j["Rptr ID"],
-            frequency=j["Frequency"],
-            input_frequency=j["Input Freq"],
-            pl_ctcss_uplink=j["PL"] or None,
-            pl_ctcss_tsq_downlink=j["TSQ"] or None,
-            location_nearest_city=j["Nearest City"],
-            landmark=j["Landmark"] or None,
-            region=j["Region"],
-            state=j["State"],
-            country=j["Country"],
-            latitude=j["Lat"],
-            longitude=j["Long"],
-            precise=BOOL_MAP[j["Precise"]],
-            callsign=j["Callsign"],
-            use_membership=USE_MAP[j["Use"]],
-            operational_status=STATUS_MAP[j["Operational Status"]],
-            allstar_node=j["AllStar Node"],
-            echolink_node=str(j["EchoLink Node"]) or None,
-            irlp_node=j["IRLP Node"] or None,
-            wires_node=j["Wires Node"] or None,
-            analog_capable=BOOL_MAP[j["FM Analog"]],
-            fm_bandwidth=j["FM Bandwidth"].replace(" kHz", "") or None,
-            dmr_capable=BOOL_MAP[j["DMR"]],
-            dmr_color_code=j["DMR Color Code"] or None,
-            dmr_id=str(j["DMR ID"]) or None,
-            d_star_capable=BOOL_MAP[j["D-Star"]],
-            nxdn_capable=BOOL_MAP[j["NXDN"]],
-            apco_p_25_capable=BOOL_MAP[j["APCO P-25"]],
-            p_25_nac=j["P-25 NAC"] or None,
-            m17_capable=BOOL_MAP[j["M17"]],
-            m17_can=j["M17 CAN"] or None,
-            tetra_capable=BOOL_MAP[j["Tetra"]],
-            tetra_mcc=j["Tetra MCC"] or None,
-            tetra_mnc=j["Tetra MNC"] or None,
-            yaesu_system_fusion_capable=BOOL_MAP[j["System Fusion"]],
-            notes=j["Notes"] or None,
-            last_update=parse_date(j["Last Update"]),
+            state_id=s("State ID"),
+            repeater_id=int(j.get("Rptr ID", 0) or 0),
+            frequency=s("Frequency"),
+            input_frequency=s("Input Freq"),
+            pl_ctcss_uplink=s("PL") or None,
+            pl_ctcss_tsq_downlink=s("TSQ") or None,
+            location_nearest_city=s("Nearest City"),
+            landmark=s("Landmark") or None,
+            region=j.get("Region"),
+            country=s("Country") or None,
+            county=s("County") or None,
+            state=s("State") or None,
+            latitude=s("Lat"),
+            longitude=s("Long"),
+            precise=BOOL_MAP[j.get("Precise", 0)],
+            callsign=s("Callsign") or None,
+            use_membership=USE_MAP.get(s("Use"), Use.OPEN),
+            operational_status=(
+                STATUS_MAP[s("Operational Status")]
+                if s("Operational Status")
+                else Status.UNKNOWN
+            ),
+            ares=s("ARES") or None,
+            races=s("RACES") or None,
+            skywarn=s("SKYWARN") or None,
+            canwarn=s("CANWARN") or None,
+            allstar_node=s("AllStar Node") or None,
+            echolink_node=s("EchoLink Node") or None,
+            irlp_node=s("IRLP Node") or None,
+            wires_node=s("Wires Node") or None,
+            analog_capable=b("FM Analog", default=False),
+            fm_bandwidth=s("FM Bandwidth").replace(" kHz", "") or None,
+            dmr_capable=b("DMR", default=False),
+            dmr_color_code=s("DMR Color Code") or None,
+            dmr_id=s("DMR ID") or None,
+            d_star_capable=b("D-Star", default=False),
+            nxdn_capable=b("NXDN", default=False),
+            apco_p_25_capable=b("APCO P-25", default=False),
+            p_25_nac=s("P-25 NAC") or None,
+            m17_capable=b("M17", default=False),
+            m17_can=s("M17 CAN") or None,
+            tetra_capable=b("Tetra", default=False),
+            tetra_mcc=s("Tetra MCC") or None,
+            tetra_mnc=s("Tetra MNC") or None,
+            yaesu_system_fusion_capable=b("System Fusion", default=False),
+            notes=s("Notes") or None,
+            last_update=parse_date(s("Last Update")),
         )
     )
 
 
 @attrs.frozen
 class RepeaterBookAPI:
-    """RepeaterBook API client."""
+    """RepeaterBook API client.
+
+    Must read https://www.repeaterbook.com/wiki/doku.php?id=api before using.
+    """
 
     base_url: URL = attrs.Factory(lambda: URL("https://repeaterbook.com"))
     app_name: str = "RepeaterBook Python SDK"

repeaterbook-0.2.2/tests/test_api_format.py

@@ -0,0 +1,115 @@
+"""Regression tests for RepeaterBook API format drift.
+
+We keep these tests offline by using minimal representative payload fragments.
+"""
+
+from __future__ import annotations
+
+from repeaterbook.services import json_to_model
+
+
+def test_json_to_model_accepts_row_payload_with_extra_keys() -> None:
+    """ROW export recently started including extra keys like `sponsor`.
+
+    This should not break parsing.
+    """
+    payload = {
+        "State ID": "BR",
+        "Rptr ID": 1065,
+        "Frequency": "53.750000",
+        "Input Freq": "52.15000",
+        "PL": "",
+        "TSQ": "",
+        "Nearest City": "Mateus Leme",
+        "Landmark": "",
+        "Region": None,
+        "State": "Brazil",
+        "Country": "Brazil",
+        "Lat": "-19.98950005",
+        "Long": "-44.43140030",
+        "Precise": 0,
+        "Callsign": "PY4RAP",
+        "Use": "OPEN",
+        "Operational Status": "On-air",
+        "AllStar Node": "0",
+        "EchoLink Node": "0",
+        "IRLP Node": "",
+        "Wires Node": "",
+        "FM Analog": "Yes",
+        "FM Bandwidth": "",
+        "DMR": "No",
+        "DMR Color Code": "",
+        "DMR ID": "",
+        "D-Star": "No",
+        "NXDN": "No",
+        "APCO P-25": "No",
+        "P-25 NAC": "",
+        "M17": "No",
+        "M17 CAN": "",
+        "Tetra": "No",
+        "Tetra MCC": "",
+        "Tetra MNC": "",
+        "System Fusion": "No",
+        "Notes": "",
+        "Last Update": "2025-01-01",
+        "sponsor": None,
+    }
+
+    rep = json_to_model(payload)  # type: ignore[arg-type]
+    assert rep.country == "Brazil"
+
+
+def test_json_to_model_accepts_north_america_payload_without_region() -> None:
+    """North America export includes County/ARES/... and may omit Region.
+
+    This used to raise KeyError; it should now parse.
+    """
+    payload = {
+        "State ID": "06",
+        "Rptr ID": 1,
+        "Frequency": "146.880000",
+        "Input Freq": "146.280000",
+        "PL": "100.0",
+        "TSQ": "100.0",
+        "Nearest City": "Somewhere",
+        "Landmark": "",
+        # No Region key
+        "County": "SomeCounty",
+        "State": "California",
+        "Country": "United States",
+        "Lat": "34.0000",
+        "Long": "-118.0000",
+        "Precise": 1,
+        "Callsign": "W6TEST",
+        "Use": "OPEN",
+        "Operational Status": "On-air",
+        "ARES": "",
+        "RACES": "",
+        "SKYWARN": "",
+        "CANWARN": "",
+        "AllStar Node": "0",
+        "EchoLink Node": "0",
+        "IRLP Node": "",
+        "Wires Node": "",
+        "FM Analog": "Yes",
+        "FM Bandwidth": "",
+        "DMR": "No",
+        "DMR Color Code": "",
+        "DMR ID": "",
+        "D-Star": "No",
+        "NXDN": "No",
+        "APCO P-25": "No",
+        "P-25 NAC": "",
+        "M17": "No",
+        "M17 CAN": "",
+        "Tetra": "No",
+        "Tetra MCC": "",
+        "Tetra MNC": "",
+        "System Fusion": "No",
+        "Notes": "",
+        "Last Update": "2025-01-01",
+    }
+
+    rep = json_to_model(payload)  # type: ignore[arg-type]
+    assert rep.region is None
+    assert rep.county == "SomeCounty"