finish zip codes option

Author: Mohamed Ben Makhlouf

pyzipcodeapi/api.py

@@ -197,7 +197,7 @@ def multi_distance(
     def radius(
         self,
         zip_code: str,
-        distance: int,
+        distance: float,
         minimal: bool = False,
         units: DistanceUnitEnum = DistanceUnitEnum.KM,
     ) -> Radius | DictReader | Element:
@@ -210,7 +210,7 @@ def radius(
 
     def multi_radius(
         self,
-        distance: int,
+        distance: float,
         zip_codes: list[str] | None = None,
         addresses: list[str] | None = None,
         units: DistanceUnitEnum = DistanceUnitEnum.KM,
@@ -231,7 +231,7 @@ def multi_radius(
     def match_close(
         self,
         zip_codes: list[str],
-        distance: int,
+        distance: float,
         units: DistanceUnitEnum = DistanceUnitEnum.KM,
     ) -> list[MatchClose] | DictReader | Element:
         """match-close.<format>/<zip_codes>/<distance>/<units>"""
@@ -252,9 +252,7 @@ def multi_info(
         self._get("multi-info", f"{','.join(zip_codes)}/{units}")
         return self._parse_response()
 
-    def city_zip_codes(
-        self, city: str, state: str
-    ) -> ZipCode | DictReader | Element:
+    def city_zip_codes(self, city: str, state: str) -> ZipCode | DictReader | Element:
         """
         US: city-zips.<format>/<city>/<state>
         CA: city-postal-codes.<format>/<city>/<province>
@@ -265,5 +263,32 @@ def city_zip_codes(
 
     def state_zip_codes(self, state: str) -> ZipCode | DictReader | Element:
         """state-zips.<format>/<state>"""
-        self._get("state-zips", f"{quote_plus(state)}")
+        self._get("state-zips", quote_plus(state))
         return self._parse_response(data_class=ZipCode)
+
+    def radius_sql(
+        self,
+        lat: float,
+        long: float,
+        distance: float,
+        lat_long_units: GeoUnitEnum = GeoUnitEnum.DEGREES,
+        units: DistanceUnitEnum = DistanceUnitEnum.KM,
+        lat_field_name: str = "lat",
+        long_field_name: str = "long",
+        precision: int = 1,
+    ) -> Radius | DictReader | Element:
+        """radius-sql.<format>/<lat>/<long>/<lat_long_units>/<distance>/<units>/<lat_field_name>/
+        <long_field_name>/<precision>"""
+        assert precision <= 16
+        args = [
+            str(lat),
+            str(long),
+            lat_long_units,
+            str(distance),
+            units,
+            lat_field_name,
+            long_field_name,
+            str(precision),
+        ]
+        self._get("radius-sql", "/".join(args))
+        return self._parse_response()

pyzipcodeapi/example.py

@@ -1,14 +1,10 @@
-from pyzipcodeapi.api import ZipCodeApi, ZipCodeApiV2
+from pyzipcodeapi.api import ZipCodeApiV2
 from pyzipcodeapi.enums import CountryEnum, DistanceUnitEnum, FormatEnum, GeoUnitEnum
 
 API_KEY = "DemoOnly00yDUhTAzyzlwpXrk6SuiuvD80IAvhCJowPjA5Cqgz9vb7QyIyzDE77r"
 
 if __name__ == "__main__":
     # set different inputs
-    f = "json"
-    u = "km"
-    ou = "degrees"
-    obj = ZipCodeApi(API_KEY)
     # V2
     f2 = FormatEnum.JSON
     ud = DistanceUnitEnum.KM
@@ -53,14 +49,14 @@
     # https://www.zipcodeapi.com/rest/<api_key>/radius-sql.<format>/<lat>/<long>/<lat_long_units>/<distance>/<units>/
     # <lat_field_name>/<long_field_name>/<precision>
     print(
-        obj.get("radius-sql", f).filter(
-            lat="37.722223",
-            long="-122.484048",
-            lat_long_units=ou,
-            distance="5",
-            units=u,
+        zca.radius_sql(
+            lat=37.722223,
+            long=-122.484048,
+            lat_long_units=ug,
+            distance=5,
+            units=ud,
             lat_field_name="lat",
             long_field_name="long",
-            precision="4",
+            precision=4,
         )
     )