invenio-vocabularies 9.1.2__py2.py3-none-any.whl

invenio_vocabularies/contrib/awards/mappings/os-v1/awards/award-v1.0.0.json

@@ -0,0 +1,147 @@
+{
+  "mappings": {
+    "dynamic_templates": [
+      {
+        "i18n_title": {
+          "path_match": "title.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "search_as_you_type"
+          }
+        }
+      },
+      {
+        "i18n_description": {
+          "path_match": "description.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "text"
+          }
+        }
+      }
+    ],
+    "dynamic": "strict",
+    "properties": {
+      "$schema": {
+        "type": "keyword",
+        "index": "false"
+      },
+      "created": {
+        "type": "date"
+      },
+      "updated": {
+        "type": "date"
+      },
+      "indexed_at": {
+        "type": "date"
+      },
+      "uuid": {
+        "type": "keyword"
+      },
+      "version_id": {
+        "type": "integer"
+      },
+      "identifiers": {
+        "properties": {
+          "identifier": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          }
+        }
+      },
+      "id": {
+        "type": "keyword"
+      },
+      "title": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "tags": {
+        "type": "keyword"
+      },
+      "number": {
+        "type": "keyword"
+      },
+      "acronym": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "start_date": {
+        "type": "date"
+      },
+      "end_date": {
+        "type": "date"
+      },
+      "description": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "program": {
+        "type": "keyword"
+      },
+      "subjects": {
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "props": {
+            "type": "object",
+            "dynamic": "true"
+          },
+          "subject": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "identifiers": {
+            "properties": {
+              "identifier": {
+                "type": "keyword"
+              },
+              "scheme": {
+                "type": "keyword"
+              }
+            }
+          }
+        }
+      },
+      "organizations": {
+        "properties": {
+          "scheme": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "organization": {
+            "type": "keyword"
+          }
+        }
+      },
+      "funder": {
+        "type": "object",
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "name": {
+            "type": "text"
+          }
+        }
+      }
+    }
+  }
+}

invenio_vocabularies/contrib/awards/mappings/os-v2/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 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
+# details.
+
+"""Awards OpenSearch v2 mappings."""

invenio_vocabularies/contrib/awards/mappings/os-v2/awards/award-v1.0.0.json

@@ -0,0 +1,147 @@
+{
+  "mappings": {
+    "dynamic_templates": [
+      {
+        "i18n_title": {
+          "path_match": "title.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "search_as_you_type"
+          }
+        }
+      },
+      {
+        "i18n_description": {
+          "path_match": "description.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "text"
+          }
+        }
+      }
+    ],
+    "dynamic": "strict",
+    "properties": {
+      "$schema": {
+        "type": "keyword",
+        "index": "false"
+      },
+      "created": {
+        "type": "date"
+      },
+      "updated": {
+        "type": "date"
+      },
+      "indexed_at": {
+        "type": "date"
+      },
+      "uuid": {
+        "type": "keyword"
+      },
+      "version_id": {
+        "type": "integer"
+      },
+      "identifiers": {
+        "properties": {
+          "identifier": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          }
+        }
+      },
+      "id": {
+        "type": "keyword"
+      },
+      "title": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "tags": {
+        "type": "keyword"
+      },
+      "number": {
+        "type": "keyword"
+      },
+      "acronym": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "start_date": {
+        "type": "date"
+      },
+      "end_date": {
+        "type": "date"
+      },
+      "description": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "program": {
+        "type": "keyword"
+      },
+      "subjects": {
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "props": {
+            "type": "object",
+            "dynamic": "true"
+          },
+          "subject": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "identifiers": {
+            "properties": {
+              "identifier": {
+                "type": "keyword"
+              },
+              "scheme": {
+                "type": "keyword"
+              }
+            }
+          }
+        }
+      },
+      "organizations": {
+        "properties": {
+          "scheme": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "organization": {
+            "type": "keyword"
+          }
+        }
+      },
+      "funder": {
+        "type": "object",
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "name": {
+            "type": "text"
+          }
+        }
+      }
+    }
+  }
+}

invenio_vocabularies/contrib/awards/mappings/v7/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 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
+# details.
+
+"""Awards Elasticsearch v7 mappings."""

