gramps-webapi 3.22.2__tar.gz → 3.23.0__tar.gz

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/.github/workflows/test.yml

@@ -5,8 +5,29 @@ on:
   pull_request:
 
 jobs:
+  typecheck:
+    runs-on: ubuntu-26.04
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+      - name: Install Ubuntu dependencies
+        run: sudo apt update && sudo apt-get -y install gettext appstream pkg-config libcairo2-dev gir1.2-gtk-3.0 libgirepository1.0-dev libicu-dev libopencv-dev gir1.2-pango-1.0
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip wheel setuptools
+          # CPU-only build: the default one pulls in ~3 GB of CUDA libraries
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
+          pip install opencv-python
+          pip install -r requirements-dev.txt
+          pip install .[ai]
+      - name: Run type checker
+        run: mypy --install-types --non-interactive --ignore-missing-imports --exclude build .
+
   build:
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-26.04
     strategy:
       fail-fast: true
       matrix:
@@ -33,10 +54,12 @@ jobs:
           restore-keys: |
             hf-models-
       - name: Install Ubuntu dependencies
-        run: sudo apt update && sudo apt-get -y install gettext appstream pkg-config libcairo2-dev gir1.2-gtk-3.0 libgirepository1.0-dev libicu-dev libopencv-dev tesseract-ocr tesseract-ocr-all gir1.2-pango-1.0 poppler-utils
+        run: sudo apt update && sudo apt-get -y install gettext appstream pkg-config libcairo2-dev gir1.2-gtk-3.0 libgirepository1.0-dev libicu-dev libopencv-dev tesseract-ocr gir1.2-pango-1.0 poppler-utils
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip wheel setuptools
+          # CPU-only build: the default one pulls in ~3 GB of CUDA libraries
+          pip install torch --index-url https://download.pytorch.org/whl/cpu
           pip install opencv-python
           pip install -r requirements-dev.txt
           pip install .[ai]
@@ -59,15 +82,13 @@ jobs:
             alembic heads
             exit 1
           fi
-      - name: Run type checker
-        run: mypy --install-types --non-interactive --ignore-missing-imports --exclude build .
       - name: Test with pytest
         env:
           HF_HUB_OFFLINE: 1
         run: pytest -x
 
   test-base-image:
-    runs-on: ubuntu-24.04
+    runs-on: ubuntu-26.04
     container: ghcr.io/gramps-project/gramps-web-base:latest
     steps:
       - uses: actions/checkout@v5

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gramps-webapi
-Version: 3.22.2
+Version: 3.23.0
 Summary: A RESTful web API for the Gramps genealogical database.
 Author: Gramps Development Team
 Author-email: "David M. Straub" <straub@protonmail.com>
@@ -41,12 +41,11 @@ Requires-Dist: Unidecode
 Requires-Dist: pytesseract
 Requires-Dist: gramps-object-query-language<0.6,>=0.5.1
 Requires-Dist: gramps-ql>=0.5.0
-Requires-Dist: object-ql>=0.1.3
-Requires-Dist: sifts>=1.1.0
+Requires-Dist: sifts>=1.4.0
 Requires-Dist: requests
 Requires-Dist: yclade>=0.5.0
 Requires-Dist: Authlib>=1.6.4
-Requires-Dist: gramps-gedcom7
+Requires-Dist: gramps-gedcom7>=0.4.0
 Requires-Dist: flask-smorest
 Requires-Dist: typing-extensions>=4.13.0
 Provides-Extra: ai

gramps_webapi-3.23.0/alembic_users/versions/7b2e9f4c1a63_allow_several_access_tokens_per_scope.py

