Merge branch 'develop' into tiny-tweaks

Author: elichad

.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
@@ -25,9 +39,9 @@ env:
     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
@@ -39,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

.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"

docs/3_usage_api.rst

@@ -69,7 +69,7 @@ Formatting Validation Results
 Validation results can be rendered using different output formatters provided by
 the library. Two formatter types are available: *text* and *JSON*.  
 Both rely on the ``rich`` Python library and integrate with the
-``rocrate_validator.io.output.console.Console`` class, which extends
+``rocrate_validator.utils.io_helpers.output.console.Console`` class, which extends
 ``rich.console.Console`` to support custom formatter registration.
 
 To format results, create a ``Console`` instance, register one formatter,
@@ -86,8 +86,8 @@ to a file.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.text import TextOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.text import TextOutputFormatter
 
     console = Console()
     console.register_formatter(TextOutputFormatter())
@@ -114,8 +114,8 @@ programmatic processing, or integration with external tools.
 
 .. code-block:: python
 
-    from rocrate_validator.io.output.console import Console
-    from rocrate_validator.io.output.json import JSONOutputFormatter
+    from rocrate_validator.utils.io_helpers.output.console import Console
+    from rocrate_validator.utils.io_helpers.output.json import JSONOutputFormatter
 
     console = Console()
     console.register_formatter(JSONOutputFormatter())

docs/conf.py

@@ -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.