invenio-vocabularies 4.0.0__tar.gz → 4.2.0__tar.gz

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/.github/workflows/tests.yml

@@ -45,7 +45,7 @@ jobs:
     env:
       DB: ${{ matrix.db-service }}
       SEARCH: ${{ matrix.search-service }}
-      EXTRAS: tests,${{ matrix.SEARCH_EXTRAS }}
+      EXTRAS: tests,oaipmh,${{ matrix.SEARCH_EXTRAS }}
 
     steps:
       - name: Checkout

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/CHANGES.rst

@@ -8,6 +8,34 @@
 Changes
 =======
 
+Version v4.2.0 (released 2024-07-24)
+
+- ror: check last update; use ld+json for metadata (#367)
+- tasks: remove import funders task
+- funders: add and export custom transformer
+- affiliations: add and export custom transformer
+- datastreams: implement asynchronous writer
+
+Version v4.1.1 (released 2024-07-15)
+
+- installation: use invenio-oaipmh-scythe from PyPI
+
+Version v4.1.0 (released 2024-07-15)
+
+- readers: make OAI-PMH an optional extra
+- schema: add administration UI attributes
+- ror: fix duplicate acronymns and aliases
+- affiliations: fix title search
+- datastreams: have yaml writer output utf8
+- datastreams: add configs for funders and affiliations
+- affiliations: add datastreams
+- datastreams: move ror transformer to common
+- vocabulary-types: services, resources, and administration UI (#310)
+- config: add OpenAIRE mapping for "Latvian Council of Science"
+- funders: fix country name display (#343)
+- Initial implementation of OAIPMHReader (#329)
+- global: add "tags" field to all vocabularies
+
 Version 4.0.0 (released 2024-06-04)
 
 - datastreams: implement factories for generating vocabulary configurations

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: invenio-vocabularies
-Version: 4.0.0
+Version: 4.2.0
 Summary: "Invenio module for managing vocabularies."
 Home-page: https://github.com/inveniosoftware/invenio-vocabularies
 Author: CERN
@@ -50,6 +50,34 @@ Description: ..
         Changes
         =======
         
+        Version v4.2.0 (released 2024-07-24)
+        
+        - ror: check last update; use ld+json for metadata (#367)
+        - tasks: remove import funders task
+        - funders: add and export custom transformer
+        - affiliations: add and export custom transformer
+        - datastreams: implement asynchronous writer
+        
+        Version v4.1.1 (released 2024-07-15)
+        
+        - installation: use invenio-oaipmh-scythe from PyPI
+        
+        Version v4.1.0 (released 2024-07-15)
+        
+        - readers: make OAI-PMH an optional extra
+        - schema: add administration UI attributes
+        - ror: fix duplicate acronymns and aliases
+        - affiliations: fix title search
+        - datastreams: have yaml writer output utf8
+        - datastreams: add configs for funders and affiliations
+        - affiliations: add datastreams
+        - datastreams: move ror transformer to common
+        - vocabulary-types: services, resources, and administration UI (#310)
+        - config: add OpenAIRE mapping for "Latvian Council of Science"
+        - funders: fix country name display (#343)
+        - Initial implementation of OAIPMHReader (#329)
+        - global: add "tags" field to all vocabularies
+        
         Version 4.0.0 (released 2024-06-04)
         
         - datastreams: implement factories for generating vocabulary configurations
@@ -222,6 +250,7 @@ Keywords: invenio vocabulary management
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
 Requires-Python: >=3.7
+Provides-Extra: oaipmh
 Provides-Extra: tests
 Provides-Extra: elasticsearch7
 Provides-Extra: opensearch1

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/__init__.py

@@ -10,6 +10,6 @@
 
 from .ext import InvenioVocabularies
 
-__version__ = "4.0.0"
+__version__ = "4.2.0"
 
 __all__ = ("__version__", "InvenioVocabularies")

invenio-vocabularies-4.2.0/invenio_vocabularies/administration/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2024 CERN.
+# Copyright (C) 2024 Uni Münster.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Invenio administration views module for vocabularies."""

invenio-vocabularies-4.2.0/invenio_vocabularies/administration/views/__init__.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Uni Münster.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Invenio administration views module for Vocabularies."""

invenio-vocabularies-4.2.0/invenio_vocabularies/administration/views/vocabularies.py

@@ -0,0 +1,45 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2020-2024 CERN.
+# Copyright (C) 2024 Uni Münster.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Vocabularies admin interface."""
+
+from invenio_administration.views.base import (
+    AdminResourceEditView,
+    AdminResourceListView,
+)
+
+
+class VocabulariesListView(AdminResourceListView):
+    """Configuration for vocabularies list view."""
+
+    api_endpoint = "/vocabularies/"
+    name = "vocabulary-types"
+    menu_label = "Vocabulary Types"
+    resource_config = "vocabulary_admin_resource"
+    search_request_headers = {"Accept": "application/json"}
+    title = "Vocabulary Types"
+    category = "Site management"
+
+    pid_path = "id"
+    icon = "exchange"
+    template = "invenio_administration/search.html"
+
+    display_search = True
+    display_delete = False
+    display_edit = False
+    display_create = False
+
+    item_field_list = {
+        "id": {"text": "Name", "order": 1},
+        "count": {"text": "Number of entries", "order": 2},
+    }
+
+    search_config_name = "VOCABULARIES_TYPES_SEARCH"
+    search_facets_config_name = "VOCABULARIES_TYPES_FACETS"
+    search_sort_config_name = "VOCABULARIES_TYPES_SORT_OPTIONS"

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/CustomAwardForm.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -16,21 +16,9 @@ import Overridable from "react-overridable";
 
 function CustomAwardForm({ deserializeFunder, selectedFunding }) {
   function deserializeFunderToDropdown(funderItem) {
-    let funderName = null;
-    let funderPID = null;
-    let funderCountry = null;
-
-    if (funderItem.name) {
-      funderName = funderItem.name;
-    }
-
-    if (funderItem.id) {
-      funderPID = funderItem.id;
-    }
-
-    if (funderItem.country_name) {
-      funderCountry = funderItem.country_name;
-    }
+    const funderName = funderItem?.name;
+    const funderPID = funderItem?.id;
+    const funderCountry = funderItem?.country_name ?? funderItem?.country;
 
     if (!funderName && !funderPID) {
       return {};
@@ -100,7 +88,7 @@ function CustomAwardForm({ deserializeFunder, selectedFunding }) {
       </Overridable>
       <Overridable id="InvenioVocabularies.CustomAwardForm.AwardInformationHeader.Container">
         <Header as="h3" size="small">
-          {i18next.t("Award information")} ({i18next.t("optional")})
+          {i18next.t("Additional information")} ({i18next.t("optional")})
         </Header>
       </Overridable>
       <Form.Group widths="equal">
@@ -110,7 +98,7 @@ function CustomAwardForm({ deserializeFunder, selectedFunding }) {
         >
           <TextField
             label={i18next.t("Number")}
-            placeholder={i18next.t("Award number")}
+            placeholder={i18next.t("Award/Grant number")}
             fieldPath="selectedFunding.award.number"
           />
         </Overridable>
@@ -120,7 +108,7 @@ function CustomAwardForm({ deserializeFunder, selectedFunding }) {
         >
           <TextField
             label={i18next.t("Title")}
-            placeholder={i18next.t("Award Title")}
+            placeholder={i18next.t("Award/Grant Title")}
             fieldPath="selectedFunding.award.title"
           />
         </Overridable>
@@ -130,7 +118,7 @@ function CustomAwardForm({ deserializeFunder, selectedFunding }) {
         >
           <TextField
             label={i18next.t("URL")}
-            placeholder={i18next.t("Award URL")}
+            placeholder={i18next.t("Award/Grant URL")}
             fieldPath="selectedFunding.award.url"
           />
         </Overridable>

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingField.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -123,7 +123,7 @@ function FundingFieldForm(props) {
                 className="mb-5"
               >
                 <Icon name="add" />
-                {i18next.t("Add award")}
+                {i18next.t("Add")}
               </Button>
             }
             onAwardChange={(selectedFunding) => {

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/FundingModal.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -157,8 +157,8 @@ function FundingModal({
         >
           <Modal.Header as="h2" className="pt-10 pb-10">
             {mode === "standard"
-              ? i18next.t("Add standard award")
-              : i18next.t("Add custom award")}
+              ? i18next.t("Add standard award/grant")
+              : i18next.t("Add custom funding")}
           </Modal.Header>
           <Modal.Content>
             {mode === ModalTypes.STANDARD && (
@@ -172,7 +172,7 @@ function FundingModal({
                   <Grid.Row>
                     <Grid.Column width={11} floated="left" verticalAlign="middle">
                       <SearchBar
-                        placeholder={i18next.t("Search for awards")}
+                        placeholder={i18next.t("Search for awards/grants")}
                         autofocus
                         actionProps={{
                           icon: "search",
@@ -234,9 +234,7 @@ function FundingModal({
               primary
               icon="checkmark"
               content={
-                action === ModalActions.ADD
-                  ? i18next.t("Add award")
-                  : i18next.t("Change award")
+                action === ModalActions.ADD ? i18next.t("Add") : i18next.t("Change")
               }
             />
           </Modal.Actions>

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/assets/semantic-ui/js/invenio_vocabularies/src/contrib/forms/Funding/NoAwardResults.js

@@ -1,5 +1,5 @@
 // This file is part of InvenioVocabularies
-// Copyright (C) 2021-2023 CERN.
+// Copyright (C) 2021-2024 CERN.
 // Copyright (C) 2021 Northwestern University.
 //
 // Invenio is free software; you can redistribute it and/or modify it
@@ -16,7 +16,7 @@ export function NoAwardResults({ switchToCustom }) {
       basic
       content={
         <p>
-          {i18next.t("Did not find your award? ")}
+          {i18next.t("Did not find your award/grant? ")}
           <a
             href="/"
             onClick={(e) => {
@@ -24,7 +24,7 @@ export function NoAwardResults({ switchToCustom }) {
               switchToCustom();
             }}
           >
-            {i18next.t("Add a custom award.")}
+            {i18next.t("Add a custom award/grant.")}
           </a>
         </p>
       }

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/cli.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020-2021 CERN.
+# Copyright (C) 2020-2024 CERN.
 # Copyright (C) 2021 Graz University of Technology.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
@@ -9,7 +9,6 @@
 
 """Commands to create and manage vocabularies."""
 
-
 import click
 from flask.cli import with_appcontext
 from invenio_access.permissions import system_identity
@@ -101,7 +100,10 @@ def update(vocabulary, filepath=None, origin=None):
     config = vc.get_config(filepath, origin)
 
     for w_conf in config["writers"]:
-        w_conf["args"]["update"] = True
+        if w_conf["type"] == "async":
+            w_conf["args"]["writer"]["args"]["update"] = True
+        else:
+            w_conf["args"]["update"] = True
 
     success, errored, filtered = _process_vocab(config)
 

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2020 CERN.
+# Copyright (C) 2020-2024 CERN.
 # Copyright (C) 2021 Northwestern University.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
@@ -17,15 +17,16 @@ from .datastreams.readers import (
     GzipReader,
     JsonLinesReader,
     JsonReader,
+    OAIPMHReader,
     TarReader,
     XMLReader,
     YamlReader,
     ZipReader,
 )
 from .datastreams.transformers import XMLTransformer
-from .datastreams.writers import ServiceWriter, YamlWriter
-from .resources.resource import VocabulariesResourceConfig
-from .services.service import VocabulariesServiceConfig
+from .datastreams.writers import AsyncWriter, ServiceWriter, YamlWriter
+from .resources import VocabulariesResourceConfig
+from .services.config import VocabulariesServiceConfig
 
 VOCABULARIES_RESOURCE_CONFIG = VocabulariesResourceConfig
 """Configure the resource."""
@@ -75,6 +76,7 @@ VOCABULARIES_AWARDS_OPENAIRE_FUNDERS = {
     "fwf_________": "013tf3c58",
     "inca________": "03m8vkq32",
     "irb_hr______": "03n51vw80",
+    "lcs_________": "02ar66p97",
     "mestd_______": "01znas443",
     "nhmrc_______": "011kf5r70",
     "nih_________": "01cwqze88",
@@ -102,6 +104,15 @@ VOCABULARIES_NAMES_SCHEMES = {
 }
 """Names allowed identifier schemes."""
 
+# configure CUSTOM_VOCABULARY_TYPES to differentiate output. Is used in VocabulariesServiceConfig
+VOCABULARIES_CUSTOM_VOCABULARY_TYPES = [
+    "names",
+    "affiliations",
+    "awards",
+    "funders",
+    "subjects",
+]
+
 VOCABULARIES_DATASTREAM_READERS = {
     "csv": CSVReader,
     "json": JsonReader,
@@ -111,6 +122,7 @@ VOCABULARIES_DATASTREAM_READERS = {
     "yaml": YamlReader,
     "zip": ZipReader,
     "xml": XMLReader,
+    "oai-pmh": OAIPMHReader,
 }
 """Data Streams readers."""
 
@@ -122,5 +134,24 @@ VOCABULARIES_DATASTREAM_TRANSFORMERS = {
 VOCABULARIES_DATASTREAM_WRITERS = {
     "service": ServiceWriter,
     "yaml": YamlWriter,
+    "async": AsyncWriter,
 }
 """Data Streams writers."""
+
+VOCABULARIES_TYPES_SORT_OPTIONS = {
+    "name": dict(
+        title=_("Name"),
+        fields=["id"],
+    ),
+    "count": dict(
+        title=_("Number of entries"),
+        fields=["count"],
+    ),
+}
+"""Definitions of available Vocabulary types sort options. """
+
+VOCABULARIES_TYPES_SEARCH = {
+    "facets": [],
+    "sort": ["name", "count"],
+}
+"""Vocabulary type search configuration."""

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/contrib/affiliations/api.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 CERN.
+# Copyright (C) 2021-2024 CERN.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -8,7 +8,6 @@
 
 """Vocabulary affiliations."""
 
-
 from .affiliations import record_type
 
 Affiliation = record_type.record_cls

{invenio-vocabularies-4.0.0 → invenio-vocabularies-4.2.0}/invenio_vocabularies/contrib/affiliations/config.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright (C) 2021 CERN.
+# Copyright (C) 2021-2024 CERN.
 #
 # Invenio-Vocabularies is free software; you can redistribute it and/or
 # modify it under the terms of the MIT License; see LICENSE file for more
@@ -26,7 +26,7 @@ class AffiliationsSearchOptions(SearchOptions):
     """Search options."""
 
     suggest_parser_cls = SuggestQueryParser.factory(
-        fields=["name^100", "acronym^20", "id^20"],
+        fields=["name^100", "acronym^50", "title.*^20", "id^20", "aliases^20"],
     )
 
     sort_default = "bestmatch"

invenio-vocabularies-4.2.0/invenio_vocabularies/contrib/affiliations/datastreams.py

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-2024 CERN.
+# Copyright (C) 2024 California Institute of Technology.
+#
+# Invenio-Vocabularies is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
+"""Affiliations datastreams, transformers, writers and readers."""
+
+from flask import current_app
+from invenio_i18n import lazy_gettext as _
+
+from ...datastreams.writers import ServiceWriter
+from ..common.ror.datastreams import RORTransformer
+
+
+class AffiliationsServiceWriter(ServiceWriter):
+    """Affiliations service writer."""
+
+    def __init__(self, *args, **kwargs):
+        """Constructor."""
+        service_or_name = kwargs.pop("service_or_name", "affiliations")
+        super().__init__(service_or_name=service_or_name, *args, **kwargs)
+
+    def _entry_id(self, entry):
+        """Get the id from an entry."""
+        return entry["id"]
+
+
+class AffiliationsRORTransformer(RORTransformer):
+    """Affiliations ROR Transformer."""
+
+    def __init__(
+        self, *args, vocab_schemes=None, funder_fundref_doi_prefix=None, **kwargs
+    ):
+        """Constructor."""
+        if vocab_schemes is None:
+            vocab_schemes = current_app.config.get("VOCABULARIES_AFFILIATION_SCHEMES")
+        super().__init__(
+            *args,
+            vocab_schemes=vocab_schemes,
+            funder_fundref_doi_prefix=funder_fundref_doi_prefix,
+            **kwargs
+        )
+
+
+VOCABULARIES_DATASTREAM_READERS = {}
+"""Affiliations datastream readers."""
+
+VOCABULARIES_DATASTREAM_WRITERS = {
+    "affiliations-service": AffiliationsServiceWriter,
+}
+"""Affiliations datastream writers."""
+
+VOCABULARIES_DATASTREAM_TRANSFORMERS = {
+    "ror-affiliations": AffiliationsRORTransformer,
+}
+"""Affiliations datastream transformers."""
+
+
+DATASTREAM_CONFIG = {
+    "readers": [
+        {
+            "type": "zip",
+            "args": {
+                "regex": "_schema_v2\\.json$",
+            },
+        },
+        {"type": "json"},
+    ],
+    "transformers": [
+        {
+            "type": "ror-affiliations",
+        },
+    ],
+    "writers": [
+        {
+            "type": "async",
+            "args": {
+                "writer": {
+                    "type": "affiliations-service",
+                }
+            },
+        }
+    ],
+}
+"""Data Stream configuration.
+
+An origin is required for the reader.
+"""

invenio-vocabularies-4.2.0/invenio_vocabularies/contrib/affiliations/jsonschemas/affiliations/affiliation-v1.0.0.json

@@ -0,0 +1,63 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "local://affiliations/affiliation-v1.0.0.json",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "$schema": {
+      "$ref": "local://definitions-v1.0.0.json#/$schema"
+    },
+    "tags": {
+      "$ref": "local://vocabularies/definitions-v1.0.0.json#/tags"
+    },
+    "country": {
+      "type": "string",
+      "description": "Represents a affiliation's country as a country code."
+    },
+    "country_name": {
+      "type": "string",
+      "description": "Represents a affiliation's country as a full name."
+    },
+    "location_name": {
+      "type": "string",
+      "description": "Represents a affiliation's location name (usually a city)."
+    },
+    "acronym": {
+      "type": "string"
+    },
+    "identifiers": {
+      "description": "Alternate identifiers for the record.",
+      "type": "array",
+      "items": {
+        "$ref": "local://definitions-v1.0.0.json#/identifiers_with_scheme"
+      },
+      "uniqueItems": true
+    },
+    "status": {
+        "type": "string",
+        "description": "Status of the affiliation organization."
+    },
+    "aliases": {
+      "description": "Alternate names for the affiliation.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    },
+    "types": {
+      "description": "Types of affiliation organization.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "uniqueItems": true
+    },
+    "name": {
+      "type": "string"
+    },
+    "title": {
+      "$ref": "local://vocabularies/definitions-v1.0.0.json#/title"
+    }
+  }
+}

{invenio-vocabularies-4.0.0/invenio_vocabularies/contrib/affiliations/mappings/v7 → invenio-vocabularies-4.2.0/invenio_vocabularies/contrib/affiliations/mappings/os-v1}/affiliations/affiliation-v1.0.0.json

@@ -85,6 +85,27 @@
       "title": {
         "type": "object",
         "dynamic": "true"
+      },
+      "tags": {
+        "type": "keyword"
+      },    
+      "country": {
+        "type": "text"
+      },
+      "country_name": {
+        "type": "text"
+      },
+      "location_name": {
+        "type": "text"
+      },
+      "status": {
+        "type": "keyword"
+      },
+      "aliases": {
+        "type": "text"
+      },
+      "types": {
+        "type": "keyword"
       }
     }
   }

{invenio-vocabularies-4.0.0/invenio_vocabularies/contrib/affiliations/mappings/os-v1 → invenio-vocabularies-4.2.0/invenio_vocabularies/contrib/affiliations/mappings/os-v2}/affiliations/affiliation-v1.0.0.json

@@ -85,6 +85,27 @@
       "title": {
         "type": "object",
         "dynamic": "true"
+      },
+      "tags": {
+        "type": "keyword"
+      },
+      "country": {
+        "type": "text"
+      },
+      "country_name": {
+        "type": "text"
+      },
+      "location_name": {
+        "type": "text"
+      },
+      "status": {
+        "type": "keyword"
+      },
+      "aliases": {
+        "type": "text"
+      },
+      "types": {
+        "type": "keyword"
       }
     }
   }