ebird-api-requests 4.3.0__tar.gz → 4.3.1__tar.gz

{ebird_api_requests-4.3.0/src/ebird_api_requests.egg-info → ebird_api_requests-4.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebird-api-requests
-Version: 4.3.0
+Version: 4.3.1
 Summary: A python library for accessing the eBird API, version 2.0
 Author-email: Stuart MacKay <smackay@flagstonesoftware.com>
 License: MIT License

{ebird_api_requests-4.3.0 → ebird_api_requests-4.3.1}/pyproject.toml

@@ -29,7 +29,7 @@ license = {text = "MIT License"}
 name = "ebird-api-requests"
 readme = "README.md"
 requires-python = ">= 3.10"
-version = "4.3.0"
+version = "4.3.1"
 
 [project.urls]
 Repository = "https://github.com/StuartMacKay/ebird-api-requests.git"
@@ -37,7 +37,7 @@ Issues = "https://github.com/StuartMacKay/ebird-api-requests/issues"
 Changelog = "https://github.com/StuartMacKay/ebird-api-requests/blob/master/CHANGELOG.md"
 
 [tool.bumpversion]
-current_version = "4.3.0"
+current_version = "4.3.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 ignore_missing_version = false

{ebird_api_requests-4.3.0 → ebird_api_requests-4.3.1}/src/ebird/api/requests/__init__.py

@@ -2,7 +2,7 @@
 
 """A set of wrapper functions for accessing the eBird API."""
 
-__version__ = "4.3.0"
+__version__ = "4.3.1"
 
 from ebird.api.requests.checklists import get_checklist, get_visits
 from ebird.api.requests.client import Client

{ebird_api_requests-4.3.0 → ebird_api_requests-4.3.1}/src/ebird/api/requests/statistics.py

@@ -2,11 +2,15 @@
 
 from ebird.api.requests.utils import call
 from ebird.api.requests.validation import (
+    Transform,
     clean_area,
+    clean_code,
     clean_date,
     clean_max_observers,
     clean_observer_rank,
     clean_region,
+    is_location,
+    is_subnational2,
 )
 
 TOP_100_URL = "https://api.ebird.org/v2/product/top100/%s/%s"
@@ -23,7 +27,8 @@ def get_top_100(token, region, date, rank="spp", max_results=100):
 
     :param token: the token needed to access the API.
 
-    :param region: the code for the region, eg. US-NV.
+    :param region: the code for a country, subnational1 region or location,
+    e.g. US, US-NV or L99381. The API does not support subnational2 regions.
 
     :param date: the date, since Jan 1st 1800.
 
@@ -42,7 +47,18 @@ def get_top_100(token, region, date, rank="spp", max_results=100):
     :raises HTTPError if the eBird API returns an error.
 
     """
-    url = TOP_100_URL % (clean_region(region), date.strftime("%Y/%m/%d"))
+    code = clean_code(region, transform=Transform.UPPER)
+    if is_location(code):
+        cleaned = code
+    elif is_subnational2(code):
+        raise ValueError(
+            "Value for 'region', %s, must be a country, e.g. 'US', "
+            "subnational1, e.g. 'US-NV' or location, e.g. 'L99381'" % region
+        )
+    else:
+        cleaned = clean_region(region)
+
+    url = TOP_100_URL % (cleaned, date.strftime("%Y/%m/%d"))
 
     params = {
         "maxObservers": clean_max_observers(max_results),

{ebird_api_requests-4.3.0 → ebird_api_requests-4.3.1/src/ebird_api_requests.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebird-api-requests
-Version: 4.3.0
+Version: 4.3.1
 Summary: A python library for accessing the eBird API, version 2.0
 Author-email: Stuart MacKay <smackay@flagstonesoftware.com>
 License: MIT License