invenio_vocabularies/contrib/awards/mappings/v7/awards/award-v1.0.0.json

@@ -0,0 +1,147 @@
+{
+  "mappings": {
+    "dynamic_templates": [
+      {
+        "i18n_title": {
+          "path_match": "title.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "search_as_you_type"
+          }
+        }
+      },
+      {
+        "i18n_description": {
+          "path_match": "description.*",
+          "match_mapping_type": "string",
+          "mapping": {
+            "type": "text"
+          }
+        }
+      }
+    ],
+    "dynamic": "strict",
+    "properties": {
+      "$schema": {
+        "type": "keyword",
+        "index": "false"
+      },
+      "created": {
+        "type": "date"
+      },
+      "updated": {
+        "type": "date"
+      },
+      "indexed_at": {
+        "type": "date"
+      },
+      "uuid": {
+        "type": "keyword"
+      },
+      "version_id": {
+        "type": "integer"
+      },
+      "identifiers": {
+        "properties": {
+          "identifier": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          }
+        }
+      },
+      "id": {
+        "type": "keyword"
+      },
+      "title": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "tags": {
+        "type": "keyword"
+      },
+      "number": {
+        "type": "keyword"
+      },
+      "acronym": {
+        "type": "keyword",
+        "fields": {
+          "text": {
+            "type": "text"
+          }
+        }
+      },
+      "start_date": {
+        "type": "date"
+      },
+      "end_date": {
+        "type": "date"
+      },
+      "description": {
+        "type": "object",
+        "dynamic": "true"
+      },
+      "program": {
+        "type": "keyword"
+      },
+      "subjects": {
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "props": {
+            "type": "object",
+            "dynamic": "true"
+          },
+          "subject": {
+            "type": "keyword"
+          },
+          "scheme": {
+            "type": "keyword"
+          },
+          "identifiers": {
+            "properties": {
+              "identifier": {
+                "type": "keyword"
+              },
+              "scheme": {
+                "type": "keyword"
+              }
+            }
+          }
+        }
+      },
+      "organizations": {
+        "properties": {
+          "scheme": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "organization": {
+            "type": "keyword"
+          }
+        }
+      },
+      "funder": {
+        "type": "object",
+        "properties": {
+          "@v": {
+            "type": "keyword"
+          },
+          "id": {
+            "type": "keyword"
+          },
+          "name": {
+            "type": "text"
+          }
+        }
+      }
+    }
+  }
+}

invenio_vocabularies/contrib/awards/models.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022 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
+# details.
+
+"""Awards vocabulary models."""
+
+from .awards import record_type
+
+AwardsMetadata = record_type.model_cls

invenio_vocabularies/contrib/awards/resources.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+# Copyright (C) 2022 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
+# details.
+
+"""Award vocabulary resources."""
+
+from .awards import record_type
+
+AwardsResourceConfig = record_type.resource_config_cls
+
+AwardsResource = record_type.resource_cls

invenio_vocabularies/contrib/awards/schema.py