@@ -0,0 +1,81 @@
+"""Allow several labelled access tokens per user and scope
+
+Sync tokens are used one per device, and each device needs its own token so
+that it can be revoked on its own. The unique constraint on (user_id, scope)
+is replaced by one on (user_id, scope, label); scopes with a single token per
+user keep using an empty label. Also record when a token was last used.
+
+Revision ID: 7b2e9f4c1a63
+Revises: d4e9a1c7b3f2
+Create Date: 2026-10-03 00:00:00.000000
+
+"""
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.engine.reflection import Inspector
+
+# revision identifiers, used by Alembic.
+revision = "7b2e9f4c1a63"
+down_revision = "d4e9a1c7b3f2"
+branch_labels = None
+depends_on = None
+
+TABLE = "access_tokens"
+OLD_CONSTRAINT = "uq_access_tokens_user_scope"
+OLD_COLUMNS = ["user_id", "scope"]
+NEW_CONSTRAINT = "uq_access_tokens_user_scope_label"
+NEW_COLUMNS = ["user_id", "scope", "label"]
+# lets batch mode refer to a constraint if SQLite reflects it without a name
+NAMING_CONVENTION = {"uq": "uq_%(table_name)s_%(column_0_name)s"}
+
+
+def _unique_constraint_name(
+    inspector: Inspector, columns: list[str], default: str
+) -> str | None:
+    """Return the name of the unique constraint on columns, or None if absent."""
+    for constraint in inspector.get_unique_constraints(TABLE):
+        if list(constraint["column_names"]) == columns:
+            return constraint["name"] or default
+    return None
+
+
+def upgrade():
+    bind = op.get_bind()
+    inspector = Inspector.from_engine(bind)
+    columns = {column["name"] for column in inspector.get_columns(TABLE)}
+    old_name = _unique_constraint_name(inspector, OLD_COLUMNS, OLD_CONSTRAINT)
+    has_new = _unique_constraint_name(inspector, NEW_COLUMNS, NEW_CONSTRAINT)
+    # on SQLite, batch mode recreates the table, now with AUTOINCREMENT
+    with op.batch_alter_table(
+        TABLE,
+        naming_convention=NAMING_CONVENTION,
+        table_kwargs={"sqlite_autoincrement": True},
+    ) as batch_op:
+        if "label" not in columns:
+            batch_op.add_column(
+                sa.Column(
+                    "label", sa.String(length=100), nullable=False, server_default=""
+                )
+            )
+        if "last_used_at" not in columns:
+            batch_op.add_column(sa.Column("last_used_at", sa.DateTime(), nullable=True))
+        if old_name:
+            batch_op.drop_constraint(old_name, type_="unique")
+        if not has_new:
+            batch_op.create_unique_constraint(NEW_CONSTRAINT, NEW_COLUMNS)
+
+
+def downgrade():
+    bind = op.get_bind()
+    # the old schema allows a single token per user and scope, so labelled
+    # tokens (one per device) can't be kept
+    bind.execute(sa.text(f"DELETE FROM {TABLE} WHERE label != ''"))
+    inspector = Inspector.from_engine(bind)
+    new_name = _unique_constraint_name(inspector, NEW_COLUMNS, NEW_CONSTRAINT)
+    with op.batch_alter_table(TABLE, naming_convention=NAMING_CONVENTION) as batch_op:
+        if new_name:
+            batch_op.drop_constraint(new_name, type_="unique")
+        batch_op.create_unique_constraint(OLD_CONSTRAINT, OLD_COLUMNS)
+        batch_op.drop_column("last_used_at")
+        batch_op.drop_column("label")

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/gramps_webapi/_version.py

@@ -19,4 +19,4 @@
 
 """Version information."""
 
-__version__ = "3.22.2"
+__version__ = "3.23.0"

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/gramps_webapi/api/__init__.py

@@ -30,7 +30,11 @@ from .auth import jwt_required
 from .blueprint import api_blueprint
 from .cache import thumbnail_cache_decorator, tile_cache_decorator
 from .media import get_media_handler
