release: 🔖 version 0.8.0

Author: kikkomep

.github/workflows/release.yaml

@@ -1,3 +1,17 @@
+# Copyright (c) 2024-2026 CRS4
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # This workflow is triggered on push to tags and runs the following steps:
 # 1. Check and Build Distribution
 # 2. Publish to TestPyPI

.github/workflows/testing.yaml

@@ -1,3 +1,17 @@
+# Copyright (c) 2024-2026 CRS4
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 name: 🧪 CI Pipeline 1 -- Testing
 
 # Controls when the action will run. Triggers the workflow on push or pull request
@@ -22,11 +36,12 @@ env:
     TERM: xterm
     VENV_PATH: .venv
     PYTHON_VERSION: "3.11"
+    FORCE_COLOR: "1"  # Force color output in CI
 
 jobs:
-    # Verifies pep8, pyflakes and circular complexity
-    flake8:
-        name: 🚨 Lint Python Code
+    # Verifies pep8, pyflakes, circular complexity, and spelling
+    lint:
+        name: 🚨 Lint and spellcheck
         runs-on: ubuntu-latest
         steps:
             # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
@@ -38,14 +53,16 @@ jobs:
                   python-version: ${{ env.PYTHON_VERSION }}
             - name: 🔽 Install flake8
               run: pip install flake8
-            - name: ⌛ Run checks
+            - name: ⌛ Lint Python code
               run: flake8 -v rocrate_validator tests
+            - name: ⌛ Spell check code and profiles (covers Python and SHACL)
+              uses: crate-ci/[email protected]
 
     # Runs the tests
     test:
         name: ⌛ Run tests
         runs-on: ubuntu-latest
-        needs: [flake8]
+        needs: [lint]
         steps:
             - name: ⬇️ Checkout
               uses: actions/checkout@v4
@@ -65,3 +82,7 @@ jobs:
               run: poetry install --no-interaction --no-ansi
             - name: ⌛ Run tests
               run: poetry run pytest
+              env:
+                TERM: "dumb"
+                LINES: "50"
+                COLUMNS: "120"

.gitignore

@@ -1,3 +1,17 @@
+# Copyright (c) 2024-2026 CRS4
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 .DS_Store
 **/__pycache__
 **/*.pyc
@@ -13,3 +27,7 @@ docs/_build
 **/.coverage
 **/.coverage.*
 **/.report
+
+# ignore IDE files
+.vscode/
+.idea/

.gitlab-ci.yml

@@ -1,4 +1,4 @@
-# Copyright (c) 2024-2025 CRS4
+# Copyright (c) 2024-2026 CRS4
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

.readthedocs.yaml

@@ -1,3 +1,17 @@
+# Copyright (c) 2024-2026 CRS4
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 # Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 

CITATION.cff

@@ -0,0 +1,29 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using these metadata."
+title: "rocrate-validator"
+abstract: "A Python package to validate RO-Crates."
+type: software
+authors:
+  - family-names: "Piras"
+    given-names: "Marco Enrico"
+    orcid: https://orcid.org/0000-0002-5207-0030
+  - family-names: "Leo"
+    given-names: "Simone"
+    orcid: https://orcid.org/0000-0001-8271-5429
+  - family-names: "Pireddu"
+    given-names: "Luca"
+    orcid: https://orcid.org/0000-0002-4663-5613
+  - family-names: Chadwick
+    given-names: Eli
+    orcid: https://orcid.org/0000-0002-0035-6475
+  - family-names: Bauer
+    given-names: Daniel
+    orcid: https://orcid.org/0000-0001-9447-460X
+repository-code: "https://github.com/crs4/rocrate-validator"
+url: "https://github.com/crs4/rocrate-validator"
+keywords:
+  - "RO-Crate"
+  - "validation"
+  - "metadata"
+  - "FAIR"
+license: "Apache-2.0"

README.md

@@ -32,7 +32,7 @@ report positive and negative feedback. We also welcome contributions, but we sug
 
 ## Installation
 
