Merge pull request #915 from dchiller/i878-neume-exemplars

feat: add neume exemplars for omr neume search

app/public/cantusdata/admin/admin.py

@@ -29,6 +29,7 @@ class ManuscriptAdmin(ModelAdmin):  # type: ignore[type-arg]
     actions = [reindex_in_solr, "load_chants"]
     ordering = ["-public", "name"]
     list_per_page = 200
+    change_form_template = "admin/manuscript_change_form.html"
     fieldsets = [
         (
             "Metadata",

app/public/cantusdata/helpers/iiif_helpers.py

@@ -0,0 +1,32 @@
+"""
+Functions for IIIF API boilerplate.
+"""
+
+
+def construct_image_api_url(image_uri: str, **kwargs: str | int) -> str:
+    """
+    Construct a IIIF image API request URL from an Image URI and
+    a set of apotion IIIF Image API parameters. Works with the Image
+    API v2 and v3.
+
+    Required parameters:
+    - image_uri: The URI of the image to request.
+
+    Optional parameters (see API docs, eg. https://iiif.io/api/image/2.1/):
+    - region: The region of the image to request. Region should be a string
+    that conforms to the IIIF Image API specification (see link above).
+    - size: The size of the image to request.
+    - rotation: The rotation of the image to request.
+    - quality: The quality of the image to request.
+    - format: The format of the image to request.
+
+
+    Returns:
+        The constructed IIIF image API request URL.
+    """
+    region = kwargs.get("region", "full")  # Default to full image
+    size = kwargs.get("size", "pct:50")  # Default to 50% of the original size
+    rotation = kwargs.get("rotation", "0")  # Default to no rotation
+    quality = kwargs.get("quality", "default")  # Default to default quality
+    img_format = kwargs.get("format", "jpg")  # Default to JPEG format
+    return f"{image_uri}/{region}/{size}/{rotation}/{quality}.{img_format}"

app/public/cantusdata/migrations/0004_alter_neumeexemplar_options_neumeexemplar_order.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.7 on 2024-09-19 18:10
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("cantusdata", "0003_chant_differentiae_database"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="neumeexemplar",
+            options={"ordering": ["order"]},
+        ),
+        migrations.AddField(
+            model_name="neumeexemplar",
+            name="order",
+            field=models.IntegerField(
+                default=1,
+                help_text="A helper field used to order the exemplars.\n         See helpers/neume_helpers.py for an explanation of how this is used.",
+            ),
+        ),
+    ]

app/public/cantusdata/models/manuscript.py

@@ -1,4 +1,5 @@
 from django.db import models
+from django.db.models.query import QuerySet
 from django.core.management import call_command
 from django.utils.text import slugify
 import threading
@@ -82,7 +83,7 @@ def siglum_slug(self):
         return slugify(self.siglum)
 
     @property
-    def neume_exemplars(self):
+    def neume_exemplars(self) -> QuerySet[NeumeExemplar]:
         return NeumeExemplar.objects.filter(folio__manuscript=self)
 
     def create_solr_record(self):