-from .resources.access_tokens import UserAccessTokenResource
+from .resources.access_tokens import (
+    UserAccessTokenItemResource,
+    UserAccessTokenListResource,
+    UserAccessTokenResource,
+)
 from .resources.anniversaries import AnniversariesIcsResource
 from .resources.base import Resource, object_request_body
 from .resources.bookmarks import (
@@ -82,7 +86,11 @@ from .resources.merge import (
     MergeRepositoryResource,
     MergeSourceResource,
 )
-from .resources.metadata import MetadataResearcherResource, MetadataResource
+from .resources.metadata import (
+    MetadataResearcherResource,
+    MetadataResource,
+    MetadataServerResource,
+)
 from .resources.name_formats import NameFormatsResource
 from .resources.name_groups import NameGroupsResource
 from .resources.notes import NoteResource, NotesResource
@@ -112,7 +120,11 @@ from .resources.oidc import (
     OIDCTokenExchangeResource,
 )
 from .resources.people import PeopleResource, PersonResource
-from .resources.places import PlaceResource, PlacesResource
+from .resources.places import (
+    PlaceCoordinatesResource,
+    PlaceResource,
+    PlacesResource,
+)
 from .resources.relations import RelationResource, RelationsResource
 from .resources.reports import (
     ReportFileResource,
@@ -135,6 +147,7 @@ from .resources.token import (
     TokenCreateOwnerResource,
     TokenRefreshResource,
     TokenResource,
+    TokenSyncResource,
 )
 from .resources.transactions import TransactionsResource
 from .resources.translations import TranslationResource, TranslationsResource
@@ -281,6 +294,7 @@ register_endpt(
 # Token
 register_endpt(TokenResource, "/token/", "token", tags=["Token"])
 register_endpt(TokenRefreshResource, "/token/refresh/", "token_refresh", tags=["Token"])
+register_endpt(TokenSyncResource, "/token/sync/", "token_sync", tags=["Token"])
 register_endpt(
     TokenCreateOwnerResource,
     "/token/create_owner/",
@@ -435,6 +449,12 @@ register_endpt(
     object_name="Place",
 )
 register_endpt(PlaceQueryResource, "/places/query/", "places-query", tags=["Places"])
+register_endpt(
+    PlaceCoordinatesResource,
+    "/places/coordinates/",
+    "places-coordinates",
+    tags=["Places"],
+)
 register_endpt(
     MergePlaceResource,
     "/places/<string:phoenix_handle>/merge/<string:titanic_handle>",
@@ -782,6 +802,12 @@ register_endpt(
     "metadata_researcher",
     tags=["Metadata"],
 )
+register_endpt(
+    MetadataServerResource,
+    "/metadata/server/",
+    "metadata_server",
+    tags=["Metadata"],
+)
 # Anniversaries
 register_endpt(
     AnniversariesIcsResource,
@@ -798,6 +824,18 @@ register_endpt(
     "user_access_token",
     tags=["Users"],
 )
+register_endpt(
+    UserAccessTokenListResource,
+    "/users/-/access-tokens/<string:scope>/tokens/",
+    "user_access_token_list",
+    tags=["Users"],
+)
+register_endpt(
+    UserAccessTokenItemResource,
+    "/users/-/access-tokens/<string:scope>/tokens/<int:token_id>/",
+    "user_access_token_item",
+    tags=["Users"],
+)
 register_endpt(
     UserRegisterResource,
     "/users/<string:user_name>/register/",

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/gramps_webapi/api/export.py

@@ -27,8 +27,9 @@ import mimetypes
 import os
 import uuid
 from pathlib import Path
-from typing import Dict, Optional
+from typing import Callable, Dict, Optional
 
+import gramps_gedcom7
 from celery import Task
 from flask import abort, current_app
 from gramps.gen import filters
@@ -46,6 +47,7 @@ from gramps.gen.user import User
 from gramps.gen.utils.resourcepath import ResourcePath
 
 from ..const import DISABLED_EXPORTERS
+from .resources.util import truncate_import_report
 from .util import UserTaskProgress, abort_with_message, get_locale_for_language
 
 _ = glocale.translation.gettext
@@ -58,6 +60,16 @@ LIVING_FILTERS = {
     "ExcludeAll": LivingProxyDb.MODE_EXCLUDE_ALL,
 }
 
+# GEDCOM 7 is exported by the gramps-gedcom7 library rather than a plugin. Its
+# files end in .ged like GEDCOM 5.5.1, so it needs its own key in the API.
+GEDCOM7_EXTENSION = "ged7"
+GEDCOM7_EXPORTER = {
+    "name": "GEDCOM 7",
+    "description": "GEDCOM 7 is used to transfer data between genealogy programs.",
+    "extension": GEDCOM7_EXTENSION,
+    "module": "gramps_gedcom7",
+}
+
 # mimetypes.init()
 
 
@@ -206,6 +218,8 @@ def get_exporters(extension: str | None = None):
             "module": plugin.get_module_name(),
         }
         exporters.append(exporter)
+    if extension is None or extension == GEDCOM7_EXTENSION:
+        exporters.append(GEDCOM7_EXPORTER)
     return exporters
 
 
@@ -265,13 +279,26 @@ def prepare_options(db_handle: DbReadBase, args: Dict):
 
 
 def run_export(
-    db_handle: DbReadBase, extension: str, options, task: Optional[Task] = None
-):
-    """Generate the export."""
+    db_handle: DbReadBase,
+    extension: str,
+    options,
+    task: Optional[Task] = None,
+    progress: Callable[[int, int], None] | None = None,
+) -> tuple[str, str, list[str]]:
+    """Generate the export.
+
+    Plugin exporters report progress through `task`, the GEDCOM 7 exporter
+    through `progress`, called with the records done and the total.
+
+    Returns the file name, its extension, and the exporter's messages about
+    what it left out, if it reports any. Only the GEDCOM 7 exporter does.
+    """
     export_path = current_app.config.get("EXPORT_DIR")
     if not export_path:
         raise abort_with_message(500, "EXPORT_DIR not set in configuration")
     os.makedirs(export_path, exist_ok=True)
+    if extension == GEDCOM7_EXTENSION:
+        return run_gedcom7_export(db_handle, export_path, options, progress=progress)
     file_name = f"{uuid.uuid4()}.{extension}"
     file_path = os.path.join(export_path, file_name)
     _resources = ResourcePath()
@@ -297,5 +324,36 @@ def run_export(
                 )
             if not result:
                 abort_with_message(500, "Export function failed")
-            return file_name, "." + extension
+            return file_name, "." + extension, []
     abort_with_message(404, "Exporter not found")  # exporter not found
+
+
+def run_gedcom7_export(
+    db_handle: DbReadBase,
+    export_path: str,
+    options,
+    progress: Callable[[int, int], None] | None = None,
+) -> tuple[str, str, list[str]]:
+    """Export the database as a GEDCOM 7 file."""
+    file_name = f"{uuid.uuid4()}.ged"
+    file_path = os.path.join(export_path, file_name)
+    filters.reload_custom_filters()
+    try:
+        report = gramps_gedcom7.export_gedcom(
+            options.get_filtered_database(db_handle), file_path, progress=progress
+        )
+    except gramps_gedcom7.MissingObjectsError as e:
+        abort_with_message(
+            422,
+            f"The family tree cannot be exported: {e}. Running the check & "
+            "repair tool on the tree should fix this.",
+        )
+    except gramps_gedcom7.ExportValidationError as e:
+        if e.from_data:
+            abort_with_message(422, f"The family tree cannot be exported: {e}")
+        current_app.logger.exception("GEDCOM 7 export produced an invalid file")
+        abort_with_message(500, f"Export failed: {e}")
+    except Exception as e:
+        current_app.logger.exception("GEDCOM 7 export failed")
+        abort_with_message(500, f"Export failed: {e}")
+    return file_name, ".ged", truncate_import_report(report.messages())

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/gramps_webapi/api/llm/__init__.py

@@ -7,6 +7,7 @@ from typing import Any
 
 import httpx
 from flask import current_app
+from openai import OpenAIError
 from pydantic_ai import ModelMessagesTypeAdapter
 from pydantic_ai.exceptions import (
     ModelAPIError,
@@ -14,6 +15,7 @@ from pydantic_ai.exceptions import (
     ModelRetry,
     UnexpectedModelBehavior,
     UsageLimitExceeded,
+    UserError,
 )
 from pydantic_ai.messages import (
     ModelRequest,
@@ -131,13 +133,19 @@ def answer_with_agent(
     max_tokens = config.get("LLM_MAX_TOKENS", 200_000)
 
     if not model_name:
-        raise ValueError("No LLM model specified")
+        logger.error("No LLM model specified")
+        abort_with_message(500, "The AI model is not configured correctly.")
 
-    agent = create_agent(
-        model_name=model_name,
-        base_url=base_url,
-        system_prompt_override=system_prompt_override,
-    )
+    try:
+        agent = create_agent(
+            model_name=model_name,
+            base_url=base_url,
+            system_prompt_override=system_prompt_override,
+        )
+    except (UserError, ValueError, OpenAIError) as e:
+        # e.g. unknown provider prefix or missing provider API key/base URL
+        logger.error("Failed to set up the AI model '%s': %s", model_name, e)
+        abort_with_message(500, "The AI model is not configured correctly.")
 
     deps = AgentDeps(
         tree=tree,
@@ -150,7 +158,9 @@ def answer_with_agent(
     message_history: list[ModelRequest | ModelResponse] = []
     if message_history_raw:
         try:
-            message_history = ModelMessagesTypeAdapter.validate_json(message_history_raw)
+            message_history = ModelMessagesTypeAdapter.validate_json(
+                message_history_raw
+            )
         except Exception as e:  # pylint: disable=broad-except
             raise ValueError(f"Invalid message_history_raw: {e}") from e
     elif history:
@@ -186,12 +196,15 @@ def answer_with_agent(
         return result
     except UsageLimitExceeded as e:
         logger.warning("Agent usage limit exceeded: %s", e)
-        abort_with_message(429, "The AI agent exceeded its usage limits for this request.")
+        abort_with_message(
+            429, "The AI agent exceeded its usage limits for this request."
+        )
     except ModelHTTPError as e:
         logger.error("Model provider returned an error: %s", e)
         if e.status_code == 429:
             abort_with_message(
-                429, "The AI model provider is rate limiting requests. Please try again later."
+                429,
+                "The AI model provider is rate limiting requests. Please try again later.",
             )
         if e.status_code in (502, 503, 504, 529):
             # 529 is Anthropic's "overloaded"
@@ -199,7 +212,9 @@ def answer_with_agent(
         abort_with_message(502, "The AI model provider returned an error.")
     except httpx.TimeoutException as e:
         logger.error("Model provider request timed out: %r", e)
-        abort_with_message(504, "The AI model did not respond in time. Please try again.")
+        abort_with_message(
+            504, "The AI model did not respond in time. Please try again."
+        )
     except (ModelAPIError, httpx.TransportError) as e:
         # connection refused, DNS failure, protocol error, or an SDK-wrapped equivalent
         logger.error("Model provider request failed: %r", e)

{gramps_webapi-3.22.2 → gramps_webapi-3.23.0}/gramps_webapi/api/llm/agent.py

@@ -21,10 +21,15 @@
 
 from __future__ import annotations
 
+import warnings
+
 from pydantic_ai import Agent, RunContext
 from pydantic_ai.capabilities import ProcessHistory
 from pydantic_ai.messages import ModelMessage, ModelRequest, UserPromptPart
+from pydantic_ai.models.ollama import OllamaModel
 from pydantic_ai.models.openai import OpenAIChatModel
+from pydantic_ai.providers import infer_provider_class
+from pydantic_ai.providers.ollama import OllamaProvider
 from pydantic_ai.providers.openai import OpenAIProvider
 
 from .deps import AgentDeps
@@ -125,6 +130,25 @@ FORMATTING
 Use Markdown freely. When tool results contain links like [Name](/person/I0044), include them in your response exactly as they appear — never modify the path and never drop the link. Every person, family, event, place, source, citation, repository, note, and media object should be linked."""
 
 
+def _has_provider_prefix(model_name: str) -> bool:
+    """Whether the model name starts with a provider known to Pydantic AI.
+
+    A colon alone is not enough: Ollama model names like "qwen2.5:7b" use it
+    to separate the model from its tag.
+    """
+    if ":" not in model_name:
+        return False
+    provider_name = model_name.split(":", maxsplit=1)[0]
+    try:
+        with warnings.catch_warnings():
+            # deprecation warnings are emitted again when the model is created
+            warnings.simplefilter("ignore")
+            infer_provider_class(provider_name)
+    except ValueError:
+        return False
+    return True
+
+
 def create_agent(
     model_name: str,
     base_url: str | None = None,
@@ -133,13 +157,14 @@ def create_agent(
     """Create a Pydantic AI agent with the specified model.
 
     Args:
-        model_name: The name of the LLM model to use. If it contains a colon (e.g.,
-            "mistral:mistral-large-latest" or "openai:gpt-4"), it will be treated
-            as a provider-prefixed model name and Pydantic AI will handle provider
-            detection automatically. Otherwise, it will be treated as an OpenAI
-            compatible model name.
-        base_url: Optional base URL for the OpenAI-compatible API (ignored if
-            model_name contains a provider prefix)
+        model_name: The name of the LLM model to use. If it starts with a provider
+            prefix known to Pydantic AI (e.g., "mistral:mistral-large-latest" or
+            "openai:gpt-4"), Pydantic AI will handle provider detection
+            automatically. Otherwise (e.g., "gpt-4" or "qwen2.5:7b"), it will be
+            treated as an OpenAI compatible model name.
+        base_url: Optional base URL for the OpenAI-compatible API. Ignored if
+            model_name contains a provider prefix, except for "ollama:", where
+            it takes precedence over the OLLAMA_BASE_URL environment variable.
         system_prompt_override: Optional override for the system prompt
 
     Returns:
@@ -147,8 +172,13 @@ def create_agent(
     """
     # If model name has a provider prefix (e.g., "mistral:model-name"),
     # let Pydantic AI handle provider detection automatically
-    if ":" in model_name:
-        model: str | OpenAIChatModel = model_name
+    if model_name.startswith("ollama:") and base_url:
+        model: str | OpenAIChatModel = OllamaModel(
+            model_name.removeprefix("ollama:"),
+            provider=OllamaProvider(base_url=base_url),
+        )
+    elif _has_provider_prefix(model_name):
+        model = model_name
     else:
         # Otherwise, use OpenAI-compatible provider with optional base_url
         provider = OpenAIProvider(base_url=base_url)