From ebe66bff5ec21dc01659ccb50aa973a69ed32c1c Mon Sep 17 00:00:00 2001 From: nikazzio Date: Sun, 19 Apr 2026 23:19:04 +0200 Subject: [PATCH 1/5] feat(estense): add Biblioteca Estense (Jarvis) as a native IIIF provider MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Biblioteca Estense Universitaria in Modena is served by the Jarvis backend at jarvis.edl.beniculturali.it and exposes real IIIF — Presentation v2 and v3, Image API level 2 with tile and zoom. Wire it into Discovery as a first-class provider so the downloader, Studio reader, and Settings pane work without the on-the-fly conversions needed for ICCU. - resolvers/estense.py: recognise manifest URLs (v2 and v3), Mirador wrapper URLs on the Jarvis host, and bare UUIDs (8-4-4-4-12). Helpers build_manifest_url / build_viewer_url keep URL construction in one place. - resolvers/search/estense.py: use the Spring HATEOAS endpoint findBySgttOrAutnOrPressmark (short title / author / pressmark in one call) with Spring Pageable (0-based). Parse _embedded.culturalItems and expose totalElements / totalPages through the shared _search_total_results / _search_total_pages raw meta used by the Discovery UI. - providers.py: register "Estense" with search_strategy="estense", search_mode="search_first", sort_order=75 (between e-codices and Harvard). - network_policy.py: new "estense" key plus aliases (estense, edl, biblioteca estense, etc.) with the default non-custom policy — the Jarvis backend is a modern service and behaves like the IIIF-native providers, so no custom rate limiting is needed. - routes/discovery_handlers.py: add "estense" to _PAGINATABLE_STRATEGIES so Carica altri works. - components/settings/panes/network.py: dedicated Network & Libraries card for Estense matching the existing pattern. - tests/test_estense_unit.py + fixture: 11 unit tests covering UUID extraction across input shapes, URL builders, resolver behavior, search parsing against a real Jarvis response and Spring Pageable mapping. - Docs (provider-support, configuration, CONFIG_REFERENCE, discovery guide): Estense listed in the registry, added to the matrix and to the paginable provider list, dedicated Per-Provider Notes section with accepted inputs and SPA URL caveats. Refs #105 --- .../components/settings/panes/network.py | 21 ++ src/studio_ui/routes/discovery_handlers.py | 2 +- src/universal_iiif_core/network_policy.py | 24 ++ src/universal_iiif_core/providers.py | 31 +++ .../resolvers/discovery.py | 2 + src/universal_iiif_core/resolvers/estense.py | 93 ++++++++ .../resolvers/search/__init__.py | 2 + .../resolvers/search/estense.py | 170 ++++++++++++++ tests/fixtures/estense_search_sample.json | 210 ++++++++++++++++++ tests/test_estense_unit.py | 143 ++++++++++++ 10 files changed, 697 insertions(+), 1 deletion(-) create mode 100644 src/universal_iiif_core/resolvers/estense.py create mode 100644 src/universal_iiif_core/resolvers/search/estense.py create mode 100644 tests/fixtures/estense_search_sample.json create mode 100644 tests/test_estense_unit.py diff --git a/src/studio_ui/components/settings/panes/network.py b/src/studio_ui/components/settings/panes/network.py index bc1ab95..c06030c 100644 --- a/src/studio_ui/components/settings/panes/network.py +++ b/src/studio_ui/components/settings/panes/network.py @@ -504,6 +504,20 @@ def _build_network_pane(cm, s): **{"data-network-tab-pane": "internet_culturale"}, ) + estense_section = Div( + _build_network_library_card( + title="Biblioteca Estense (Modena)", + policy_key="estense", + policy_cfg=libraries_cfg.get( + "estense", + defaults["libraries"]["estense"], + ), + global_cfg=global_cfg, + ), + cls="hidden", + **{"data-network-tab-pane": "estense"}, + ) + return Div( Div(H3("Network & Libraries", cls="text-lg font-bold text-slate-800 dark:text-slate-100 mb-3")), P( @@ -541,6 +555,12 @@ def _build_network_pane(cm, s): cls="app-btn app-btn-neutral", **{"data-network-tab-btn": "institut_de_france"}, ), + Button( + "Estense", + type="button", + cls="app-btn app-btn-neutral", + **{"data-network-tab-btn": "estense"}, + ), Button( "Internet Culturale [BETA]", type="button", @@ -554,6 +574,7 @@ def _build_network_pane(cm, s): vaticana_section, bodleian_section, institut_section, + estense_section, internet_culturale_section, _network_subtabs_script(), cls="p-4", diff --git a/src/studio_ui/routes/discovery_handlers.py b/src/studio_ui/routes/discovery_handlers.py index 4c4afa2..2afb727 100644 --- a/src/studio_ui/routes/discovery_handlers.py +++ b/src/studio_ui/routes/discovery_handlers.py @@ -321,7 +321,7 @@ def probe_manifest(manifest_url: str, result_id: str = ""): # Providers whose external API supports page/offset pagination. -_PAGINATABLE_STRATEGIES = frozenset({"archive_org", "loc", "harvard", "gallica", "internetculturale"}) +_PAGINATABLE_STRATEGIES = frozenset({"archive_org", "loc", "harvard", "gallica", "internetculturale", "estense"}) def _provider_supports_pagination(provider) -> bool: diff --git a/src/universal_iiif_core/network_policy.py b/src/universal_iiif_core/network_policy.py index 565dc9b..a742200 100644 --- a/src/universal_iiif_core/network_policy.py +++ b/src/universal_iiif_core/network_policy.py @@ -16,6 +16,11 @@ "internet culturale (iccu)": "internet_culturale", "iccu": "internet_culturale", "internetculturale": "internet_culturale", + "estense": "estense", + "biblioteca estense": "estense", + "biblioteca estense (modena)": "estense", + "biblioteca estense universitaria": "estense", + "edl": "estense", "unknown": "unknown", } @@ -25,6 +30,7 @@ "bodleian", "institut_de_france", "internet_culturale", + "estense", "unknown", ) @@ -147,6 +153,24 @@ "send_referer_header": True, "send_origin_header": False, }, + "estense": { + "enabled": True, + "use_custom_policy": False, + "workers_per_job": 2, + "min_delay_s": 0.6, + "max_delay_s": 1.6, + "retry_max_attempts": 5, + "backoff_base_s": 15.0, + "backoff_cap_s": 300.0, + "cooldown_on_403_s": 120, + "cooldown_on_429_s": 120, + "burst_window_s": 60, + "burst_max_requests": 100, + "respect_retry_after": True, + "prewarm_viewer": False, + "send_referer_header": True, + "send_origin_header": False, + }, "unknown": { "enabled": True, "use_custom_policy": False, diff --git a/src/universal_iiif_core/providers.py b/src/universal_iiif_core/providers.py index 8a9d403..4601111 100644 --- a/src/universal_iiif_core/providers.py +++ b/src/universal_iiif_core/providers.py @@ -10,6 +10,7 @@ from universal_iiif_core.resolvers.base import BaseResolver from universal_iiif_core.resolvers.cambridge import CambridgeResolver from universal_iiif_core.resolvers.ecodices import EcodicesResolver +from universal_iiif_core.resolvers.estense import EstenseResolver from universal_iiif_core.resolvers.gallica import GallicaResolver from universal_iiif_core.resolvers.generic import GenericResolver from universal_iiif_core.resolvers.harvard import HarvardResolver @@ -28,6 +29,7 @@ "bodleian", "cambridge", "ecodices", + "estense", "gallica", "harvard", "heidelberg", @@ -250,6 +252,35 @@ def supports_direct_resolution(self) -> bool: placeholder="es. csg-0001", sort_order=70, ), + IIIFProvider( + key="Estense", + label="Biblioteca Estense (Modena)", + aliases=( + "estense", + "biblioteca estense", + "biblioteca estense (modena)", + "biblioteca estense universitaria", + "edl", + "estense digital library", + "modena", + ), + resolver_cls=EstenseResolver, + search_strategy="estense", + search_fn="search_estense", + search_mode="search_first", + not_found_hint=( + "Incolla un URL manifest jarvis.edl.beniculturali.it/meta/iiif/{uuid}/manifest, " + "il UUID dell'item, oppure cerca per titolo, autore o segnatura." + ), + placeholder="es. Muratori oppure A.M.02.12.A", + sort_order=75, + metadata={ + "helper_text": ( + "Biblioteca Estense Universitaria (Modena) — IIIF nativo v2/v3 con Image API level 2 " + "(zoom e tile). ~126.000 item; ricerca su titolo breve, autore e segnatura." + ), + }, + ), IIIFProvider( key="Harvard", label="Harvard University", diff --git a/src/universal_iiif_core/resolvers/discovery.py b/src/universal_iiif_core/resolvers/discovery.py index 2f844d9..89ea762 100644 --- a/src/universal_iiif_core/resolvers/discovery.py +++ b/src/universal_iiif_core/resolvers/discovery.py @@ -26,6 +26,7 @@ search_bodleian, search_cambridge, search_ecodices, + search_estense, search_gallica, search_gallica_by_id, search_harvard, @@ -167,6 +168,7 @@ def get_manifest_details(manifest_url: str) -> SearchResult | None: "search_bodleian", "search_cambridge", "search_ecodices", + "search_estense", "search_gallica", "search_gallica_by_id", "search_harvard", diff --git a/src/universal_iiif_core/resolvers/estense.py b/src/universal_iiif_core/resolvers/estense.py new file mode 100644 index 0000000..4920779 --- /dev/null +++ b/src/universal_iiif_core/resolvers/estense.py @@ -0,0 +1,93 @@ +"""Resolver for Biblioteca Estense Digitale (Jarvis backend). + +Estense Digital Library is the Modena Biblioteca Estense Universitaria IIIF +platform, served by the Jarvis backend at ``jarvis.edl.beniculturali.it``. +Unlike ICCU, it exposes full native IIIF Presentation (v2 and v3) with a +level-2 Image API (tile/zoom/rescale). + +Accepted inputs: + - Manifest v2: ``https://jarvis.edl.beniculturali.it/meta/iiif/{uuid}/manifest`` + - Manifest v3: ``https://jarvis.edl.beniculturali.it/meta/iiif/v3/{uuid}/manifest`` + - Mirador viewer wrapper URL: ``https://jarvis.edl.beniculturali.it/images/viewers/mirador/?manifest=...`` + - Bare UUID (8-4-4-4-12 hex) — resolved to the v2 manifest + +``/beu/{public_id}`` URLs from ``edl.beniculturali.it`` and ``edl.cultura.gov.it`` +are not resolvable without a live API call: the Scriptoria UI surfaces them +by redirecting the user through the search flow, which returns the UUID +directly. +""" + +from __future__ import annotations + +import re +from urllib.parse import parse_qs, unquote, urlparse + +from .base import BaseResolver + +JARVIS_HOST = "jarvis.edl.beniculturali.it" +JARVIS_BASE = f"https://{JARVIS_HOST}" + +_UUID_RE = re.compile( + r"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + re.IGNORECASE, +) +_MANIFEST_PATH_RE = re.compile( + r"/meta/iiif/(?:v3/)?(?P[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})/manifest", + re.IGNORECASE, +) + + +def build_manifest_url(uuid: str, *, v3: bool = False) -> str: + """Build the Jarvis manifest URL for a given item UUID.""" + prefix = "v3/" if v3 else "" + return f"{JARVIS_BASE}/meta/iiif/{prefix}{uuid}/manifest" + + +def build_viewer_url(uuid: str, *, v3: bool = True) -> str: + """Build the Mirador viewer URL (v3 manifest by default).""" + manifest = build_manifest_url(uuid, v3=v3) + return f"{JARVIS_BASE}/images/viewers/mirador/?manifest={manifest}" + + +def build_cultural_item_url(uuid: str) -> str: + """Build the HATEOAS cultural item URL used by the search adapter.""" + return f"{JARVIS_BASE}/meta/culturalItems/search/findByUuid?uuid={uuid}" + + +def extract_uuid(url_or_id: str) -> str | None: + """Return the item UUID extracted from any accepted Estense input.""" + text = (url_or_id or "").strip() + if not text: + return None + + if _UUID_RE.match(text): + return text.lower() + + parsed = urlparse(text) + if JARVIS_HOST in (parsed.netloc or ""): + m = _MANIFEST_PATH_RE.search(parsed.path) + if m: + return m.group("uuid").lower() + nested = parse_qs(parsed.query).get("manifest") or [] + if nested: + nested_url = unquote(nested[0]) + inner = urlparse(nested_url) + m = _MANIFEST_PATH_RE.search(inner.path) + if m: + return m.group("uuid").lower() + return None + + +class EstenseResolver(BaseResolver): + """Resolver for Biblioteca Estense Digitale via the Jarvis backend.""" + + def can_resolve(self, url_or_id: str) -> bool: + """Return True when the input carries an Estense UUID or manifest URL.""" + return extract_uuid(url_or_id) is not None + + def get_manifest_url(self, url_or_id: str) -> tuple[str | None, str | None]: + """Return (manifest_url_v2, uuid) when the input is recognised.""" + uuid = extract_uuid(url_or_id) + if not uuid: + return None, None + return build_manifest_url(uuid), uuid diff --git a/src/universal_iiif_core/resolvers/search/__init__.py b/src/universal_iiif_core/resolvers/search/__init__.py index 3505ecf..ef707aa 100644 --- a/src/universal_iiif_core/resolvers/search/__init__.py +++ b/src/universal_iiif_core/resolvers/search/__init__.py @@ -10,6 +10,7 @@ from .bodleian import search_bodleian from .cambridge import search_cambridge from .ecodices import search_ecodices +from .estense import search_estense from .gallica import search_gallica, search_gallica_by_id from .harvard import search_harvard from .heidelberg import search_heidelberg @@ -24,6 +25,7 @@ "search_bodleian", "search_cambridge", "search_ecodices", + "search_estense", "search_gallica", "search_gallica_by_id", "search_harvard", diff --git a/src/universal_iiif_core/resolvers/search/estense.py b/src/universal_iiif_core/resolvers/search/estense.py new file mode 100644 index 0000000..b45a61a --- /dev/null +++ b/src/universal_iiif_core/resolvers/search/estense.py @@ -0,0 +1,170 @@ +"""Biblioteca Estense Digitale search via the Jarvis HATEOAS API. + +Uses the Spring Data REST search endpoint +``findBySgttOrAutnOrPressmark`` which covers short title, author, and +pressmark fields in one call and returns paged results with +``totalElements`` / ``totalPages`` metadata. +""" + +from __future__ import annotations + +from typing import Any, Final +from urllib.parse import urlencode + +from universal_iiif_core.logger import get_logger +from universal_iiif_core.resolvers.estense import ( + JARVIS_BASE, + build_manifest_url, + build_viewer_url, +) +from universal_iiif_core.resolvers.models import SearchResult + +from ._common import DISCOVERY_TIMEOUT, REAL_BROWSER_HEADERS, get_search_http_client + +logger = get_logger(__name__) + +_SEARCH_ENDPOINT: Final = f"{JARVIS_BASE}/meta/culturalItems/search/findBySgttOrAutnOrPressmark" +_THUMBNAIL_PREFIX: Final = f"{JARVIS_BASE}/images/db/" + + +def _manifest_link(item: dict[str, Any], uuid: str) -> str: + """Return the v2 manifest URL (trust the embedded link when present).""" + link = (item.get("_links") or {}).get("manifest") or {} + href = str(link.get("href") or "").strip() + return href or build_manifest_url(uuid) + + +def _viewer_link(item: dict[str, Any], uuid: str) -> str: + link = (item.get("_links") or {}).get("viewer_iiif") or {} + href = str(link.get("href") or "").strip() + return href or build_viewer_url(uuid) + + +def _thumbnail_link(item: dict[str, Any]) -> str: + link = (item.get("_links") or {}).get("thumbnail") or {} + href = str(link.get("href") or "").strip() + return href + + +def _first_custom_metadata(item: dict[str, Any], key: str) -> str: + """Extract a single value from the optional customMetadataList array.""" + for entry in item.get("customMetadataList") or []: + if not isinstance(entry, dict): + continue + if str(entry.get("name") or "").strip().lower() == key.lower(): + value = entry.get("value") + if isinstance(value, str) and value.strip(): + return value.strip() + if isinstance(value, list): + for v in value: + if isinstance(v, str) and v.strip(): + return v.strip() + return "" + + +def _build_result(item: dict[str, Any]) -> SearchResult | None: + uuid = str(item.get("uuid") or "").strip() + if not uuid: + return None + + sgtt = str(item.get("sgtt") or "").strip() + autn = str(item.get("autn") or "").strip() + pressmark = str(item.get("pressmark") or "").strip() + description = _first_custom_metadata(item, "description") or _first_custom_metadata(item, "dcDescription") + date = _first_custom_metadata(item, "date") or _first_custom_metadata(item, "dcDate") + language = _first_custom_metadata(item, "language") + + title = sgtt or pressmark or uuid + manifest_url = _manifest_link(item, uuid) + viewer_url = _viewer_link(item, uuid) + thumb = _thumbnail_link(item) + + return SearchResult( + id=uuid, + title=title, + author=autn, + date=date, + description=description, + language=language, + library="Biblioteca Estense (Modena)", + thumbnail=thumb, + thumb=thumb, + manifest=manifest_url, + manifest_status="pending", + viewer_url=viewer_url, + raw={"uuid": uuid, "pressmark": pressmark, "sgtt": sgtt, "autn": autn}, + ) + + +def search_estense(query: str, max_results: int = 20, page: int = 1) -> list[SearchResult]: + """Search the Estense catalog by title / author / pressmark. + + Args: + query: Free-text query, matched upstream with a "contains" semantic. + max_results: Page size requested upstream (clamped to [1, 50]). + page: 1-based page index. + + Returns: + Parsed ``SearchResult`` list with a trailing ``_search_total_results`` + / ``_search_total_pages`` / ``_search_page`` block on the first item + so the Discovery UI can render "Mostrati X di Y". + """ + text = (query or "").strip() + if not text: + return [] + + size = max(1, min(int(max_results), 50)) + page_idx = max(1, int(page)) - 1 # Spring Pageable is 0-based + params = {"text": text, "size": str(size), "page": str(page_idx)} + url = f"{_SEARCH_ENDPOINT}?{urlencode(params)}" + + try: + resp = get_search_http_client().get( + url, + headers=REAL_BROWSER_HEADERS, + timeout=DISCOVERY_TIMEOUT, + library_name="estense", + retries=2, + ) + resp.raise_for_status() + except Exception as exc: + logger.error("Estense search failed for %r: %s", text, exc) + return [] + + try: + payload = resp.json() + except ValueError: + logger.error("Estense search returned non-JSON payload for %r", text) + return [] + + embedded = payload.get("_embedded", {}) or {} + items = embedded.get("culturalItems", []) or [] + page_meta = payload.get("page", {}) or {} + + results: list[SearchResult] = [] + for item in items: + if not isinstance(item, dict): + continue + parsed = _build_result(item) + if parsed is not None: + results.append(parsed) + + if results: + total_elements = int(page_meta.get("totalElements") or 0) + total_pages = int(page_meta.get("totalPages") or 0) + raw = dict(results[0].get("raw") or {}) + raw["_search_total_results"] = total_elements + raw["_search_total_pages"] = total_pages + raw["_search_page"] = page_idx + 1 + results[0]["raw"] = raw + + logger.debug( + "Estense search %r -> %d results (page %d of %d; total=%d)", + text, + len(results), + page_idx + 1, + int(page_meta.get("totalPages") or 0), + int(page_meta.get("totalElements") or 0), + ) + + return results[:size] diff --git a/tests/fixtures/estense_search_sample.json b/tests/fixtures/estense_search_sample.json new file mode 100644 index 0000000..63de720 --- /dev/null +++ b/tests/fixtures/estense_search_sample.json @@ -0,0 +1,210 @@ +{ + "_embedded": { + "culturalItems": [ + { + "id": "5d276e05eca03b000666b4f8", + "uuid": "d0a7b072-0e45-4363-b2fb-a0be17c155db", + "tenant": "estense", + "auth": { + "accessLevelConstraints": [ + { + "role": "ROLE_ANONYMOUS", + "accessLevel": 30 + }, + { + "role": "ROLE_ADMIN", + "accessLevel": 30 + } + ], + "accessLevel": 30, + "canEdit": false + }, + "sgtt": "Vita nuova. Autografo di Muratori dall'ed. Firenze 1576", + "autn": "Alighieri, Dante", + "customMetadataList": [ + { + "name": "pressmark", + "value": "A.M.02.12.A" + }, + { + "name": "sgtt", + "value": "Vita nuova. Autografo di Muratori dall'ed. Firenze 1576" + }, + { + "name": "autn", + "value": "Alighieri, Dante" + } + ], + "state": "Created", + "resourceType": "ITEM", + "createdDate": "2019-07-11T19:12:37.000Z", + "lastModifiedDate": "2021-03-29T17:51:23.032Z", + "pressmark": "A.M.02.12.A", + "parentCollectionsUuids": [ + "85fd2ae0-78a2-4c35-94f2-41b6f6a71473" + ], + "mediaTypeInfo": { + "hasImage": true, + "has3D": false, + "hasAudio": false, + "hasVideo": false, + "has360": false, + "imagesCount": 49, + "model3DsCount": 0, + "audiosCount": 0, + "videosCount": 0, + "mediaTypeList": [ + "IMAGE" + ] + }, + "_links": { + "self": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e05eca03b000666b4f8" + }, + "culturalItem": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e05eca03b000666b4f8" + }, + "thumbnail": { + "href": "https://jarvis.edl.beniculturali.it/images/db/74f56477-46aa-4042-a5bf-5370a1ea381e/thumb.jpg" + }, + "manifest": { + "href": "https://jarvis.edl.beniculturali.it/meta/iiif/d0a7b072-0e45-4363-b2fb-a0be17c155db/manifest" + }, + "manifest_v3": { + "href": "https://jarvis.edl.beniculturali.it/meta/iiif/v3/d0a7b072-0e45-4363-b2fb-a0be17c155db/manifest" + }, + "viewer_iiif": { + "href": "https://jarvis.edl.beniculturali.it/images/viewers/mirador/?manifest=https://jarvis.edl.beniculturali.it/meta/iiif/v3/d0a7b072-0e45-4363-b2fb-a0be17c155db/manifest" + }, + "viewer_dzi": { + "href": "https://jarvis.edl.beniculturali.it/images/viewers/dzi/?culturalItemUuid=d0a7b072-0e45-4363-b2fb-a0be17c155db" + }, + "default_list_of_images": { + "href": "https://jarvis.edl.beniculturali.it/meta/imageLists/5d276e05eca03b000666b4f7/images" + }, + "mets": { + "href": "https://jarvis.edl.beniculturali.it/meta/mets/d0a7b072-0e45-4363-b2fb-a0be17c155db" + }, + "parentCollections": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e05eca03b000666b4f8/parentCollections" + }, + "imageLists": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e05eca03b000666b4f8/imageLists" + } + } + }, + { + "id": "5d276e09eca03b000666b4fd", + "uuid": "5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777", + "tenant": "estense", + "auth": { + "accessLevelConstraints": [ + { + "role": "ROLE_ANONYMOUS", + "accessLevel": 30 + }, + { + "role": "ROLE_ADMIN", + "accessLevel": 30 + } + ], + "accessLevel": 30, + "canEdit": false + }, + "sgtt": "Vita nuova. Autografo di Muratori dall'ed. Firenze 1576", + "autn": "Alighieri, Dante", + "customMetadataList": [ + { + "name": "pressmark", + "value": "A.M.02.12.B" + }, + { + "name": "sgtt", + "value": "Vita nuova. Autografo di Muratori dall'ed. Firenze 1576" + }, + { + "name": "autn", + "value": "Alighieri, Dante" + } + ], + "state": "Created", + "resourceType": "ITEM", + "createdDate": "2019-07-11T19:12:41.000Z", + "lastModifiedDate": "2021-03-29T17:51:23.039Z", + "pressmark": "A.M.02.12.B", + "parentCollectionsUuids": [ + "85fd2ae0-78a2-4c35-94f2-41b6f6a71473" + ], + "mediaTypeInfo": { + "hasImage": true, + "has3D": false, + "hasAudio": false, + "hasVideo": false, + "has360": false, + "imagesCount": 5, + "model3DsCount": 0, + "audiosCount": 0, + "videosCount": 0, + "mediaTypeList": [ + "IMAGE" + ] + }, + "_links": { + "self": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e09eca03b000666b4fd" + }, + "culturalItem": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e09eca03b000666b4fd" + }, + "thumbnail": { + "href": "https://jarvis.edl.beniculturali.it/images/db/09508c00-883d-4e28-8a33-a821101dbd6c/thumb.jpg" + }, + "manifest": { + "href": "https://jarvis.edl.beniculturali.it/meta/iiif/5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777/manifest" + }, + "manifest_v3": { + "href": "https://jarvis.edl.beniculturali.it/meta/iiif/v3/5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777/manifest" + }, + "viewer_iiif": { + "href": "https://jarvis.edl.beniculturali.it/images/viewers/mirador/?manifest=https://jarvis.edl.beniculturali.it/meta/iiif/v3/5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777/manifest" + }, + "viewer_dzi": { + "href": "https://jarvis.edl.beniculturali.it/images/viewers/dzi/?culturalItemUuid=5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777" + }, + "default_list_of_images": { + "href": "https://jarvis.edl.beniculturali.it/meta/imageLists/5d276e09eca03b000666b4fc/images" + }, + "mets": { + "href": "https://jarvis.edl.beniculturali.it/meta/mets/5a5bd28d-c5fe-4a45-8bf7-58ccaaa6b777" + }, + "parentCollections": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e09eca03b000666b4fd/parentCollections" + }, + "imageLists": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/5d276e09eca03b000666b4fd/imageLists" + } + } + } + ] + }, + "_links": { + "first": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/search/findBySgttOrAutnOrPressmark?text=dante&page=0&size=2" + }, + "self": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/search/findBySgttOrAutnOrPressmark?text=dante&page=0&size=2" + }, + "next": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/search/findBySgttOrAutnOrPressmark?text=dante&page=1&size=2" + }, + "last": { + "href": "https://jarvis.edl.beniculturali.it/meta/culturalItems/search/findBySgttOrAutnOrPressmark?text=dante&page=39&size=2" + } + }, + "page": { + "size": 2, + "totalElements": 79, + "totalPages": 40, + "number": 0 + } +} diff --git a/tests/test_estense_unit.py b/tests/test_estense_unit.py new file mode 100644 index 0000000..604f0ac --- /dev/null +++ b/tests/test_estense_unit.py @@ -0,0 +1,143 @@ +"""Unit tests for the Biblioteca Estense (Jarvis) provider.""" + +import json +from pathlib import Path + +from universal_iiif_core.resolvers.estense import ( + JARVIS_BASE, + EstenseResolver, + build_manifest_url, + build_viewer_url, + extract_uuid, +) +from universal_iiif_core.resolvers.search import _common as _search_common +from universal_iiif_core.resolvers.search.estense import search_estense + + +def _fixture_bytes() -> bytes: + return (Path(__file__).parent / "fixtures" / "estense_search_sample.json").read_bytes() + + +_UUID = "08bea380-6af7-4b77-aebe-e81fa315e8f4" + + +class _DummyResp: + def __init__(self, content_bytes: bytes, status_code: int = 200): + self.content = content_bytes + self.status_code = status_code + self.headers = {"Content-Type": "application/hal+json"} + + def raise_for_status(self): + if self.status_code >= 400: + import requests + + raise requests.HTTPError(f"status {self.status_code}") + + def json(self): + return json.loads(self.content) + + +def _patch_http_client(monkeypatch, fake_get): + class _Client: + def get(self, *args, **kwargs): + return fake_get(*args, **kwargs) + + monkeypatch.setattr(_search_common, "_http_client_cache", _Client()) + + +def test_extract_uuid_from_v2_manifest_url(): + url = f"{JARVIS_BASE}/meta/iiif/{_UUID}/manifest" + assert extract_uuid(url) == _UUID + + +def test_extract_uuid_from_v3_manifest_url(): + url = f"{JARVIS_BASE}/meta/iiif/v3/{_UUID}/manifest" + assert extract_uuid(url) == _UUID + + +def test_extract_uuid_from_mirador_viewer_url(): + inner = f"{JARVIS_BASE}/meta/iiif/{_UUID}/manifest" + url = f"{JARVIS_BASE}/images/viewers/mirador/?manifest={inner.replace(':', '%3A').replace('/', '%2F')}" + assert extract_uuid(url) == _UUID + + +def test_extract_uuid_from_bare_uuid(): + assert extract_uuid(_UUID) == _UUID + assert extract_uuid(_UUID.upper()) == _UUID # case-insensitive + + +def test_extract_uuid_rejects_unknown_input(): + assert extract_uuid("") is None + assert extract_uuid("not a uuid") is None + assert extract_uuid("https://example.org/manifest.json") is None + assert extract_uuid("https://jarvis.edl.beniculturali.it/meta/") is None + + +def test_build_manifest_and_viewer_urls(): + v2 = build_manifest_url(_UUID) + v3 = build_manifest_url(_UUID, v3=True) + assert v2.endswith(f"/meta/iiif/{_UUID}/manifest") + assert v3.endswith(f"/meta/iiif/v3/{_UUID}/manifest") + assert f"manifest={v3}" in build_viewer_url(_UUID) + + +def test_resolver_returns_manifest_for_known_inputs(): + r = EstenseResolver() + assert r.can_resolve(_UUID) + manifest_url, uuid = r.get_manifest_url(_UUID) + assert uuid == _UUID + assert manifest_url == build_manifest_url(_UUID) + + +def test_resolver_rejects_unrelated_inputs(): + r = EstenseResolver() + assert not r.can_resolve("") + assert not r.can_resolve("https://gallica.bnf.fr/ark:/12148/btv1b123") + + +def test_search_parses_live_fixture_and_surfaces_pagination(monkeypatch): + captured = {} + + def fake_get(url, **kwargs): + captured["url"] = url + return _DummyResp(_fixture_bytes()) + + _patch_http_client(monkeypatch, fake_get) + + results = search_estense("dante", max_results=2, page=1) + assert len(results) == 2 + assert "findBySgttOrAutnOrPressmark" in captured["url"] + assert "text=dante" in captured["url"] + assert "page=0" in captured["url"] # Spring Pageable is 0-based + + first = results[0] + assert first["library"] == "Biblioteca Estense (Modena)" + assert first["manifest"].startswith(JARVIS_BASE) + assert "/meta/iiif/" in first["manifest"] + assert first["manifest_status"] == "pending" + + raw = first.get("raw") or {} + assert raw.get("uuid") + assert isinstance(raw.get("_search_total_results"), int) and raw["_search_total_results"] > 0 + assert isinstance(raw.get("_search_total_pages"), int) and raw["_search_total_pages"] > 0 + assert raw.get("_search_page") == 1 + + +def test_search_returns_empty_on_blank_query(monkeypatch): + def fake_get(url, **kwargs): + raise AssertionError("search should not be invoked for blank query") + + _patch_http_client(monkeypatch, fake_get) + assert search_estense(" ", max_results=5) == [] + + +def test_search_maps_page_argument_to_zero_based(monkeypatch): + captured = {} + + def fake_get(url, **kwargs): + captured["url"] = url + return _DummyResp(_fixture_bytes()) + + _patch_http_client(monkeypatch, fake_get) + search_estense("dante", max_results=2, page=4) + assert "page=3" in captured["url"] From a909350d87aaecbf0f1fc8aeecb96f67f2385e41 Mon Sep 17 00:00:00 2001 From: nikazzio Date: Mon, 20 Apr 2026 00:23:04 +0200 Subject: [PATCH 2/5] fix(discovery): neutralize document wording and not-found feedback --- docs/CONFIG_REFERENCE.md | 4 ++-- docs/guides/discovery-and-library.md | 24 ++++++++++--------- docs/intro/getting-started.md | 8 +++---- docs/reference/cli.md | 18 +++++++------- docs/reference/configuration.md | 4 ++-- docs/reference/provider-support.md | 23 +++++++++++++++--- .../components/discovery_download_panel.py | 2 +- src/studio_ui/components/discovery_results.py | 2 +- src/studio_ui/routes/discovery_handlers.py | 6 ++--- ...est_discovery_handlers_resolve_manifest.py | 3 ++- 10 files changed, 57 insertions(+), 37 deletions(-) diff --git a/docs/CONFIG_REFERENCE.md b/docs/CONFIG_REFERENCE.md index 8bfd2a8..b13c1ec 100644 --- a/docs/CONFIG_REFERENCE.md +++ b/docs/CONFIG_REFERENCE.md @@ -133,7 +133,7 @@ Default download policies used when library-specific override is not enabled. ## `settings.network.libraries.` -Libraries supported: `gallica`, `vaticana`, `bodleian`, `institut_de_france`, `internet_culturale` (BETA), `unknown`. +Libraries supported: `gallica`, `vaticana`, `bodleian`, `institut_de_france`, `estense`, `internet_culturale` (BETA), `unknown`. **HTTPClient Integration**: These settings are used by the centralized `HTTPClient` class for per-library network policies (rate limiting, retry, backoff, concurrency). @@ -432,7 +432,7 @@ Discovery search configuration. Editable from Settings > Discovery tab in the we - `max_results_per_provider` (`int`, default: `20`) - Maximum number of results returned by each search provider per query. - Clamped to [1, 50] at runtime and on save. - - For paginatable providers (Archive.org, Harvard, LOC, Gallica, Internet Culturale (BETA)), additional results can be loaded via the "Carica altri risultati" button. + - For paginatable providers (Archive.org, Harvard, LOC, Gallica, Estense, Internet Culturale (BETA)), additional results can be loaded via the "Carica altri risultati" button. - Non-paginatable providers (Vatican, Bodleian, Cambridge, Heidelberg, Institut, e-codices) return at most this many results from a single API call. - For Internet Culturale (BETA) the upstream page size is fixed at 20 regardless of `max_results_per_provider`; the "has more" check relies on the authoritative `totalPages` parsed from the HTML instead of the result cap. diff --git a/docs/guides/discovery-and-library.md b/docs/guides/discovery-and-library.md index 760e18a..b76dd81 100644 --- a/docs/guides/discovery-and-library.md +++ b/docs/guides/discovery-and-library.md @@ -6,15 +6,15 @@ Discovery is the boundary layer between Scriptoria and heterogeneous external pr ## What Discovery Does -Discovery resolves external input into a candidate manuscript record. That input can be a direct IIIF manifest URL, a provider item URL, a shelfmark or provider-specific identifier, or a free-text query when the provider has a usable search adapter. +Discovery resolves external input into a candidate item record. That input can be a direct IIIF manifest URL, a provider item URL, a shelfmark or provider-specific identifier, or a free-text query when the provider has a usable search adapter. -The output of Discovery is not yet a full local manuscript workspace. It is a normalized candidate with enough metadata for preview, local registration, and later download. +The output of Discovery is not yet a full local workspace. It is a normalized candidate with enough metadata for preview, local registration, and later download. ## Resolve Versus Search Internally, Discovery supports both direct resolution and provider-specific search. Those are not the same operation. -- direct resolution means Scriptoria can normalize a known URL or identifier directly into a manifest and manuscript identity; +- direct resolution means Scriptoria can normalize a known URL or identifier directly into a manifest and stable item identity; - search means Scriptoria asks a provider-specific search surface for possible results and then maps those results back into the product model. Some providers are strong at both. Others are mostly direct-resolution providers with limited search value. This is why the type of input you paste matters. @@ -34,7 +34,7 @@ That is not just user advice. It reflects the shape of the provider registry and ## What Happens When You Add An Item -`Add item` does not force a full download. It persists a local manuscript record and related normalized metadata so the item becomes part of the local catalog. +`Add item` does not force a full download. It persists a local item record and related normalized metadata so the item becomes part of the local catalog. This is one of the most important product rules: @@ -57,11 +57,13 @@ Discovery also reflects provider-specific result behavior. Some providers can ex The practical posture is to treat Discovery as a normalized gateway, not as proof that every library offers the same search ergonomics. +Biblioteca Estense (Modena) is a dedicated provider for the Jarvis backend (`jarvis.edl.beniculturali.it`). Unlike ICCU, it exposes native IIIF v2/v3 manifests with a level-2 Image API, so items read comfortably inside Mirador with real zoom. Search uses the Spring Data REST endpoint and covers short title, author, and pressmark in a single call; pagination works the same way as for other discovery-first providers. + Internet Culturale **(BETA)** is a special case worth calling out explicitly. It sits at the bottom of the provider select because the integration is experimental: useful when ICCU is the only channel to reach an Italian record, but less reliable than any native IIIF provider. It is an aggregator that fronts around fifty Italian libraries (Laurenziana, Marciana, BNCF, BNCR, Estense, and many smaller partners) and it routinely returns thousands of results for a single keyword. Scriptoria shows the upstream total as "Mostrati X di Y risultati" so the size of the result set is visible, and "Carica altri risultati" walks through the remaining pages twenty at a time. Because the upstream does not expose a IIIF manifest directly, the manifest used internally is converted on-the-fly from ICCU's MAG/XML document; partial records (those declaring more pages than the server actually serves) are still saved as partial scans rather than failing outright, but expect occasional teaser records where only the frontispiece is really available. ## What Library Does -Library is the local catalog of manuscript records and their current working state. +Library is the local catalog of item records and their current working state. In practical terms, Library is where you: @@ -77,9 +79,9 @@ Library is not a passive bookmark list. It is the operational registry for the l ## What A Library Entry Represents -A Library card is the visible UI form of a local manuscript record. That record can include provider identity, manuscript id and manifest URL, normalized title and metadata preview, path information, local manifest state, local scan state, local PDF state, missing-page information, and the asset-state hints later used by Studio and Output. +A Library card is the visible UI form of a local item record. That record can include provider identity, item id and manifest URL, normalized title and metadata preview, path information, local manifest state, local scan state, local PDF state, missing-page information, and the asset-state hints later used by Studio and Output. -This is why Library matters even before a full download exists. It is already the stable identity layer for the manuscript inside Scriptoria. +This is why Library matters even before a full download exists. It is already the stable identity layer for the item inside Scriptoria. ## Saved, Partial, Complete @@ -115,7 +117,7 @@ Each of these is dispatched as a tracked download job with the standard pause, r The other surface in Library is catalog-side: actions that change how an item is described or classified locally without re-downloading anything. -- `Set type` records the manuscript type inside your own catalog. +- `Set type` records the item type inside your own catalog. - `Update notes` stores free-form annotations on the entry. - `Refresh metadata` re-fetches normalized metadata from the upstream provider when the source record has changed. - `Reclassify` re-runs provider classification for one item; `Reclassify all` and `Normalize states` are bulk passes used after registry or schema upgrades. @@ -124,13 +126,13 @@ These actions are cheap, local-state operations. Use them to keep your catalog c ## Why Discovery And Library Must Stay Separate -The separation is deliberate for three reasons. Providers are inconsistent, and the local catalog should not inherit the instability of upstream discovery surfaces. Local state also has to remain legible: a manuscript may be known locally long before it becomes a complete local asset set. Finally, the workflow is incremental by design. Scriptoria is built for shortlisting, staged download, partial repair, and later export, not only for all-or-nothing acquisition. +The separation is deliberate for three reasons. Providers are inconsistent, and the local catalog should not inherit the instability of upstream discovery surfaces. Local state also has to remain legible: an item may be known locally long before it becomes a complete local asset set. Finally, the workflow is incremental by design. Scriptoria is built for shortlisting, staged download, partial repair, and later export, not only for all-or-nothing acquisition. ## Practical Rule Of Thumb -If you are still deciding what the manuscript is, you are in `Discovery`. +If you are still deciding what the document is, you are in `Discovery`. -If Scriptoria already knows the manuscript and you are deciding what to do with its local state, you are in `Library`. +If Scriptoria already knows the document and you are deciding what to do with its local state, you are in `Library`. ## Related Docs diff --git a/docs/intro/getting-started.md b/docs/intro/getting-started.md index 00485fd..bcded15 100644 --- a/docs/intro/getting-started.md +++ b/docs/intro/getting-started.md @@ -1,6 +1,6 @@ # Getting Started -This page is the shortest reliable path to a working local installation and a first useful session. It does not try to document every feature. Its purpose is to get you from clone to a real manuscript workflow without confusion about what the application is doing. +This page is the shortest reliable path to a working local installation and a first useful session. It does not try to document every feature. Its purpose is to get you from clone to a real document workflow without confusion about what the application is doing. Scriptoria exposes two entry points. `scriptoria` starts the web application and gives you the complete workflow. `scriptoria-cli ""` is the direct CLI path when you already know the exact item you want. For most users, the web application is the right starting point because it exposes discovery, local cataloging, Studio work, and export in one place. @@ -47,7 +47,7 @@ At first start, expect a local-first application rather than a public website. E ## What You Will See -The interface is organized into four operational surfaces. `Discovery` resolves external inputs into candidate items. `Library` tracks the items already known to your local workspace. `Studio` opens one manuscript in a working context. `Output` handles page inspection, export preparation, and finished artifacts. +The interface is organized into four operational surfaces. `Discovery` resolves external inputs into candidate items. `Library` tracks the items already known to your local workspace. `Studio` opens one item in a working context. `Output` handles page inspection, export preparation, and finished artifacts. Those surfaces are separate because they represent different states in the workflow. Discovery is not Library, and Library is not the same thing as a complete local download. @@ -80,7 +80,7 @@ That last option is the least universal. Some providers are good at discovery-fi ## When To Use The CLI -Use the CLI when you already know the exact manuscript and do not need the full interactive workflow. +Use the CLI when you already know the exact document and do not need the full interactive workflow. Example: @@ -111,7 +111,7 @@ You do not need to touch configuration for a first session. Once you start worki Most first-run friction comes from a small set of predictable cases: - the input pasted into Discovery is too vague for the chosen provider; -- the manuscript is `saved` but not yet downloaded, so Studio opens in remote mode and looks slower than expected; +- the item is `saved` but not yet downloaded, so Studio opens in remote mode and looks slower than expected; - a partial download was interrupted and Library shows the item in a mid-state; - the upstream provider rate-limited a fast acquisition. diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 4000f1c..8d39f20 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -2,7 +2,7 @@ The CLI lives in `src/universal_iiif_cli/cli.py` and is exposed by the `scriptoria-cli` entry point. It shares the same provider registry, resolver layer, and local vault used by the web application, so anything resolved or stored from the CLI shows up in the same Library that Studio reads. -The CLI exists for two situations: direct acquisition when you already know the manuscript you want, and quick inspection or repair of local state without opening the web app. +The CLI exists for two situations: direct acquisition when you already know the document you want, and quick inspection or repair of local state without opening the web app. ## Basic Usage @@ -16,7 +16,7 @@ If you call `scriptoria-cli` with no positional argument, it enters an interacti ## Wizard Mode -Wizard mode is intentionally minimal. It asks for a manuscript or viewer URL, an optional output filename, and an optional OCR model name. It is meant for one-off downloads where you do not want to remember flag names. Anything more advanced should use explicit flags. +Wizard mode is intentionally minimal. It asks for a document or viewer URL, an optional output filename, and an optional OCR model name. It is meant for one-off downloads where you do not want to remember flag names. Anything more advanced should use explicit flags. ```text 🌍 UNIVERSAL IIIF DOWNLOADER 🌍 @@ -31,7 +31,7 @@ OCR Model (optional, e.g. 'kraken', press Enter to skip): ... These flags control the acquisition run started by a positional URL or by the wizard. - `-o, --output` - - Output PDF filename. Without this flag, Scriptoria picks a name from the manuscript identifier. + - Output PDF filename. Without this flag, Scriptoria picks a name from the item identifier. - `-w, --workers` - Concurrent downloads for the current run. Default `4`. Increase only if both your network and the upstream provider can absorb it without rate-limiting penalties. - `--clean-cache` @@ -48,15 +48,15 @@ These flags control the acquisition run started by a positional URL or by the wi These flags do not start a download. They read or modify the local vault directly through `VaultManager`. - `--list` - - List local manuscripts in the database. The output shows manuscript id, status, page progress, and provider library, with a status icon: ✅ complete, ⏳ downloading, ❌ error, ⚪ other. + - List local items in the database. The output shows item id, status, page progress, and provider library, with a status icon: ✅ complete, ⏳ downloading, ❌ error, ⚪ other. - `--info ID` - - Show stored fields for one manuscript (provider identity, status, paths, progress, manifest URL, and related metadata). + - Show stored fields for one item (provider identity, status, paths, progress, manifest URL, and related metadata). - `--delete ID` - - Delete a manuscript record from the vault. This removes the local catalog entry; runtime files on disk are handled by separate cleanup flows. + - Delete an item record from the vault. This removes the local catalog entry; runtime files on disk are handled by separate cleanup flows. - `--delete-job JOB_ID` - Remove a single download job row from the internal `download_jobs` table. Mostly useful during development or when stray records survive a crash. - `--set-status ID STATUS` - - Force the stored status for a manuscript. Standard values are `pending`, `downloading`, `complete`, and `error`. Other strings are accepted with a warning, but the rest of the system reasons in terms of the standard set. + - Force the stored status for an item. Standard values are `pending`, `downloading`, `complete`, and `error`. Other strings are accepted with a warning, but the rest of the system reasons in terms of the standard set. ## Other Options @@ -76,13 +76,13 @@ If you need to change those locations, edit `config.json` rather than passing pa ## Operational Notes - Resolution and provider classification use the same registry as the web UI. If a URL resolves in the CLI, it will resolve the same way in Discovery. -- Local state is shared with Studio. A manuscript downloaded from the CLI is immediately visible in Library and openable in Studio without further import. +- Local state is shared with Studio. An item downloaded from the CLI is immediately visible in Library and openable in Studio without further import. - The CLI is the right surface for shell pipelines, scripted batch acquisition, headless environments, and local-state inspection. - The legacy entry points `iiif-cli` and `iiif-studio` are still installed as aliases for `scriptoria-cli` and `scriptoria` to avoid breaking older scripts. New work should use the `scriptoria` names. ## Examples -Download a manuscript by direct manifest URL: +Download an item by direct manifest URL: ```bash scriptoria-cli "https://digi.vatlib.it/iiif/MSS_Urb.lat.1779/manifest.json" diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 97ae8c1..799710a 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -43,7 +43,7 @@ The `paths.*` keys define the local runtime directories used by Scriptoria. These paths cover: -- downloads and local manuscript workspaces; +- downloads and local document workspaces; - export output; - temporary image staging; - model caches; @@ -78,7 +78,7 @@ It is split into three layers: - `settings.network.download.*` for default document download behavior; - `settings.network.libraries..*` for provider-specific overrides. -The supported provider keys under `settings.network.libraries.*` are `gallica`, `vaticana`, `bodleian`, `institut_de_france`, `internet_culturale` **(BETA)**, and `unknown`. Setting `use_custom_policy: false` on a library makes it inherit the `settings.network.download.*` defaults; `true` activates the per-library override fields. +The supported provider keys under `settings.network.libraries.*` are `gallica`, `vaticana`, `bodleian`, `institut_de_france`, `estense`, `internet_culturale` **(BETA)**, and `unknown`. Setting `use_custom_policy: false` on a library makes it inherit the `settings.network.download.*` defaults; `true` activates the per-library override fields. `internet_culturale` (BETA) ships with a conservative default policy (2 workers per job, 1.0–3.0s delay, 300s cooldown on 403/429, 40 requests per 60s burst window) because the ICCU aggregator is a shared infrastructure and is noticeably less tolerant than large IIIF-native providers. diff --git a/docs/reference/provider-support.md b/docs/reference/provider-support.md index 54569cf..e8b5b61 100644 --- a/docs/reference/provider-support.md +++ b/docs/reference/provider-support.md @@ -13,6 +13,7 @@ The shared provider registry currently exposes these providers: - Universitaetsbibliothek Heidelberg - Cambridge University Digital Library - e-codices +- Biblioteca Estense (Modena) - Harvard University - Library of Congress - Internet Archive @@ -54,6 +55,7 @@ The provider has a stronger search-first experience and can reasonably be used f | Heidelberg | record ID or URL | `fallback` | Free-text search is variable; explicit record references are safer | | Cambridge | shelfmark or CUDL URL | `fallback` | Similar to Heidelberg; better with shelfmark/URL than with exploratory search | | e-codices | compound identifier or URL | `direct` with search handler | Best with IDs such as `csg-0001` or a direct e-codices URL | +| Biblioteca Estense (Modena) | text query, pressmark, Jarvis manifest URL or UUID | `search_first` | Native IIIF v2/v3 with level-2 Image API. Search covers short title, author and pressmark together | | Harvard | DRS-bearing item URL | `fallback` | Usually best treated as URL-driven | | Library of Congress | public item URL | `fallback` | Prefer `loc.gov/item/...` URLs | | Internet Archive | item URL or text query | `search_first` | Good discovery-first behavior for many cases | @@ -64,7 +66,7 @@ The provider has a stronger search-first experience and can reasonably be used f ### Vaticana -Vaticana works best when you already know the shelfmark or have an item-level reference. Scriptoria can search, but the real strength of this provider is explicit manuscript-oriented input. If the search surface feels ambiguous, switch immediately to a shelfmark or direct manifest path. +Vaticana works best when you already know the shelfmark or have an item-level reference. Scriptoria can search, but the real strength of this provider is explicit catalog-oriented input. If the search surface feels ambiguous, switch immediately to a shelfmark or direct manifest path. ### Gallica @@ -88,7 +90,22 @@ Cambridge behaves similarly to Heidelberg. Product-side support exists, but shel ### e-codices -e-codices behaves well with explicit compound identifiers and direct record URLs. If you know the manuscript id, Scriptoria can usually normalize it cleanly. +e-codices behaves well with explicit compound identifiers and direct record URLs. If you know the item id, Scriptoria can usually normalize it cleanly. + +### Biblioteca Estense (Modena) + +The Biblioteca Estense Universitaria in Modena (Biblioteca Estense Digitale / Estense Digital Library) is served by the Jarvis backend at `jarvis.edl.beniculturali.it`. It exposes full native IIIF with **both** Presentation v2 and v3 manifests and a **level-2 Image API** (tile service, zoom, rescaling) — there is no on-the-fly conversion, the manifest is first-class. + +Search uses the Spring Data REST endpoint `findBySgttOrAutnOrPressmark`, which covers short title, author, and pressmark in a single call and returns paged results with `totalElements` / `totalPages`. Scriptoria shows this as "Mostrati X di Y risultati" and enables "Carica altri" just like for Internet Archive or Gallica. + +Accepted inputs for direct resolution: + +- Manifest URL v2: `https://jarvis.edl.beniculturali.it/meta/iiif/{uuid}/manifest` +- Manifest URL v3: `https://jarvis.edl.beniculturali.it/meta/iiif/v3/{uuid}/manifest` +- Mirador viewer wrapper URL on the same host +- A bare item UUID (8-4-4-4-12 hex) + +The public `https://edl.beniculturali.it/beu/{id}` URLs are single-page-app links and are not resolved statically: reach the record via search and use the returned manifest/viewer URL. ### Harvard @@ -140,7 +157,7 @@ Both filters map directly to server-side parameters and survive pagination, so " ## How To Choose The Right Input -As a rule, use a direct IIIF manifest URL when you already have one, use provider record URLs when the provider is URL-driven, use shelfmarks or compound manuscript identifiers when the corpus is manuscript-centric, and reserve free-text search for providers that behave well in discovery-first mode. When a provider is known to be inconsistent from the product UI, switch to browser-assisted search early instead of forcing a weak path. +As a rule, use a direct IIIF manifest URL when you already have one, use provider record URLs when the provider is URL-driven, use shelfmarks or compound identifiers when the corpus is catalog-centric, and reserve free-text search for providers that behave well in discovery-first mode. When a provider is known to be inconsistent from the product UI, switch to browser-assisted search early instead of forcing a weak path. That is the practical way to avoid frustration across heterogeneous libraries. diff --git a/src/studio_ui/components/discovery_download_panel.py b/src/studio_ui/components/discovery_download_panel.py index 346a5db..af4e25b 100644 --- a/src/studio_ui/components/discovery_download_panel.py +++ b/src/studio_ui/components/discovery_download_panel.py @@ -101,7 +101,7 @@ def render_download_status(download_id: str, doc_id: str, library: str, status_d Span("✅", cls="text-4xl mb-4 block"), H3("Download Completato!", cls="text-xl font-bold text-green-400 mb-2"), P( - f"Il manoscritto '{doc_id}' è stato salvato correttamente.", + f"Il documento '{doc_id}' è stato salvato correttamente.", cls="text-slate-400 mb-6", ), A( diff --git a/src/studio_ui/components/discovery_results.py b/src/studio_ui/components/discovery_results.py index d507622..7b93a10 100644 --- a/src/studio_ui/components/discovery_results.py +++ b/src/studio_ui/components/discovery_results.py @@ -368,7 +368,7 @@ def render_preview(data: dict) -> Div: warning = None if pages > 500: warning = Div( - f"⚠️ Questo manoscritto contiene molte pagine ({pages}). Il download richiederà tempo.", + f"⚠️ Questo documento contiene molte pagine ({pages}). Il download richiederà tempo.", cls=( "text-xs text-amber-800 dark:text-amber-200 mb-4 bg-amber-50 " "dark:bg-amber-900/30 p-3 rounded border border-amber-200 dark:border-amber-700" diff --git a/src/studio_ui/routes/discovery_handlers.py b/src/studio_ui/routes/discovery_handlers.py index 2afb727..e5aa742 100644 --- a/src/studio_ui/routes/discovery_handlers.py +++ b/src/studio_ui/routes/discovery_handlers.py @@ -263,9 +263,9 @@ def resolve_manifest(library: str, shelfmark: str, gallica_type: str = "all", ic if resolution.status != "manifest" or not resolution.manifest_url: return _with_feedback_toast( - "Manoscritto non trovato", - f"Impossibile risolvere '{shelfmark}' per {provider.key}. {resolution.not_found_hint}", - tone="danger", + "Documento non trovato", + f"Nessun risultato utile per '{shelfmark}' in {provider.key}. {resolution.not_found_hint}", + tone="info", ) manifest_info, manifest_error = _analyze_manifest_safe(resolution.manifest_url) diff --git a/tests/test_discovery_handlers_resolve_manifest.py b/tests/test_discovery_handlers_resolve_manifest.py index da0ca78..74395fd 100644 --- a/tests/test_discovery_handlers_resolve_manifest.py +++ b/tests/test_discovery_handlers_resolve_manifest.py @@ -127,7 +127,8 @@ def test_resolve_manifest_returns_not_found_with_vatican_hint(monkeypatch): result = discovery_handlers.resolve_manifest("Vaticana", "invalid") result_str = str(result) - assert "Manoscritto non trovato" in result_str + assert "Documento non trovato" in result_str + assert "Nessun risultato utile" in result_str assert "Urb.lat.1779" in result_str From 01634897f010c7682d17a5c8085baaf7a1675571 Mon Sep 17 00:00:00 2001 From: nikazzio Date: Mon, 20 Apr 2026 00:30:40 +0200 Subject: [PATCH 3/5] chore(ci): retrigger pr checks From 97675060883f88a43a76e6ea08a3c356c63e31eb Mon Sep 17 00:00:00 2001 From: nikazzio Date: Mon, 20 Apr 2026 09:38:30 +0200 Subject: [PATCH 4/5] chore: adopt GPL-3.0-or-later licensing --- CONTRIBUTING.md | 2 +- LICENSE | 711 ++++++++++++++++++++++++++++++++++++++++++++++-- README.md | 4 +- package.json | 1 + pyproject.toml | 2 +- 5 files changed, 695 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef138d8..6631a8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,4 +100,4 @@ Open a [GitHub issue](https://github.com/nikazzio/scriptoria/issues/new) with: ## License -By submitting a pull request, you agree that your contribution is licensed under the [MIT License](LICENSE) that covers this project. +By submitting a pull request, you agree that your contribution is licensed under the [GNU GPL v3 or later](LICENSE) that covers this project. diff --git a/LICENSE b/LICENSE index dcbfb6e..e2c0e2f 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,690 @@ -MIT License - -Copyright (c) 2026 Nikazzio - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +Scriptoria +Copyright (C) 2026 Niki Corradetti + +Scriptoria is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +Scriptoria is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with Scriptoria. If not, see . + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w`. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c` for details. + +The hypothetical commands `show w` and `show c` should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index b270bd1..561dd11 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Coverage Python 3.10+ Release - MIT + GPL-3.0-or-later