-You can install the package using `pip` or `poetry`. The following instructions assume you have Python 3.8 or later installed.
+You can install the package using `pip` or `poetry`. The following instructions assume you have Python 3.9 or later installed.
 
 #### [Optional Step: Create a Virtual Environment](#optional-step-create-a-virtual-environment)
 

docs/0_toc.rst

@@ -26,6 +26,7 @@
     :maxdepth: 5
     :caption: Resources
 
+    12_validation_profiles
     11_writing_a_profile
     10_api
     genindex

docs/11_writing_a_profile.rst

@@ -63,11 +63,25 @@ These instructions assume you are familiar with code development using Python an
    checks to write, you can create multiple files - the validator will 
    collect them all automatically at runtime. 
 
-    * Note: some profiles split the checks into folders called ``must/``, 
+   .. note::
+
+      Some profiles split the checks into folders called ``must/``, 
       ``should/`` and ``may/`` according to the requirement severity. This 
       is not mandatory - you can also label individual checks/shapes with 
       ``sh:severity`` in the SHACL code instead.
 
+#. Optionally, associate an ontology graph with the profile by providing 
+   an ``ontology.ttl`` file alongside the SHACL files. 
+   This graph is merged into the crate's data graph at validation time, 
+   allowing you to define formal relationships and additional definitions 
+   between profile entities (e.g., using ``rdfs:subClassOf``, 
+   ``owl:equivalentClass``, etc.).
+   
+   .. warning::
+
+      Including an ontology can significantly impact validation times and 
+      overall performance, especially for large graphs. Use with caution.
+
 #. From the root folder of the repo, create a test folder for the profile 
    under 
    `tests/integration/profiles <https://github.com/crs4/rocrate-validator/tree/develop/tests/integration/profiles>`_. The name should match the folder you made earlier.
@@ -90,4 +104,6 @@ When running the validator manually, use ``--profile-identifier`` to select the
 
 The crates in ``tests/data/crates``` can be used as examples for running the validator. For example: ::
 
-    rocrate-validator validate --profile-identifier your-profile-name tests/data/crates/invalid/1_wroc_crate/no_mainentity/
+    rocrate-validator validate \
+      --profile-identifier your-profile-name \
+      tests/data/crates/invalid/1_wroc_crate/no_mainentity/

docs/12_validation_profiles.rst

@@ -0,0 +1,54 @@
+Validation Profiles
+===================
+
+The system comes with a set of **predefined validation profiles** that are loaded 
+automatically when the application starts (see `supported profiles <../#features>`_). 
+These profiles define the standard rules and checks that are applied during RO-Crate validation.
+
+Additional Profiles
+-------------------
+
+You can **extend or override** the predefined validation profiles by specifying 
+the path to additional profiles using the ``--extra-profiles-path`` option on the command line.
+
+CLI Usage
+^^^^^^^^^
+
+.. code-block:: bash
+
+    rocrate-validator validate --extra-profiles-path /path/to/additional/profiles <other_options> <path_to_rocrate>
+
+API Usage
+^^^^^^^^^^^^^
+
+.. code-block:: python
+
+    # Import the `services` and `models` module from the rocrate_validator package
+    from rocrate_validator import services, models
+
+    # Create an instance of `ValidationSettings` class to configure the validation
+    settings = services.ValidationSettings(
+        # ... value for other settings ...
+
+        # Define the path to additional validation profiles
+        extra_profiles_path="/path/to/additional/profiles"  # Path to additional validation profiles
+    )
+
+    # Call the validation service with the settings
+    result = services.validate(settings)
+
+    # process the validation result
+    ...
+
+
+Behavior
+^^^^^^^^
+
+* Profiles provided via ``--extra-profiles-path`` are **loaded in addition to** the system’s predefined profiles.  
+* If an additional profile has the **same name** as a predefined profile, the additional profile **overrides** the predefined one.  
+
+This mechanism allows you to:
+
+* **Add new custom validation profiles** to implement project-specific checks.  
+* **Modify existing profiles** without altering the system’s predefined configuration files.  
+* **Maintain a clear separation** between standard validation logic and project-specific customizations.