Merge remote-tracking branch 'upstream/master' into feature/documenta…

…tion

.editorconfig

@@ -1,9 +1,12 @@
 # -*- coding: utf-8 -*-
 #
+# This file is part of Invenio.
+#
 # Copyright (C) 2021 Graz University of Technology.
 #
-# Invenio-Records-Marc21 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-Records-Marc21 is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
 
 root = true
 

.github/workflows/tests.yml

@@ -27,7 +27,7 @@ jobs:
           python-version: [3.8, 3.9]
           requirements-level: [pypi]
           cache-service: [redis]
-          db-service: [postgresql9, postgresql12]
+          db-service: [postgresql12, postgresql13]
           mq-service: [rabbitmq, redis]
           search-service: [elasticsearch7]
 
@@ -41,10 +41,10 @@ jobs:
             db-service: postgresql
 
           include:
-          - db-service: postgresql9
+          - db-service: postgresql12
             DB_EXTRAS: "postgresql"
 
-          - db-service: postgresql12
+          - db-service: postgresql13
             DB_EXTRAS: "postgresql"
 
           - search-service: elasticsearch7
@@ -68,8 +68,10 @@ jobs:
           python-version: ${{ matrix.python-version }}
 
       - name: Generate dependencies
+        # setuptools lower verion needed due to build errors in dependencies: Issue #2769
         run: |
-          python -m pip install --upgrade pip setuptools py wheel requirements-builder
+          python -m pip install --upgrade pip py wheel requirements-builder
+          python -m pip install --upgrade setuptools==57.5.0
           requirements-builder -e "$EXTRAS" --level=${{ matrix.requirements-level }} setup.py > .${{ matrix.requirements-level }}-${{ matrix.python-version }}-requirements.txt
 
       - name: Cache pip

.gitignore

@@ -1,3 +1,13 @@
+# -*- coding: utf-8 -*-
+#
+# This file is part of Invenio.
+#
+# Copyright (C) 2020 Graz University of Technology.
+#
+# Invenio-Records-Marc21 is free software; you can redistribute it and/or
+# modify it under the terms of the MIT License; see LICENSE file for more
+# details.
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

INSTALL.rst

@@ -6,3 +6,23 @@ Invenio-Records-Marc21 is on PyPI so all you need is:
 .. code-block:: console
 
    $ pip install invenio-records-marc21
+
+
+Choose a version of elasticsearch and a DB, if you want to test the module.
+The installation [options] supported for the Marc21 module:
+
+  ``docs``
+      for documentation building dependencies;
+  ``elasticsearch7``
+      to use elasticsearch version 7 backend;    
+  ``postgresql``
+      to use PostgreSQL database backend;
+  ``tests``
+      for test dependencies.
+
+An example installation:
+
+.. code-block:: console
+    
+   pip install -e .[all,elasticsearch7,postgresql]
+

MANIFEST.in

@@ -38,5 +38,9 @@ recursive-include invenio_records_marc21 *.json
 recursive-include invenio_records_marc21 *.xml
 recursive-include invenio_records_marc21 *.py
 recursive-include invenio_records_marc21 *.csv
+recursive-include invenio_records_marc21 *.js
+recursive-include invenio_records_marc21 *.xsd
+recursive-include invenio_records_marc21 *.less
 recursive-include tests *.py
 recursive-include tests *.json
+recursive-include tests *.xml

README.rst

@@ -1,5 +1,5 @@
 ..
-    Copyright (C) 2021 Graz University of Technology.
+    Copyright (C) 2022 Graz University of Technology.
 
     Invenio-Records-Marc21 is free software; you can redistribute it and/or modify it
     under the terms of the MIT License; see LICENSE file for more details.
@@ -25,6 +25,9 @@ Marc21 datamodel
 Further documentation is available on
 https://invenio-records-marc21.readthedocs.io/
 
+Overview
+========
+
 This package serves as a MARC21 datamodel for the repository. Following features
 are already implemented:
 
@@ -66,3 +69,31 @@ are already implemented:
 Examples where this packages is already used:
 
   - <https://github.com/tu-graz-library/invenio-records-marc21>
+
+
+Development
+===========
+
+Install
+-------
+
+Choose a version of elasticsearch and a DB, then run:
+
+.. code-block:: console
+
+    pipenv run pip install -e .[all]
+    pipenv run pip install invenio-search[elasticsearch7]
+    pipenv run pip install invenio-db[postgresql,versioning]
+
+
+Service
+=========
+
+** Create Marc21 Record**
+
+Tests
+=========
+
+.. code-block:: console
+
+    pipenv run ./run-tests.sh

docs/api.rst

@@ -8,10 +8,14 @@
 
 API Docs
 ========
-
 .. automodule:: invenio_records_marc21.ext
    :members:
 
+Service API
+-----------
+.. autoclass:: invenio_records_marc21.services::Marc21RecordService
+   :members:
+
 Views
 -----
 

docs/conf.py

@@ -25,6 +25,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.coverage",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
@@ -332,8 +333,19 @@
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {
     "python": ("https://docs.python.org/", None),
-    # TODO: Configure external documentation references, eg:
-    # 'Flask-Admin': ('https://flask-admin.readthedocs.io/en/latest/', None),
+    # "invenio-celery": ("invenio-celery.readthedocs.io/en/latest/", None),
+    "flask_principal": (
+        "https://flask-principal.readthedocs.io/en/latest/",
+        None,
+    ),
+    "invenio_records_resources": (
+        "https://invenio-records-resources.readthedocs.io/en/latest/",
+        None,
+    ),
+    "invenio_rdm_records": (
+        "https://invenio-rdm-records.readthedocs.io/en/latest/",
+        None,
+    ),
 }
 
 # Autodoc configuraton.

docs/usage.rst

@@ -10,3 +10,4 @@ Usage
 =====
 
 .. automodule:: invenio_records_marc21
+