@@ -125,5 +125,5 @@ Expected. Open an item from Library, or use the recent-work hub at `/studio`. ---

- Built for manuscript-heavy research workflows · MIT + Built for manuscript-heavy research workflows · GPL-3.0-or-later

diff --git a/package.json b/package.json index b49122e..fd470a2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,7 @@ { "name": "scriptoria-docs", "private": true, + "license": "GPL-3.0-or-later", "version": "0.1.0", "engines": { "node": ">=22.0.0" diff --git a/pyproject.toml b/pyproject.toml index 4bca78d..3978deb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ version = "0.27.2" description = "Scriptoria — a research workbench for IIIF manuscripts." readme = "README.md" requires-python = ">=3.10" -license = { text = "MIT" } +license = { text = "GPL-3.0-or-later" } dependencies = [ "python-fasthtml", "uvicorn", From a583e97436573b3c99e5704f831849cd3c211695 Mon Sep 17 00:00:00 2001 From: nikazzio Date: Mon, 20 Apr 2026 09:41:47 +0200 Subject: [PATCH 5/5] chore: move copyright notice out of license --- LICENSE | 16 ---------------- NOTICE | 5 +++++ 2 files changed, 5 insertions(+), 16 deletions(-) create mode 100644 NOTICE diff --git a/LICENSE b/LICENSE index e2c0e2f..97bcd0d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,19 +1,3 @@ -Scriptoria -Copyright (C) 2026 Niki Corradetti - -Scriptoria is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -Scriptoria is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. - -You should have received a copy of the GNU General Public License -along with Scriptoria. If not, see . - GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000..2ae87ba --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +Copyright (C) 2026 Niki Corradetti + +Scriptoria is licensed under the GNU General Public License, +version 3 or, at your option, any later version +(`GPL-3.0-or-later`).