ebird-api-data 0.3.1__tar.gz → 0.3.3__tar.gz

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ebird-api-data
-Version: 0.3.1
+Version: 0.3.3
 Summary: eBird API Data is a reusable Django app for loading data from eBird into a database.
 Author-email: Stuart MacKay <smackay@flagstonesoftware.com>
 License-Expression: MIT

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ebird-api-data"
-version = "0.3.1"
+version = "0.3.3"
 description = "eBird API Data is a reusable Django app for loading data from eBird into a database."
 keywords = ["checklists", "observations", "species", "Django", "eBird", "models"]
 license = "MIT"
@@ -65,7 +65,7 @@ dev-dependencies = [
 ]
 
 [tool.bumpversion]
-current_version = "0.3.1"
+current_version = "0.3.3"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 ignore_missing_version = false

ebird_api_data-0.3.3/src/ebird/api/data/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.3.3"

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/src/ebird/api/data/admin.py

@@ -13,7 +13,7 @@ from django.views import generic
 from . import models
 from .fields import TranslationCharField, TranslationTextField
 from .loaders import APILoader
-from .models import Observation, Species
+from .models import Observation, Species, Checklist
 
 
 class ObservationInline(admin.TabularInline):
@@ -44,6 +44,17 @@ class ObservationInline(admin.TabularInline):
             .order_by("species__taxon_order")
         )
 
+class ProtocolListFilter(admin.SimpleListFilter):
+    title = _("protocol")
+    parameter_name = "protocol_code"
+
+    def lookups(self, request, model_admin):
+        return Checklist.Protocol.choices
+
+    def queryset(self, request, queryset):
+        if value := self.value():
+            return queryset.filter(protocol_code=value)
+
 
 @admin.register(models.Checklist)
 class ChecklistAdmin(admin.ModelAdmin):
@@ -55,6 +66,7 @@ class ChecklistAdmin(admin.ModelAdmin):
         "location",
         "observer",
     )
+    list_filter = [ProtocolListFilter]
     ordering = ("-started",)
     search_fields = ("identifier", "location__name", "observer__name")
     autocomplete_fields = ("location", "observer")

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/src/ebird/api/data/loaders.py

@@ -8,6 +8,7 @@ import string
 import time
 
 from decimal import Decimal
+from functools import cache
 from typing import List, Optional
 from urllib.error import HTTPError, URLError
 
@@ -389,13 +390,10 @@ class APILoader:
             if duration := data.get("durationHrs"):
                 values["duration"] = int(duration * 60.0)
 
-            if data["protocolId"] == Checklist.Protocol.TRAVELLING.value:
-                # The distance travelled might not be reported.
-                if "effortDistanceKm" in data:
-                    dist: str = data["effortDistanceKm"]
-                    values["distance"] = round(Decimal(dist), 3)
-            elif data["protocolId"] == Checklist.Protocol.AREA.value:
-                area: str = data["effortAreaHa"]
+            if dist := data.get("effortDistanceKm"):
+                values["distance"] = round(Decimal(dist), 3)
+
+            if area := data.get("effortAreaHa"):
                 values["area"] = round(Decimal(area), 3)
 
             if data["protocolId"] not in Checklist.Protocol.values:
@@ -411,6 +409,7 @@ class APILoader:
 
         return checklist
 
+    @cache
     def fetch_subregions(self, region: str) -> List[str]:
         region_types: list = ["subnational1", "subnational2", None]
         levels: int = len(region.split("-", 2))

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/src/ebird/api/data/migrations/0001_initial.py

@@ -130,7 +130,7 @@ class Migration(migrations.Migration):
                 ('protocol_code', models.TextField(blank=True, help_text='The code used to identify the protocol.', verbose_name='protocol code')),
                 ('project_code', models.TextField(blank=True, help_text='The code used to identify the project (portal).', verbose_name='project code')),
                 ('duration', models.IntegerField(blank=True, help_text='The number of minutes spent counting.', null=True, verbose_name='duration')),
-                ('distance', models.DecimalField(blank=True, decimal_places=3, help_text='The distance, in metres, covered while travelling.', max_digits=6, null=True, verbose_name='distance')),
+                ('distance', models.DecimalField(blank=True, decimal_places=3, help_text='The distance, in kilometres, covered while travelling.', max_digits=6, null=True, verbose_name='distance')),
                 ('area', models.DecimalField(blank=True, decimal_places=3, help_text='The area covered, in hectares.', max_digits=6, null=True, verbose_name='area')),
                 ('complete', models.BooleanField(default=False, help_text='All species seen are reported.', verbose_name='complete')),
                 ('comments', models.TextField(blank=True, help_text='Any comments about the checklist.', verbose_name='comments')),

{ebird_api_data-0.3.1 → ebird_api_data-0.3.3}/src/ebird/api/data/models/checklist.py

@@ -151,7 +151,7 @@ class Checklist(models.Model):
         decimal_places=3,
         max_digits=6,
         verbose_name=_("distance"),
-        help_text=_("The distance, in metres, covered while travelling."),
+        help_text=_("The distance, in kilometres, covered while travelling."),
     )
 
     area = models.DecimalField(
@@ -201,3 +201,8 @@ class Checklist(models.Model):
 
     def __str__(self) -> str:
         return str(self.identifier)
+
+    def get_protocol(self):
+        if self.protocol_code:
+            return self.Protocol[self.protocol_code].label if self.protocol_code else ""
+        return ""

ebird_api_data-0.3.1/src/ebird/api/data/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.3.1"