@@ -0,0 +1,119 @@
+# -*- coding: utf-8 -*-
+#
+# 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
+# details.
+
+"""Awards schema."""
+
+from functools import partial
+
+from invenio_i18n import lazy_gettext as _
+from marshmallow import Schema, ValidationError, fields, validate, validates_schema
+from marshmallow_utils.fields import IdentifierSet, ISODateString, SanitizedUnicode
+from marshmallow_utils.schemas import IdentifierSchema
+
+from ...services.schema import (
+    BaseVocabularySchema,
+    ContribVocabularyRelationSchema,
+    ModePIDFieldVocabularyMixin,
+    i18n_strings,
+)
+from ..funders.schema import FunderRelationSchema
+from ..subjects.schema import SubjectRelationSchema
+from .config import award_schemes
+
+
+class AwardOrganizationRelationSchema(ContribVocabularyRelationSchema):
+    """Schema to define an organization relation in an award."""
+
+    ftf_name = "organization"
+    parent_field_name = "organizations"
+    organization = SanitizedUnicode()
+    scheme = SanitizedUnicode()
+
+
+class AwardSchema(BaseVocabularySchema, ModePIDFieldVocabularyMixin):
+    """Award schema."""
+
+    identifiers = IdentifierSet(
+        fields.Nested(
+            partial(
+                IdentifierSchema,
+                allowed_schemes=award_schemes,
+                identifier_required=False,
+            )
+        )
+    )
+    number = SanitizedUnicode(
+        required=True,
+        validate=validate.Length(min=1, error=_("Number cannot be blank.")),
+    )
+    funder = fields.Nested(FunderRelationSchema)
+
+    acronym = SanitizedUnicode()
+
+    program = SanitizedUnicode()
+
+    subjects = fields.List(fields.Nested(SubjectRelationSchema))
+
+    organizations = fields.List(fields.Nested(AwardOrganizationRelationSchema))
+
+    start_date = ISODateString()
+
+    end_date = ISODateString()
+
+    id = SanitizedUnicode(
+        validate=validate.Length(min=1, error=_("PID cannot be blank."))
+    )
+
+
+class AwardRelationSchema(Schema):
+    """Award relation schema."""
+
+    id = SanitizedUnicode()
+    number = SanitizedUnicode()
+    title = i18n_strings
+    identifiers = IdentifierSet(
+        fields.Nested(
+            partial(
+                IdentifierSchema,
+                allowed_schemes=award_schemes,
+                identifier_required=False,
+            )
+        )
+    )
+    acronym = SanitizedUnicode()
+    program = SanitizedUnicode()
+
+    @validates_schema
+    def validate_data(self, data, **kwargs):
+        """Validate either id or number/title are present."""
+        id_ = data.get("id")
+        number = data.get("number")
+        title = data.get("title")
+
+        if not id_ and not (number or title):
+            raise ValidationError(
+                _("An existing id or either number or title must be present."),
+                "award",
+            )
+
+
+class FundingRelationSchema(Schema):
+    """Funding schema."""
+
+    funder = fields.Nested(FunderRelationSchema)
+    award = fields.Nested(AwardRelationSchema)
+
+    @validates_schema
+    def validate_data(self, data, **kwargs):
+        """Validate either funder or award is present."""
+        funder = data.get("funder")
+        award = data.get("award")
+        if not funder and not award:
+            raise ValidationError(
+                {"funding": _("At least award or funder should be present.")}
+            )

invenio_vocabularies/contrib/awards/serializer.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-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
+# details.
+
+"""Localization serializer for Awards."""
+
+from marshmallow import Schema, fields
+
+from invenio_vocabularies.resources import L10NString
+
+from ..subjects.schema import SubjectRelationSchema
+from .schema import AwardOrganizationRelationSchema
+
+
+class IdentifierSchema(Schema):
+    """Identifier scheme."""
+
+    identifier = fields.String(dump_only=True)
+    scheme = fields.String(dump_only=True)
+
+
+class FunderRelationSchema(Schema):
+    """Funder schema."""
+
+    name = fields.String(dump_only=True)
+    id = fields.String(dump_only=True)
+
+
+class AwardL10NItemSchema(Schema):
+    """Award serializer schema."""
+
+    id = fields.String(dump_only=True)
+    title = L10NString(data_key="title_l10n")
+    description = L10NString(data_key="description_l10n")
+    number = fields.String(dump_only=True)
+    acronym = fields.String(dump_only=True)
+    program = fields.String(dump_only=True)
+    funder = fields.Nested(FunderRelationSchema, dump_only=True)
+    subjects = fields.List(fields.Nested(SubjectRelationSchema), dump_only=True)
+    identifiers = fields.List(fields.Nested(IdentifierSchema), dump_only=True)
+    organizations = fields.List(
+        fields.Nested(AwardOrganizationRelationSchema), dump_only=True
+    )

invenio_vocabularies/contrib/awards/services.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 2022-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
+# details.
+
+"""Vocabulary awards."""
+
+from .awards import record_type
+
+AwardsServiceConfig = record_type.service_config_cls
+
+AwardsService = record_type.service_cls

invenio_vocabularies/contrib/common/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 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
+# details.
+
+"""Vocabularies common module."""

invenio_vocabularies/contrib/common/openaire/__init__.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright (C) 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
+# details.
+
+"""OpenAIRE-related module."""